@@ -19,7 +19,7 @@ Salt User Guide
19
19
20
20
If you're looking to learn about Salt, you've come to the right place.
21
21
22
- - `View the Sphinx-built documentation here <https://saltstack.gitlab .io/open/docs/ salt- user-guide >`__
22
+ - `View the Sphinx-built documentation here <https://docs.saltproject .io/salt/ user-guide/en/latest/index.html >`__
23
23
- `View the source repo here <https://gitlab.com/saltstack/open/docs/salt-user-guide >`__
24
24
25
25
About the Salt User Guide
@@ -40,18 +40,18 @@ Related links
40
40
=============
41
41
Check out the following links related to the Salt User Guide:
42
42
43
- * `Salt Project <https://github.com/saltstack/salt >`__ - The repository for the
43
+ * `Salt Project <https://github.com/saltstack/salt >`__: The repository for the
44
44
Salt Project.
45
- * `Salt Project Home Page <https://saltproject.io/ >`_ - The web portal for
45
+ * `Salt Project Home Page <https://saltproject.io/ >`__: The web portal for
46
46
Salt community events and resources.
47
- * `Contributing Guide <https://saltstack.gitlab .io/open/docs/ salt- user-guide/topics/contributing.html >`_ -
47
+ * `Contributing Guide <https://docs.saltproject .io/salt/ user-guide/en/latest/ topics/contributing.html >`__:
48
48
For information about contributing to the Salt User Guide and other Salt
49
49
documentation projects, including how to set up your environment and other
50
50
policies around submitting merge requests or issues.
51
- * `Salt Style Guide <https://saltstack.gitlab .io/open/docs/ salt- user-guide/topics/style-guide.html >`__ -
51
+ * `Salt Style Guide <https://docs.saltproject .io/salt/ user-guide/en/latest/ topics/style-guide.html >`__:
52
52
For general guidance about using Salt Project terms and other style or
53
53
formatting conventions.
54
- * `Writing Salt documentation (rST guide) <https://saltstack.gitlab .io/open/docs/ salt- user-guide/topics/writing-salt-docs.html >`_ -
54
+ * `Writing Salt documentation (rST guide) <https://docs.saltproject .io/salt/ user-guide/en/latest/ topics/writing-salt-docs.html >`__:
55
55
For conventions and guidelines about formatting reStructured Text (rST) in
56
56
Salt documentation.
57
57
@@ -61,6 +61,10 @@ Other Salt documentation
61
61
------------------------
62
62
The following documentation is part of the Salt Project documentation:
63
63
64
+ * `Salt Install Guide <https://docs.saltproject.io/salt/install-guide/en/latest/ >`__:
65
+ This guide provides instructions for installing Salt on Salt supported operating
66
+ systems. It also explains how to configure Salt, start Salt services, and verify
67
+ your installation.
64
68
* `Salt Project documentation <https://docs.saltproject.io/en/latest/contents.html >`__:
65
69
Includes the full documentation for the Salt Project.
66
70
* `Module documentation <https://docs.saltproject.io/en/latest/py-modindex.html >`__:
@@ -79,10 +83,11 @@ This repository uses the following tools:
79
83
a static site generator that converts the rST into HTML for publication on the
80
84
web.
81
85
* Sphinx applies the
82
- `SaltStack Material Theme for Sphinx <https://gitlab .com/saltstack/open/docs/sphinx-material-saltstack >`__
86
+ `Furo Theme for Sphinx <https://github .com/pradyunsg/furo >`__
83
87
to render the site.
84
- * The guide is hosted directly on GitLab using the
88
+ * The guide is also accessible directly on GitLab using the
85
89
`GitLab pages <https://docs.gitlab.com/ee/user/project/pages/ >`__ feature.
86
90
* GitLab handles the
87
91
`CI/CD pipeline <https://gitlab.com/saltstack/open/docs/salt-user-guide/-/pipelines >`__
88
92
for the project.
93
+ * Successful pipelines on the ``master `` branch get published to the ``docs.saltproject.io `` domain
0 commit comments