Merge pull request #56325 from myii/docs/fix-links-to-serializers

docs(serializers): fix hyperlinks to `salt.serializers`

CHANGELOG.md

@@ -6,7 +6,7 @@ This changelog follows [keepachangelog](https://keepachangelog.com/en/1.0.0/) fo
 This project versioning is _similar_ to [Semantic Versioning](https://semver.org), and is documented in [SEP 14](https://github.com/saltstack/salt-enhancement-proposals/pull/20/files).
 Versions are `MAJOR.PATCH`.
 
-### 3000.1
+## 3001 - Sodium
 
 ### Removed
 
@@ -15,7 +15,20 @@ Versions are `MAJOR.PATCH`.
 ### Changed
 
 ### Fixed
+
 - [#56237](https://github.com/saltstack/salt/pull/56237) - Fix alphabetical ordering and remove duplicates across all documentation indexes - [@myii](https://github.com/myii)
+- [#56325](https://github.com/saltstack/salt/pull/56325) - Fix hyperlinks to `salt.serializers` and other documentation issues - [@myii](https://github.com/myii)
+
+## 3000.1
+
+### Removed
+
+### Deprecated
+
+### Changed
+
+### Fixed
+
 - [#56082](https://github.com/saltstack/salt/pull/56082) - Fix saltversioninfo grain for new version
 - [#56143](https://github.com/saltstack/salt/pull/56143) - Use encoding when caching pillar data
 - [#56172](https://github.com/saltstack/salt/pull/56172) - Only change mine data if using new allow_tgt feature
@@ -46,6 +59,7 @@ Versions are `MAJOR.PATCH`.
 - [#56418](https://github.com/saltstack/salt/pull/56418) - Ensure version.py included before we install
 - [#56435](https://github.com/saltstack/salt/pull/56435) - Update mac build scripts
 
+
 ### Added
 
 ## 3000 - Neon [2020-02-10]

doc/topics/development/contributing.rst

@@ -144,7 +144,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
 
     GOOD
 
-    .. code-block:: none
+    .. code-block:: bash
 
         Fix broken things in file1 and file2
 
@@ -162,7 +162,7 @@ Fork a Repo Guide_>`_ and is well worth reading.
 
     BAD
 
-    .. code-block:: none
+    .. code-block:: bash
 
         Fixes broken things
 

doc/topics/development/conventions/documentation.rst

@@ -306,7 +306,7 @@ Documentation Changes and Fixes
 Documentation changes and fixes should be made against the earliest supported
 release branch that the update applies to. The practice of updating a release
 branch instead of making all documentation changes against Salt's main, default
-branch, ``develop``, is necessary in order for the docs to be as up-to-date as
+branch, ``master``, is necessary in order for the docs to be as up-to-date as
 possible when the docs are built.
 
 The workflow mentioned above is also in line with the recommendations outlined

doc/topics/releases/3000.rst

@@ -555,7 +555,7 @@ the ``engine_module`` parameter in the engine configuration.
           host: localhost
           port: 24224
 
-  .. code-block::
+  .. code-block:: none
 
     <source>
       @type forward

salt/modules/slsutil.py

@@ -201,8 +201,8 @@ def _get_serialize_fn(serializer, fn_name):
 
 def serialize(serializer, obj, **mod_kwargs):
     """
-    Serialize a Python object using a :py:mod:`serializer module
-    <salt.serializers>`
+    Serialize a Python object using one of the available
+    :ref:`all-salt.serializers`.
 
     CLI Example:
 
@@ -223,8 +223,8 @@ def serialize(serializer, obj, **mod_kwargs):
 
 def deserialize(serializer, stream_or_string, **mod_kwargs):
     """
-    Deserialize a Python object using a :py:mod:`serializer module
-    <salt.serializers>`
+    Deserialize a Python object using one of the available
+    :ref:`all-salt.serializers`.
 
     CLI Example:
 

salt/states/file.py

@@ -6949,8 +6949,8 @@ def serialize(
         .. versionadded:: 2015.8.0
 
     formatter
-        Write the data as this format. See the list of :py:mod:`serializer
-        modules <salt.serializers>` for supported output formats.
+        Write the data as this format. See the list of
+        :ref:`all-salt.serializers` for supported output formats.
 
     encoding
         If specified, then the specified encoding will be used. Otherwise, the