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 typos in style guide #1368

Merged
merged 2 commits into from
May 1, 2024
Merged

Fix typos in style guide #1368

merged 2 commits into from
May 1, 2024

Conversation

xszabo3
Copy link
Contributor

@xszabo3 xszabo3 commented Apr 29, 2024

Adds an escaped ` character before the external link and removes doubled colons.
Discussed in #1302 (comment) , and #1368 (comment)

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

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

@oraNod oraNod 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 MUNI tech writers backport-2.17 Automatically create a backport for the stable-2.17 branch labels Apr 30, 2024
@xszabo3 xszabo3 changed the title Fix external link typo in style guide Fix typos in style guide May 1, 2024
@samccann samccann merged commit 186be84 into ansible:devel May 1, 2024
8 checks passed
Copy link

patchback bot commented May 1, 2024

Backport to stable-2.15: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 186be84 on top of patchback/backports/stable-2.15/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

Backporting merged PR #1368 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.15/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368 upstream/stable-2.15
  4. Now, cherry-pick PR Fix typos in style guide #1368 contents into that branch:
    $ git cherry-pick -x 186be843998a0d3436671bff7e1867edaefc5c0f
    If it'll yell at you with something like fatal: Commit 186be843998a0d3436671bff7e1867edaefc5c0f is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 186be843998a0d3436671bff7e1867edaefc5c0f
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix typos in style guide #1368 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.15/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

@samccann
Copy link
Contributor

samccann commented May 1, 2024

Thanks @xszabo3 for fixing both items in this PR!

Copy link

patchback bot commented May 1, 2024

Backport to stable-2.16: 💔 cherry-picking failed — conflicts found

❌ Failed to cleanly apply 186be84 on top of patchback/backports/stable-2.16/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

Backporting merged PR #1368 into devel

  1. Ensure you have a local repo clone of your fork. Unless you cloned it
    from the upstream, this would be your origin remote.
  2. Make sure you have an upstream repo added as a remote too. In these
    instructions you'll refer to it by the name upstream. If you don't
    have it, here's how you can add it:
    $ git remote add upstream https://github.com/ansible/ansible-documentation.git
  3. Ensure you have the latest copy of upstream and prepare a branch
    that will hold the backported code:
    $ git fetch upstream
    $ git checkout -b patchback/backports/stable-2.16/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368 upstream/stable-2.16
  4. Now, cherry-pick PR Fix typos in style guide #1368 contents into that branch:
    $ git cherry-pick -x 186be843998a0d3436671bff7e1867edaefc5c0f
    If it'll yell at you with something like fatal: Commit 186be843998a0d3436671bff7e1867edaefc5c0f is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 186be843998a0d3436671bff7e1867edaefc5c0f
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Fix typos in style guide #1368 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.16/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368
  7. Create a PR, ensure that the CI is green. If it's not — update it so that
    the tests and any other checks pass. This is it!
    Now relax and wait for the maintainers to process your pull request
    when they have some cycles to do reviews. Don't worry — they'll tell you if
    any improvements are necessary when the time comes!

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

Copy link

patchback bot commented May 1, 2024

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

Backported as #1384

🤖 @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 May 1, 2024
* doc: fix external link typo in style guide

* doc: remove extra colons from style guide

(cherry picked from commit 186be84)
@xszabo3
Copy link
Contributor Author

xszabo3 commented May 1, 2024

Created a PR for both backports (#1385 and #1386), I hope they are correct...

oraNod added a commit that referenced this pull request May 2, 2024
…/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

[PR #1368/186be843 backport][stable-2.17] Fix typos in style guide
oraNod added a commit that referenced this pull request May 2, 2024
…/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

Fix typos in style guide (#1368) [stable-2.16]
oraNod added a commit that referenced this pull request May 2, 2024
…/186be843998a0d3436671bff7e1867edaefc5c0f/pr-1368

Fix typos in style guide (#1368) [stable-2.15]
@oraNod
Copy link
Contributor

oraNod commented May 2, 2024

@xszabo3 Thanks for the fix and for the backports!

@xszabo3 xszabo3 deleted the style_guide_typo branch May 2, 2024 09:16
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 MUNI tech writers 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