Add href anchors for each sig entry in README tables #2449
Conversation
trask
requested review from
alolita,
austinlparker,
danielgblanco,
jpkrohling,
mtwo,
mx-psi,
svrnm and
tedsuo
as code owners
There was a problem hiding this comment.
I love this! I ran into this problem so often that I wanted to link to a SIG and didn't have an anchor for that, so this is great.
To put this out for discussion, although I see advantages in both solutions, we could also turn this table into a list of sections, so instead of each SIG having a row we could go
### Specification: General
* Meeting Time: ...
* Meeting Notes: ...
* Slack Channel: ...
That way we could even have a quick description above.
Although this would make the document muuuuuch longer.
| @@ -91,9 +96,9 @@ def format_chat(chat): | |||
| calendar = f"[{invites}](https://groups.google.com/a/opentelemetry.io/g/{invites})" | |||
|
|
|||
| if group_name == "Specification SIGs": | |||
| markdown_content += f"| {name} | {meeting} | {notes} | {chats} | {calendar} | {tc_sponsors} | {gc_liaison} | \n" | |||
| markdown_content += f"| <a href=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {tc_sponsors} | {gc_liaison} | \n" | |||
There was a problem hiding this comment.
| markdown_content += f"| <a href=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {tc_sponsors} | {gc_liaison} | \n" | |
| markdown_content += f"| <a id=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {tc_sponsors} | {gc_liaison} | \n" |
Based on fragment navigation, set this to id or name.
| else: | ||
| markdown_content += f"| {name} | {meeting} | {notes} | {chats} | {calendar} | {gc_liaison} |\n" | ||
| markdown_content += f"| <a href=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {gc_liaison} |\n" |
There was a problem hiding this comment.
| markdown_content += f"| <a href=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {gc_liaison} |\n" | |
| markdown_content += f"| <a id=\"{short_name}\"></a>{name} | {meeting} | {notes} | {chats} | {calendar} | {gc_liaison} |\n" |
| short_name = None | ||
| for chat in sig.get('chat', []): | ||
| if chat.get('type') == 'slack': | ||
| short_name = chat.get('name').replace('#otel-', '') |
There was a problem hiding this comment.
| short_name = chat.get('name').replace('#otel-', '') | |
| short_name = chat.get('name').replace('#', '') |
I would keep a kind of prefix for this, otherwise if we ever have a section called "Maintainers" or "Collector", etc we create a conflict. My preference would be "sig" but since we have some of them already maybe stick with otel?
Or we "urlify" the name?
As part of cleaning up meeting docs in #1809, it would be nice to be able to link directly to each SIG entry in the community readme.