Draft
Conversation
sinapah
commented
May 7, 2026
| # TODO: To disable the title, set to an empty string. | ||
|
|
||
| html_title = project + " documentation" | ||
| html_title = project + " 3 documentation" |
Contributor
Author
There was a problem hiding this comment.
Currently, this reads "Observability 3 documentation". Maybe "Canonical observability stack 3 documentation" would be a bit better? It is, however, a long name for a title.
MichaelThamm
reviewed
May 8, 2026
Comment on lines
40
to
43
| # | ||
| # TODO: To include a version number, add it here (hardcoded or automated). | ||
| # | ||
| # TODO: To disable the title, set to an empty string. |
Contributor
There was a problem hiding this comment.
Suggested change
| # TODO: To disable the title, set to an empty string. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Issue
Note: if we like this approach, I'll feature this for track 2 as well.
Adds the trakc number to the HTML title, similar to other products such as Postgres, Charmcraft, etc.
Solution
For other products such as Charmcraft, it reads nicely to include the track number. For us, it looks a bit weird having "Observability 3 documentation"? Perhaps "Canonical observability stack 3 documentation" would be better?
Before:
After:
Checklist
Context
Testing Instructions
Upgrade Notes