Skip to content

Commit

Permalink
Rewrite the Salt plugin page to include all content
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
ekohl committed Feb 19, 2024
1 parent 2cfa3d6 commit d95c974
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 35 deletions.
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ plugins:
- jekyll-feed
- jekyll-gist
- jekyll-paginate
- jekyll-redirect-from

foreman_versions:
- nightly
Expand Down
4 changes: 4 additions & 0 deletions plugins/foreman_salt/14.0/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Foreman Salt 14.0 Manual
redirect_to: /plugins/foreman_salt
---
30 changes: 0 additions & 30 deletions plugins/foreman_salt/14.0/index.md

This file was deleted.

32 changes: 27 additions & 5 deletions plugins/foreman_salt/index.md
Original file line number Diff line number Diff line change
@@ -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

<div class='row plugin-manual'>
{% for version in page.versions %}
<div class='col-md-4 center'>
<a href="plugins/foreman_salt/{{ version }}/index.html" class="btn-doc btn">
<a href="{{site.baseurl}}plugins/foreman_salt/{{ version }}/index.html" class="btn-doc btn">
<i class="fa fa-newspaper-o"></i>
<p id='manual'>{{ version }}</p>
</a>
Expand Down

0 comments on commit d95c974

Please sign in to comment.