Consistent version in documentation URLs #819
Closed
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
ekohl
force-pushed
the
consistent-docs-version
branch
from
fa61208
to
4acf90d
Compare
|
Does this replace #818 ? |
|
I think it does. Note that the current documentation versions don't exist. https://theforeman.org/plugins/foreman_remote_execution/ only has very limited numbers. You can also choose to only document major versions in which case you can change And we may need to reflect the change in Satellite's documentation link rewriting. I didn't check yet. |
This now uses the plugin manual helper to redirect users. It consistently uses the same version as the REX documentation buttons. Ideally it would also use the plugin_manual type in documentation_url, but that doesn't work in Foreman itself.
ekohl
force-pushed
the
consistent-docs-version
branch
from
4acf90d
to
54dc5ed
Compare
|
Trivial rebase done. |
|
Closing in favor of #820. |
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.
This now uses the plugin manual helper to redirect users. It consistently uses the same version as the REX documentation buttons.
Ideally it would also use the plugin_manual type in documentation_url, but that doesn't work in Foreman itself.
I am a bit worried that it now breaks all links, since https://theforeman.org/plugins/foreman_remote_execution/ only has versions 1.7, 1.3, and some 0.x versions. Given we're already up to 9.1 this isn't going to work for anything. Because of that I think it may be safe to assume nobody clicks the documentation buttons.