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

myii · 2020-03-08T09:13:43Z

What does this PR do?

While reviewing saltstack-formulas/telegraf-formula#4, found that the link to salt.serializers (serializer modules) wasn't working at:

salt.modules.slsutil.serialize

Found a couple of other places in the docs this wasn't working, either:

Tested the fix by building the docs locally. Also found a couple of further documentation issues which were resolved in the other two commits.

What issues does this PR fix or reference?

N/a.

Tests written?

N/a, docs only.

Commits signed with GPG?

Yes.

waynew · 2020-03-10T21:29:24Z

@myii Thanks for the fix! Would you also go ahead and add this to the fixed section in the CHANGELOG.md?

myii · 2020-03-11T07:53:17Z

... Would you also go ahead and add this to the fixed section in the CHANGELOG.md?

@waynew Would that be under 3000.1? Also, couldn't this end up leading to various merge conflicts across PRs as each change the same lines in the changelog?

waynew · 2020-03-11T14:49:36Z

@myii it shouldn't - we've added it to the .gitattributes file that should just merge it all. If that doesn't work we'll have to take a different approach. But also we've been lazy about asking people to update the changelog 😝

myii · 2020-03-11T15:00:19Z

@waynew OK, done. I'll do this for #56237 as well.

@type

``` ./salt/doc/topics/development/contributing.rst:142: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: Fix broken things in file1 and file2 Fixes saltstack#31337 We needed to make this change because the underlying dependency changed. Now this uses the up-to-date API. # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # On branch fix-broken-thing # Changes to be committed: # modified: path/to/file1 # modified: path/to/file2 ./salt/doc/topics/development/contributing.rst:160: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: Fixes broken things # Please enter the commit message for your changes. Lines starting # with '#' will be ignored, and an empty message aborts the commit. # On branch fix-broken-thing # Changes to be committed: # modified: path/to/file1 # modified: path/to/file2 ./salt/doc/topics/releases/3000.rst:558: WARNING: Error in "code-block" directive: 1 argument(s) required, 0 supplied. .. code-block:: <source> @type forward port 24224 </source> <match saltstack.**> @type file path /var/log/td-agent/saltstack </match> ```

waynew · 2020-03-11T15:04:22Z

CHANGELOG.md

@@ -166,6 +166,7 @@ Versions are `MAJOR.PATCH`.
 - [#55823](https://github.com/saltstack/salt/pull/55823) - Fix issue with overly long names in the LGPO module - [@twangboy](https://github.com/twangboy)
 - [#55843](https://github.com/saltstack/salt/pull/55843) - Fixed `file.mkdir` to respect `test=True` - [@mchugh19](https://github.com/mchugh19)
 - [#55845](https://github.com/saltstack/salt/pull/55845) - Fixed logging to return multiprocessing queue if it's already set - [@s0undt3ch](https://github.com/s0undt3ch)
+- [#56325](https://github.com/saltstack/salt/pull/56325) - Fix hyperlinks to `salt.serializers` and other documentation issues - [@myii](https://github.com/myii)


Oooh, I think you need to rebase - the version above is ## Unreleased (Neon). The latest master should have 3000.1, though given our current schedule this will probably actually end out in ## Unreleased - 3001 (Magnesium), which I don't think I added yet 🙃

e3216db That comment was correct - I hadn't added the Magnesium release to the top of the changelog

@waynew Done, apologies for the mix-up.

@waynew I just noticed:

### Unreleased (3000.1)

Surely that should be:

-### Unreleased (3000.1) +## Unreleased (3000.1)

🤦‍♂ doh! My bad. Yes it should. We'll probably fix that with Sodium - the changelog is important, but I wouldn't say it's critical 😝

frogunder · 2020-03-16T22:30:10Z

@myii

Seems like there is a conflict, can you take a look, please?

myii · 2020-03-16T22:45:42Z

@frogunder #56325 (comment).

@myii it shouldn't - we've added it to the .gitattributes file that should just merge it all. If that doesn't work we'll have to take a different approach. But also we've been lazy about asking people to update the changelog stuck_out_tongue_closed_eyes

@waynew Conflicting files: CHANGELOG.md! How would you like me to deal with this?

waynew · 2020-03-16T23:13:22Z

@myii I went ahead and resolved it. And fixed the ### 3000.1 -> ## 3000.1 thing 👍

myii · 2020-03-16T23:29:35Z

@myii I went ahead and resolved it. And fixed the ### 3000.1 -> ## 3000.1 thing 👍

Thanks!

Ch3LL · 2020-04-15T18:49:35Z

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
+## 3000.1


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

@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.

Ch3LL · 2020-04-16T14:11:53Z

@waynew are you good with this? Just waiting on your approval here

waynew · 2020-04-16T14:36:10Z

@Ch3LL 🚀

myii requested a review from a team as a code owner March 8, 2020 09:13

ghost requested a review from waynew March 8, 2020 09:13

waynew approved these changes Mar 10, 2020

View reviewed changes

waynew added Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation labels Mar 10, 2020

myii added 3 commits March 11, 2020 15:01

docs(serializers): fix hyperlinks to salt.serializers

7339023

docs(documentation.rst): update main branch develop => master

7ae1c2c

myii force-pushed the docs/fix-links-to-serializers branch from b1d2ea0 to ec4e332 Compare March 11, 2020 15:01

waynew suggested changes Mar 11, 2020

View reviewed changes

chore(changelog): update for current PR

019f01a

myii force-pushed the docs/fix-links-to-serializers branch from ec4e332 to 019f01a Compare March 11, 2020 15:33

myii mentioned this pull request Mar 11, 2020

docs(index.rst): fix alphabetical ordering and remove duplicates #56237

Merged

waynew previously approved these changes Mar 11, 2020

View reviewed changes

sagetherage assigned frogunder Mar 12, 2020

Merge branch 'master' into docs/fix-links-to-serializers

870f48e

frogunder added Merge Ready ZRelease-Sodium retired label and removed Bug broken, incorrect, or confusing behavior Documentation Relates to Salt documentation labels Mar 17, 2020

frogunder removed the ZRelease-Sodium retired label label Mar 19, 2020

Merge branch 'master' into docs/fix-links-to-serializers

a6ae9a8

frogunder dismissed waynew’s stale review via a6ae9a8 April 14, 2020 15:39

frogunder removed the Merge Ready label Apr 14, 2020

Frode Gundersen added 5 commits April 14, 2020 10:02

Update slsutil.py

f144c6d

Update slsutil.py

73f42e1

Update slsutil.py

9cb40f9

Update slsutil.py

7a400f3

Merge branch 'master' into docs/fix-links-to-serializers

a8368ab

frogunder added the Merge Ready label Apr 15, 2020

Ch3LL suggested changes Apr 15, 2020

View reviewed changes

Ch3LL removed the Merge Ready label Apr 15, 2020

myii and others added 2 commits April 15, 2020 20:43

Merge branch 'master' into docs/fix-links-to-serializers

80c9862

docs(changelog): move entries to Sodium

1af0a18

Ch3LL approved these changes Apr 16, 2020

View reviewed changes

waynew approved these changes Apr 16, 2020

View reviewed changes

Ch3LL merged commit 51fd70f into saltstack:master Apr 16, 2020

myii deleted the docs/fix-links-to-serializers branch April 16, 2020 14:38

sagetherage added the ZRelease-Sodium retired label label May 18, 2020

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

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

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

myii commented Mar 8, 2020 •

edited

Loading

waynew commented Mar 10, 2020

myii commented Mar 11, 2020

waynew commented Mar 11, 2020

myii commented Mar 11, 2020

waynew Mar 11, 2020

waynew Mar 11, 2020

myii Mar 11, 2020

myii Mar 11, 2020

waynew Mar 11, 2020

frogunder commented Mar 16, 2020

myii commented Mar 16, 2020

waynew commented Mar 16, 2020

myii commented Mar 16, 2020

Ch3LL Apr 15, 2020 •

edited

Loading

myii Apr 15, 2020

Ch3LL commented Apr 16, 2020

waynew commented Apr 16, 2020

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

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

Conversation

myii commented Mar 8, 2020 • edited Loading

What does this PR do?

What issues does this PR fix or reference?

Tests written?

Commits signed with GPG?

waynew commented Mar 10, 2020

myii commented Mar 11, 2020

waynew commented Mar 11, 2020

myii commented Mar 11, 2020

waynew Mar 11, 2020

Choose a reason for hiding this comment

waynew Mar 11, 2020

Choose a reason for hiding this comment

myii Mar 11, 2020

Choose a reason for hiding this comment

myii Mar 11, 2020

Choose a reason for hiding this comment

waynew Mar 11, 2020

Choose a reason for hiding this comment

frogunder commented Mar 16, 2020

myii commented Mar 16, 2020

waynew commented Mar 16, 2020

myii commented Mar 16, 2020

Ch3LL Apr 15, 2020 • edited Loading

Choose a reason for hiding this comment

myii Apr 15, 2020

Choose a reason for hiding this comment

Ch3LL commented Apr 16, 2020

waynew commented Apr 16, 2020

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

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

myii commented Mar 8, 2020 •

edited

Loading

Ch3LL Apr 15, 2020 •

edited

Loading