Use Foreman Documentation for REX plugin#2089
Open
maximiliankolb wants to merge 1 commit intotheforeman:gh-pagesfrom
Open
Use Foreman Documentation for REX plugin#2089maximiliankolb wants to merge 1 commit intotheforeman:gh-pagesfrom
maximiliankolb wants to merge 1 commit intotheforeman:gh-pagesfrom
Conversation
c24d368 to
290571f
Compare
3 tasks
Member
|
As discussed, we have documentation linking to it today: $ rg -i 'documentation_?(url|button)'
app/views/job_invocations/welcome.html.erb
10: documentation_url('1.ForemanRemoteExecution1.3Manual', :root_url => 'https://www.theforeman.org/plugins/foreman_remote_execution/1.3/index.html#'), :rel => 'external' %></p>
app/views/job_templates/index.html.erb
5:<% title_actions(documentation_button_rex('3.1JobTemplates'),
app/helpers/remote_execution_helper.rb
58: documentation_button_rex('3.2ExecutingaJob'),
205: def documentation_button_rex(section = '')
208: documentation_button section, :root_url => url
webpack/__mocks__/foremanReact/constants.js
23: documentationUrl: `4.1.5Searching`,
webpack/react_app/components/TargetingHosts/__tests__/__snapshots__/TargetingHostsPage.test.js.snap
28: "documentationUrl": "4.1.5Searching", |
ekohl
requested changes
Jun 28, 2023
290571f to
f8e2ee7
Compare
maximiliankolb
commented
Oct 24, 2023
Contributor
Author
maximiliankolb
left a comment
There was a problem hiding this comment.
Applied all feedback and rebased to gh-pages.
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
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.
Users have complained that we still mention
--enable-foreman-proxy-plugin-remote-execution-sshinstead of--enable-foreman-proxy-plugin-remote-execution-scriptin Foreman Manual. This PR removes the content and instead refers users to docs.theforeman.org.It was wrong since Foreman 3.3.
Does it make sense to version the REX plugin at all? Or should I only make changes to "nightly"?
Please also note that I did not check every line myself; but for reference, the last contribute was from lzap in 2019; before that, the last correction was by Ewoud in 2019 as well.
See theforeman/foreman-documentation#1301 & https://community.theforeman.org/t/foreman-remote-execution-plugin-documentation/28889