10000 Update README and CONTRIBUTING with latest links · saltstack/salt-user-guide@58f3018 · GitHub
[go: up one dir, main page]

Skip to content

Commit 58f3018

Browse files
DerekDerek
authored andcommitted
Update README and CONTRIBUTING with latest links
1 parent 46ec8b1 commit 58f3018

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

CONTRIBUTING.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ This repository uses the following tools:
3737
a static site generator that converts the rST into HTML for publication on the
3838
web.
3939
* Sphinx applies the
40-
`SaltStack Material Theme for Sphinx <https://gitlab.com/saltstack/open/docs/sphinx-material-saltstack>`__
40+
`Furo Theme for Sphinx <https://github.com/pradyunsg/furo>`__
4141
to render the site.
4242
* The guide is hosted directly on GitLab using the
4343
`GitLab pages <https://docs.gitlab.com/ee/user/project/pages/>`__ feature.
@@ -47,6 +47,7 @@ This repository uses the following tools:
4747
* `EditorConfig <https://editorconfig.org/>`__ is an optional tool you can use
4848
with your preferred editor to ensure that you follow the Salt Project coding
4949
guidelines.
50+
* Successful pipelines on the ``master`` branch get published to the ``docs.saltproject.io`` domain
5051

5152

5253
Overview of how to contribute to the Salt User Guide repository

README.rst

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Salt User Guide
1919

2020
If you're looking to learn about Salt, you've come to the right place.
2121

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>`__
2323
- `View the source repo here <https://gitlab.com/saltstack/open/docs/salt-user-guide>`__
2424

2525
About the Salt User Guide
@@ -40,18 +40,18 @@ Related links
4040
=============
4141
Check out the following links related to the Salt User Guide:
4242

43-
* `Salt Project <https://github.com/saltstack/salt>`__ - The repository for the
43+
* `Salt Project <https://github.com/saltstack/salt>`__: The repository for the
4444
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
4646
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>`__:
4848
For information about contributing to the Salt User Guide and other Salt
4949
documentation projects, including how to set up your environment and other
5050
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>`__:
5252
For general guidance about using Salt Project terms and other style or
5353
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>`__:
5555
For conventions and guidelines about formatting reStructured Text (rST) in
5656
Salt documentation.
5757

@@ -61,6 +61,10 @@ Other Salt documentation
6161
------------------------
6262
The following documentation is part of the Salt Project documentation:
6363

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.
6468
* `Salt Project documentation <https://docs.saltproject.io/en/latest/contents.html>`__:
6569
Includes the full documentation for the Salt Project.
6670
* `Module documentation <https://docs.saltproject.io/en/latest/py-modindex.html>`__:
@@ -79,10 +83,11 @@ This repository uses the following tools:
7983
a static site generator that converts the rST into HTML for publication on the
8084
web.
8185
* 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>`__
8387
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
8589
`GitLab pages <https://docs.gitlab.com/ee/user/project/pages/>`__ feature.
8690
* GitLab handles the
8791
`CI/CD pipeline <https://gitlab.com/saltstack/open/docs/salt-user-guide/-/pipelines>`__
8892
for the project.
93+
* Successful pipelines on the ``master`` branch get published to the ``docs.saltproject.io`` domain

0 commit comments

Comments
 (0)
0