-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reorganize demo feature documentation #3714
Conversation
flands
commented
Dec 28, 2023
- Create a nested section called features
- Organize feature index page
- Add feature flags under features subsection
- Add signal coverage under features subsection
4fdbcc2
to
13f501a
Compare
- Create a nested section called features - Organize feature index page - Add feature flags under features subsection - Add signal coverage under features subsection
13f501a
to
e48ff85
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Content looks good overall. Could you run npm run fix
to address formatting and stuff? Thanks!
OK, I think I fixed the links - at least they appear to work with |
Hmm, seems I still get these errors with
|
Yes, me too, and this appears to be because hugo.yaml has |
Ergh, failed twice to push changes to your branch due to git permissions -- here's a patch file of the changes you need to make this work. |
I like some of where this is going, but I see it adding even more confusion. The new section includes Telemetry coverage and Feature Flags. I don't believe they shouldn't be grouped. Should the new section be called "Telemetry Features" instead, and Feature Flags be moved back up? Also, I would like to see "Manual Span Attributes" pulled into this section. Thinking into the future, we currently have a gap with manual metrics needing to be documented, and this section would be a great spot to add them. |
Thanks and yeah, I feared this was the answer - I'll file a bug about aliases not working properly. I'm not sure fixing all links is scalable long-term. |
@puckpuck any further thoughts on this PR? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good.
@@ -1,6 +1,6 @@ | |||
--- | |||
title: Feature Flags | |||
aliases: [feature_flags] | |||
aliases: [feature_flags, ../feature_flags/] |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What was the intent here? This added alias effectively pushes a page alias outside of the Demo section, which we don't want IMHO.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's track this via:
Btw, thanks for the PR @flands, this slight reorg is an improvement IMHO! 👍🏻 |