From d95c9740e7a3b13fc0ca3d7039bf9aa43b9d0299 Mon Sep 17 00:00:00 2001 From: Ewoud Kohl van Wijngaarden Date: Wed, 14 Feb 2024 14:45:19 +0100 Subject: [PATCH] Rewrite the Salt plugin page to include all content It's suprising to have the 14.0 documentation have the general information. This makes the landing page contain all the information and redirects the Salt 14.0 manual to the index page. It also fixes some links to reflect some moves. --- _config.yml | 1 + plugins/foreman_salt/14.0/index.html | 4 ++++ plugins/foreman_salt/14.0/index.md | 30 -------------------------- plugins/foreman_salt/index.md | 32 +++++++++++++++++++++++----- 4 files changed, 32 insertions(+), 35 deletions(-) create mode 100644 plugins/foreman_salt/14.0/index.html delete mode 100644 plugins/foreman_salt/14.0/index.md diff --git a/_config.yml b/_config.yml index 6a03cb4934..6b4a9c2c37 100644 --- a/_config.yml +++ b/_config.yml @@ -81,6 +81,7 @@ plugins: - jekyll-feed - jekyll-gist - jekyll-paginate + - jekyll-redirect-from foreman_versions: - nightly diff --git a/plugins/foreman_salt/14.0/index.html b/plugins/foreman_salt/14.0/index.html new file mode 100644 index 0000000000..777ae71c71 --- /dev/null +++ b/plugins/foreman_salt/14.0/index.html @@ -0,0 +1,4 @@ +--- +title: Foreman Salt 14.0 Manual +redirect_to: /plugins/foreman_salt +--- diff --git a/plugins/foreman_salt/14.0/index.md b/plugins/foreman_salt/14.0/index.md deleted file mode 100644 index 7788bf41ac..0000000000 --- a/plugins/foreman_salt/14.0/index.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: plugin -title: Foreman Salt 14.0 Manual -version: 14.0 ---- - -# 1 {{ page.title }} - -Salt support in Foreman is implemented through two plugins: `smart_proxy_salt` and `foreman_salt`. -These plugins enable Foreman to manage Salt Minions, including provisioning, Salt Keys, Salt States, Salt Pillars, and Salt Grains, as well as providing advanced reporting features. -You can schedule Salt jobs and run them recurringly. - -# 2 Documentation - -[Using Salt for Configuration Management](https://docs.theforeman.org/nightly/Managing_Hosts/index-foreman-el.html#Using_Salt_for_Configuration_Management_managing-hosts) - -# 3 Troubleshooting the Salt Plugin - -If you find a bug, please file it in [Redmine](https://projects.theforeman.org/projects/salt/issues/new). -You can also find us on libera.chat on `#theforeman`. -For more information, see [logging and reporting problems](https://docs.theforeman.org/nightly/Administering_Red_Hat_Satellite/index-foreman-el.html#Logging_and_Reporting_Problems_admin). - -# 4 Contributing to the Salt Plugin - -Follow the [same process as Foreman](/contribute.html) for contributing. - -You can find the source code on github.com for [foreman_salt](https://github.com/theforeman/foreman_salt), [smart_proxy_salt](https://github.com/theforeman/smart_proxy_salt), and [hammer_cli_foreman_salt](https://github.com/theforeman/hammer_cli_foreman_salt). - -You can help us to translate Foreman, the Salt Plugin, and other Foreman Plugins. -See [Translation guide](/contribute.html#Translations). diff --git a/plugins/foreman_salt/index.md b/plugins/foreman_salt/index.md index 0177a5f5e5..cdaf10447d 100644 --- a/plugins/foreman_salt/index.md +++ b/plugins/foreman_salt/index.md @@ -1,18 +1,40 @@ --- layout: plugin_index title: Foreman Salt documentation -versions: [14.0, 13.0, 12.0, 11.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.1, 2.0] +versions: [13.0, 12.0, 11.0, 7.0, 6.0, 5.0, 4.0, 3.0, 2.1, 2.0] --- -# Foreman Salt manuals ------------------------------ +# Foreman Salt -Documentation: [Using Salt for Configuration Management](https://docs.theforeman.org/nightly/Managing_Hosts/index-foreman-el.html#Using_Salt_for_Configuration_Management_managing-hosts) +Salt support in Foreman is implemented through two server side plugins: [foreman_salt](https://github.com/theforeman/foreman_salt) and [smart_proxy_salt](https://github.com/theforeman/smart_proxy_salt). +There is also a Hammer plugin [hammer_cli_foreman_salt](https://github.com/theforeman/hammer_cli_foreman_salt). +These plugins enable Foreman to manage Salt Minions, including provisioning, Salt Keys, Salt States, Salt Pillars, and Salt Grains, as well as providing advanced reporting features. +You can schedule Salt jobs and run them recurringly. + +For documentation, see [Using Salt for Configuration Management](https://docs.theforeman.org/nightly/Managing_Hosts/index-foreman-el.html#Using_Salt_for_Configuration_Management_managing-hosts) + +## Troubleshooting the Salt Plugin + +If you find a bug, please file it in [Redmine](https://projects.theforeman.org/projects/salt/issues/new). +For general support information, see [here]({{site.baseurl}}support.html). +For more information, see [logging and reporting problems](https://docs.theforeman.org/nightly/Administering_Project/index-foreman-el.html#Logging_and_Reporting_Problems_admin) + +## Contributing to the Salt Plugin + +Follow the [same process as Foreman]({{site.baseurl}}contribute.html) for contributing. + +You can find the source code on GitHub for [foreman_salt](https://github.com/theforeman/foreman_salt), [smart_proxy_salt](https://github.com/theforeman/smart_proxy_salt), and [hammer_cli_foreman_salt](https://github.com/theforeman/hammer_cli_foreman_salt). + +You can help us to translate Foreman, the Salt Plugin, and other Foreman Plugins. +See [Translation guide]({{site.baseurl}}contribute.html#Translations). + + +## Legacy version documentation
{% for version in page.versions %}
- +

{{ version }}