docs: use our docs url for the ogp:url properties Sphinx generates #1411
Conversation
This file contains 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
dimaqq
approved these changes
Oct 7, 2024
tonyandrewmeyer
pushed a commit
to tonyandrewmeyer/operator
that referenced
this pull request
Oct 9, 2024
…anonical#1411) Currently we use the Open Graph configuration from the canonical-starter-pack without any modifications, but we should use the hosting url for our docs instead of theirs. The Open Graph configuration is used by Sphinx to generate the Open Graph Protocol (ogp) properties in our docs pages. This information is used when generating link previews, for example when linking to our docs in Mattermost messages. In practice these `ogp:url`s seem to be ignored in link previews, but let's fix them anyway since it's simple.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Currently we use the Open Graph configuration from the canonical-starter-pack without any modifications, but we should use the hosting url for our docs instead of theirs.
The Open Graph configuration is used by Sphinx to generate the Open Graph Protocol (ogp) properties in our docs pages. This information is used when generating link previews, for example when linking to our docs in Mattermost messages:
The
ogp:urlproperties are incorrect, e.g.In practice these urls seem to be ignored in link previews, but let's fix them anyway since it's simple.