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

Add preferred terms list to style guide #386

Merged
merged 7 commits into from
Sep 26, 2023
Merged

Add preferred terms list to style guide #386

merged 7 commits into from
Sep 26, 2023

Conversation

samccann
Copy link
Contributor

Fixes #152

@github-actions github-actions bot added the needs_triage Needs a first human triage before being processed. label Sep 12, 2023
oraNod
oraNod reviewed Sep 13, 2023
View reviewed changes
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated Show resolved Hide resolved
@oraNod oraNod removed the needs_triage Needs a first human triage before being processed. label Sep 14, 2023
webknjaz
webknjaz reviewed Sep 15, 2023
View reviewed changes
docs/docsite/rst/dev_guide/style_guide/preferred_terms.rst Outdated
.. glossary::

Ansible
Use on all occurrences or ``ansible`` if referring to the CLI command. Preference is to use this to refer to the Ansible community package.
Copy link
Member

Choose a reason for hiding this comment

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

The definitions under each term should have extra indentation per https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#glossary

Suggested change
Use on all occurrences or ``ansible`` if referring to the CLI command. Preference is to use this to refer to the Ansible community package.
Use on all occurrences or ``ansible`` if referring to the CLI command. Preference is to use this to refer to the Ansible community package.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

ok thanks. Frankly I was so mortified by all my spelling errors I forgot to take a closer look at how the glossary works. Thanks

Copy link
Member

Choose a reason for hiding this comment

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

I tend to use https://github.com/sphinx-contrib/spelling for detecting typos...

Copy link
Contributor

Choose a reason for hiding this comment

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

Personally I like codespell https://github.com/codespell-project/codespell

Copy link
Member

Choose a reason for hiding this comment

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

I didn't know it can check RST.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok now I have a duplicate term definition problem because we already have an actual glossary in the appendix. I'm inclined to remove the glossary from this section because it's not really defining the terms, just how to type them in documentation.

samccann and others added 5 commits September 20, 2023 10:41
@samccann
add preferred terms list to style guide
042ed25
@samccann @webknjaz @oraNod
Apply suggestions from code review
ad494f6 
Co-authored-by: Sviatoslav Sydorenko <wk.cvs.github@sydorenko.org.ua>
Co-authored-by: Don Naro <dnaro@redhat.com>
@samccann @oraNod
Apply suggestions from code review
3f186ba 
Co-authored-by: Don Naro <dnaro@redhat.com>
@samccann
fix glossary formatting
5c1f62b
@samccann
remove glossary`
fec960c
@samccann
Copy link
Contributor Author

@leogallego @Andersson007 @gotmax23 @felixfontein @oraNod -

I think I got it right finally. Please take another look at the preferred terms... thanks!

@samccann @felixfontein
Apply suggestions from code review
49cffd2 
Co-authored-by: Felix Fontein <felix@fontein.de>
@samccann samccann merged commit 20f43ca into ansible:devel Sep 26, 2023
7 checks passed
@samccann samccann deleted the preferred-terms branch September 26, 2023 19:00
@samccann samccann added backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch labels Oct 4, 2023
@patchback
Copy link

patchback bot commented Oct 4, 2023 •
edited

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/20f43cac88c222c09035f1991acf6a0de9bdea3d/pr-386

Backported as #515

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

@patchback
Copy link

patchback bot commented Oct 4, 2023 •
edited

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/20f43cac88c222c09035f1991acf6a0de9bdea3d/pr-386

Backported as #516

🤖 @patchback
I'm built with octomachinery and
my source is open — https://github.com/sanitizers/patchback-github-app.

patchback bot pushed a commit that referenced this pull request Oct 4, 2023
@samccann @patchback
Add preferred terms list to style guide (#386)
086ed34 
(cherry picked from commit 20f43ca)
@patchback patchback bot mentioned this pull request Oct 4, 2023
Merged
patchback bot pushed a commit that referenced this pull request Oct 4, 2023
@samccann @patchback
Add preferred terms list to style guide (#386)
a26688e 
(cherry picked from commit 20f43ca)
@patchback patchback bot mentioned this pull request Oct 4, 2023
Merged
samccann added a commit that referenced this pull request Oct 4, 2023
@patchback @samccann
Add preferred terms list to style guide (#386) (#516)
0a0982c 
(cherry picked from commit 20f43ca)

Co-authored-by: Sandra McCann <samccann@redhat.com>
samccann added a commit that referenced this pull request Oct 4, 2023
@patchback @samccann
Add preferred terms list to style guide (#386) (#515)
c6150f6 
(cherry picked from commit 20f43ca)

Co-authored-by: Sandra McCann <samccann@redhat.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@webknjaz webknjaz webknjaz left review comments

@oraNod oraNod oraNod left review comments

@felixfontein felixfontein felixfontein approved these changes

Assignees
No one assigned
Labels
backport-2.15 Automatically create a backport for the stable-2.15 branch backport-2.16 Automatically create a backport for the stable-2.16 branch
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update style guide with preferred terminology
4 participants
@samccann @webknjaz @felixfontein @oraNod