ansible-documentation icon indicating copy to clipboard operation
ansible-documentation copied to clipboard

bulk update urls to insert the projects subdir

Open oraNod opened this issue 2 weeks ago • 4 comments

This change modifies url references to the community package docs on docs.ansible.com to include the Read the Docs projects subdirectory.

oraNod avatar Nov 17 '25 17:11 oraNod

Doh, yeah I shouldn't have touched the porting guides. https://github.com/ansible-community/ansible-build-data/pull/627 should fix that. I'll update this.

oraNod avatar Nov 17 '25 19:11 oraNod

That PR (and #3263 / #3264) only touch the Ansible 11 and 12 porting guides.

felixfontein avatar Nov 17 '25 19:11 felixfontein

That PR (and #3263 / #3264) only touch the Ansible 11 and 12 porting guides.

Thanks @felixfontein Should we update the older porting guides manually? Or should we do that through the ansible-build-data repo?

oraNod avatar Nov 18 '25 08:11 oraNod

Good question. I probably wouldn't modify them in ansible-build-data anymore since the releases are EOL. @gotmax23 @mariolenz WDYT?

felixfontein avatar Nov 18 '25 16:11 felixfontein

Yeah, I would probably avoid touching the EOL porting guides (I consider them historical documents) but don't feel super strongly.

gotmax23 avatar Nov 19 '25 02:11 gotmax23

I wouldn't modify the porting guides in ansible-build-data for releases that are EOL. As @gotmax23 pointed out, they're kind of historical documents.

Anyway, there might be even some more outdated links. Do we really want to go hunting for them and fix them? EOL means we don't touch this stuff anymore. Outdated and even broken links included IMHO.

mariolenz avatar Nov 19 '25 15:11 mariolenz

Thanks for the opinions on the old porting guides @gotmax23 and @mariolenz We'll leave them as-is with the old urls. They're harmless anyway since we have redirects in place.

oraNod avatar Nov 19 '25 16:11 oraNod

I'm going to go ahead and merge. Let's see how we get on with the backports. I might need to do them manually and separately look at each branch but maybe this commit will backport cleanly.

Thanks for the reviews @felixfontein @gotmax23 @mariolenz

oraNod avatar Nov 19 '25 16:11 oraNod

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

❌ Failed to cleanly apply 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 on top of patchback/backports/stable-2.17/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260

Backporting merged PR #3260 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.17/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260 upstream/stable-2.17
    
  4. Now, cherry-pick PR #3260 contents into that branch:
    $ git cherry-pick -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
    If it'll yell at you with something like fatal: Commit 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
  5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #3260 as close to the original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.17/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260
    
  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.

patchback[bot] avatar Nov 19 '25 16:11 patchback[bot]

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

❌ Failed to cleanly apply 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 on top of patchback/backports/stable-2.18/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260

Backporting merged PR #3260 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.18/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260 upstream/stable-2.18
    
  4. Now, cherry-pick PR #3260 contents into that branch:
    $ git cherry-pick -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
    If it'll yell at you with something like fatal: Commit 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
  5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #3260 as close to the original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.18/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260
    
  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.

patchback[bot] avatar Nov 19 '25 16:11 patchback[bot]

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

❌ Failed to cleanly apply 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 on top of patchback/backports/stable-2.19/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260

Backporting merged PR #3260 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.19/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260 upstream/stable-2.19
    
  4. Now, cherry-pick PR #3260 contents into that branch:
    $ git cherry-pick -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
    If it'll yell at you with something like fatal: Commit 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32 is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x 1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32
    
  5. At this point, you'll probably encounter some merge conflicts. You must resolve them in to preserve the patch from PR #3260 as close to the original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-2.19/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260
    
  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.

patchback[bot] avatar Nov 19 '25 16:11 patchback[bot]

Backport to stable-2.20: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-2.20/1da1e1d77692fb71bdd4de6b22e0a3b7b8ae1e32/pr-3260

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

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

patchback[bot] avatar Nov 19 '25 16:11 patchback[bot]