docs: add note on versions to install guide#1439
Merged
edibotopic merged 1 commit intomainfrom Apr 15, 2026
Merged
Conversation
denisonbarbosa
approved these changes
Apr 14, 2026
Member
denisonbarbosa
left a comment
denisonbarbosa
left a comment
There was a problem hiding this comment.
That's a nice addition. Is it worth reiterating here that switching to the edge version comes with risks (even though we talk about that in the following section)?
Contributor
Author
Good question @denisonbarbosa . I think it's OK to not warn here, because we are not actually instructing people how to do switch on this page. It's sufficient that the page where the instructions are given include the warning, and that both pages emphasize stable for production. |
Users may want to use the edge version. Users may also be on the edge docs and expect to see guidance on edge. For now, the most immediate solution is to link to the appropriate documentation. The purpose of the edge docs is not necessarily to promote the edge version or to only offer guidance on the edge version. It also allows us to document the latest features. For now, there is no harm in defaulting to stable for the install guide, even in the edge docs. Reader of the stable docs may also benefit from increased awareness about switching versions (for testing features, debugging, etc.).
edibotopic
force-pushed
the
docs-link-install-to-version-change
branch
from
13c6d12 to
4b4b009
Compare
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.
The installation guide currently only covers installing stable versions of the daemon and broker.
But users may be interested in the edge version, or may be on the edge docs and expect to see guidance on edge versions.
For now, the most immediate solution to this problem is to provide a prominent link to the documentation on changing versions.
The purpose of the edge docs is not strictly to promote the edge version or to only offer guidance on the edge version. It primarily allows us to document the latest features available on edge. For now, there is no harm in defaulting to stable for the install guide, even in the edge docs, as long as we clearly link to the relevant documentation. If anything, it reinforces the recommendation for use of stable in production.
Readers of the stable docs may also benefit from knowing about switching versions (for testing features, debugging, etc.), so the link helps both groups.
Alternative solutions, such as conditional rendering of docs in stable | edge, may be investigated in future, but could introduce complexity.
Closes #1341
UDENG-9457