search

ansible / ansible-documentation

Ansible community documentation
https://docs.ansible.com/
GNU General Public License v3.0
80 stars 468 forks source link

Fix links in collection requirements #1785

Closed felixfontein closed 1 month ago

felixfontein commented 1 month ago

I noticed two links with broken markup in the collection requirements. This PR fixes the markup.

patchback[bot] commented 1 month ago

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

❌ Failed to cleanly apply bb6f114d086cb2221e4599a509193154a7165e88 on top of patchback/backports/stable-2.15/bb6f114d086cb2221e4599a509193154a7165e88/pr-1785

Backporting merged PR #1785 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/bb6f114d086cb2221e4599a509193154a7165e88/pr-1785 upstream/stable-2.15
  4. Now, cherry-pick PR #1785 contents into that branch: 
    $ git cherry-pick -x bb6f114d086cb2221e4599a509193154a7165e88

    If it'll yell at you with something like fatal: Commit bb6f114d086cb2221e4599a509193154a7165e88 is a merge but no -m option was given., add -m 1 as follows instead:

    $ git cherry-pick -m1 -x bb6f114d086cb2221e4599a509193154a7165e88
  5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #1785 as close to the original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-2.15/bb6f114d086cb2221e4599a509193154a7165e88/pr-1785
  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.

felixfontein commented 1 month ago

@oraNod thanks for reviewing!

patchback[bot] commented 1 month ago

Backport to stable-2.16: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.16/bb6f114d086cb2221e4599a509193154a7165e88/pr-1785

Backported as https://github.com/ansible/ansible-documentation/pull/1786

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

patchback[bot] commented 1 month ago

Backport to stable-2.17: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.17/bb6f114d086cb2221e4599a509193154a7165e88/pr-1785

Backported as https://github.com/ansible/ansible-documentation/pull/1787

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