Shorten foreman manual #2076
Shorten foreman manual #2076
Conversation
| As well as all users who helped test releases, report bugs and provide feedback on the project. | ||
| * [Foreman {{page.version}} on EL](https://docs.theforeman.org/{{page.version}}/Release_Notes/index-foreman-el.html) | ||
| * [Foreman {{page.version}} on Debian/Ubuntu](https://docs.theforeman.org/{{page.version}}/Release_Notes/index-foreman-deb.html) | ||
| * [Foreman {{page.version}} with Katello Release Notes](https://docs.theforeman.org/{{page.version}}/Release_Notes/index-katello.html) |
There was a problem hiding this comment.
I'm a bit unsure about this: we don't really have anything Katello in this manual.
| ### 4.2.1 Environments | ||
| {%include manuals/{{ page.version }}/4.2.1_puppet_envs.md %} | ||
| ### 4.2.2 Classes | ||
| {%include manuals/{{ page.version }}/4.2.2_puppet_classes.md %} | ||
| ### 4.2.3 Parameters | ||
| {%include manuals/{{ page.version }}/4.2.3_puppet_params.md %} | ||
| ### 4.2.4 Parameterized Classes | ||
| {%include manuals/{{ page.version }}/4.2.4_param_classes.md %} | ||
| ### 4.2.5 Smart Matchers | ||
| {%include manuals/{{ page.version }}/4.2.5_matchers.md %} |
There was a problem hiding this comment.
These anchors are linked from within the foreman_puppet plugin:
$ rg '4\.2\.' app/ webpack/
app/views/foreman_puppet/puppetclasses/_form.html.erb
38: <%= documentation_button('4.2.5ParameterizedClasses') %>
app/views/foreman_puppet/puppetclasses/index.html.erb
4: documentation_button('4.2.2Classes') %>
app/views/foreman_puppet/puppetclass_lookup_keys/welcome.html.erb
10: :documentation => { :url => documentation_url("4.2.5ParameterizedClasses") },
app/views/foreman_puppet/puppetclass_lookup_keys/index.html.erb
2:<% title_actions documentation_button('4.2.5ParameterizedClasses') %>
webpack/src/Components/Environments/Welcome.js
15: '4.2.2Classes'
23: documentation={{ url: getManualURL('4.2.1Environments') }}So please keep all chapters until there are replacements.
And now that I see this, it looks like there's also a bug where 4.2.5 became 4.2.4. That was a while back, so I wonder how many people actually use the functionality.
There was a problem hiding this comment.
Maybe I should rather open a PR against foreman/foreman_puppet nightly to accompany this?
There was a problem hiding this comment.
Today there is no way to link to the new docs, that's what https://community.theforeman.org/t/making-docs-theforeman-org-the-primary-documentation-source/32657#moving-over-foreman-itself-4 is about: introducing the API
I've made two commits to shorten the Foreman Manual in favor of docs.theforeman.org.
I am really unsure if this is in the spirit of https://community.theforeman.org/t/making-docs-theforeman-org-the-primary-documentation-source/32657.
cc @adamlazik1