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.

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

fix: correct typos #2062

Merged
merged 1 commit into from
Oct 25, 2024
Merged

fix: correct typos #2062

merged 1 commit into from
Oct 25, 2024

Conversation

hsiangjenli
Copy link
Contributor

@hsiangjenli hsiangjenli commented Oct 25, 2024

  • Removing the extra backtick

@ansible-documentation-bot ansible-documentation-bot bot added the new_contributor This PR is the first contribution by a new community member. label Oct 25, 2024
@ansible-documentation-bot
Copy link
Contributor

Thanks for your Ansible docs contribution! We talk about Ansible documentation on Matrix at #docs:ansible.im if you ever want to join us and chat about the docs! We meet on Matrix every Tuesday. See the Ansible calendar for meeting details. We welcome additions to our weekly agenda items too. You can add the dawgs-meeting tag to a forum topic to bring it up at the next meeting.

@ansible-documentation-bot
Copy link
Contributor

Thanks for your contribution, @hsiangjenli! Please make sure that your pull request includes sufficient and meaningful details in the description.
PR descriptions provide important context and allow other developers and our future selves to understand a change's rationale and what it actually fixes or accomplishes.

@ansible-documentation-bot
Copy link
Contributor

The following files are automatically generated and should not be modified outside of the Ansible release process:

  • docs/docsite/rst/porting_guides/porting_guide_5.rst

Please double-check your changes.

@oraNod oraNod added backport-2.16 Automatically create a backport for the stable-2.16 branch backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.15 Automatically create a backport for the stable-2.15 branch and removed 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 backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch labels Oct 25, 2024
@oraNod
Copy link
Contributor

oraNod commented Oct 25, 2024

hey @hsiangjenli thanks very much for the fix! unfortunately, as pointed out in another comment the porting guides should not be edited directly. I'll poke around and see if I can find the correct source file for you. @samccann might also know where that is.

@oraNod
Copy link
Contributor

oraNod commented Oct 25, 2024

@hsiangjenli Found it. The change should go into this file on the stable-2.12 branch in the ansible/ansible repository: https://github.com/ansible/ansible/blob/c51437ee8c11d94b3fd36e9a91bbc8182688577f/docs/docsite/rst/porting_guides/porting_guide_core_2.12.rst?plain=1#L106

@samccann
Copy link
Contributor

Normally, @oraNod is correct that we have to find the source of the error and fix it there. This is necessary because, for active releases, the porting guide is regenerated from changelog fragments for every minor update. So if we just fixed it here, it would get overwritten (and back to the same errors) on the next release.

In this case though, both files are from EOL'd releases, which means we'll never regenerate those porting guides. So we can fix it in a PR like this one!

@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 backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch labels Oct 25, 2024
@samccann samccann merged commit a662334 into ansible:devel Oct 25, 2024
11 checks passed
Copy link

patchback bot commented Oct 25, 2024

Backport to stable-2.15: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.15/a66233489a1f7be8c991532b9083f92edf235eec/pr-2062

Backported as #2068

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

@samccann
Copy link
Contributor

Thanks @hsiangjenli for the Ansible docs fix and welcome to the Ansible project!

patchback bot pushed a commit that referenced this pull request Oct 25, 2024
(cherry picked from commit a662334)
Copy link

patchback bot commented Oct 25, 2024

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/a66233489a1f7be8c991532b9083f92edf235eec/pr-2062

Backported as #2069

🤖 @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 25, 2024
(cherry picked from commit a662334)
Copy link

patchback bot commented Oct 25, 2024

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/a66233489a1f7be8c991532b9083f92edf235eec/pr-2062

Backported as #2070

🤖 @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 25, 2024
(cherry picked from commit a662334)
Copy link

patchback bot commented Oct 25, 2024

Backport to stable-2.18: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.18/a66233489a1f7be8c991532b9083f92edf235eec/pr-2062

Backported as #2071

🤖 @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 25, 2024
(cherry picked from commit a662334)
samccann pushed a commit that referenced this pull request Oct 29, 2024
(cherry picked from commit a662334)

Co-authored-by: Hsiang-Jen Li <71996166+hsiangjenli@users.noreply.github.com>
samccann pushed a commit that referenced this pull request Oct 29, 2024
(cherry picked from commit a662334)

Co-authored-by: Hsiang-Jen Li <71996166+hsiangjenli@users.noreply.github.com>
samccann pushed a commit that referenced this pull request Oct 29, 2024
(cherry picked from commit a662334)

Co-authored-by: Hsiang-Jen Li <71996166+hsiangjenli@users.noreply.github.com>
samccann pushed a commit that referenced this pull request Oct 29, 2024
(cherry picked from commit a662334)

Co-authored-by: Hsiang-Jen Li <71996166+hsiangjenli@users.noreply.github.com>
oraNod pushed a commit that referenced this pull request Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
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 backport-2.17 Automatically create a backport for the stable-2.17 branch backport-2.18 Automatically create a backport for the stable-2.18 branch new_contributor This PR is the first contribution by a new community member.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants