Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs(serializers): fix hyperlinks to salt.serializers #56325

Merged
merged 13 commits into from
Apr 16, 2020
Merged

docs(serializers): fix hyperlinks to salt.serializers #56325

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
7339023
docs(serializers): fix hyperlinks to `salt.serializers`
myii Mar 8, 2020
7ae1c2c
docs(documentation.rst): update main branch `develop` => `master`
myii Mar 8, 2020
fe8d084
docs(code-block): fix warnings generated during `make html`
myii Mar 8, 2020
019f01a
chore(changelog): update for current PR
myii Mar 11, 2020
870f48e
Merge branch 'master' into docs/fix-links-to-serializers
waynew Mar 16, 2020
a6ae9a8
Merge branch 'master' into docs/fix-links-to-serializers
Apr 14, 2020
f144c6d
Update slsutil.py
Apr 14, 2020
73f42e1
Update slsutil.py
Apr 14, 2020
9cb40f9
Update slsutil.py
Apr 14, 2020
7a400f3
Update slsutil.py
Apr 14, 2020
a8368ab
Merge branch 'master' into docs/fix-links-to-serializers
Apr 14, 2020
80c9862
Merge branch 'master' into docs/fix-links-to-serializers
myii Apr 15, 2020
1af0a18
docs(changelog): move entries to `Sodium`
myii Apr 15, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
## 3000.1
Copy link
Contributor

@Ch3LL Ch3LL Apr 15, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We already released 3000.1 so this would make it into Sodium (3001)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Ch3LL Done, I had to prepare the section for 3001 as well. I took the liberty to move my other entry to 3001 (#56237), since that was merged after the release of 3000.1 as well.


### Removed

Expand All @@ -15,6 +15,8 @@ Versions are `MAJOR.PATCH`.
### Changed

### Fixed

- [#56325](https://github.com/saltstack/salt/pull/56325) - Fix hyperlinks to `salt.serializers` and other documentation issues - [@myii](https://github.com/myii)
- [#56237](https://github.com/saltstack/salt/pull/56237) - Fix alphabetical ordering and remove duplicates across all documentation indexes - [@myii](https://github.com/myii)
- [#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
Expand Down Expand Up @@ -46,6 +48,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]
Expand Down
4 changes: 2 additions & 2 deletions doc/topics/development/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,7 @@ Fork a Repo Guide_>`_ and is well worth reading.

GOOD

.. code-block:: none
.. code-block:: bash

Fix broken things in file1 and file2

Expand All @@ -157,7 +157,7 @@ Fork a Repo Guide_>`_ and is well worth reading.

BAD

.. code-block:: none
.. code-block:: bash

Fixes broken things

Expand Down
2 changes: 1 addition & 1 deletion doc/topics/development/conventions/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion doc/topics/releases/3000.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -555,7 +555,7 @@ the ``engine_module`` parameter in the engine configuration.
host: localhost
port: 24224

.. code-block::
.. code-block:: none

<source>
@type forward
Expand Down
8 changes: 4 additions & 4 deletions salt/modules/slsutil.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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:

Expand Down
4 changes: 2 additions & 2 deletions salt/states/file.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down