Skip to content

Conversation

@oraNod
Copy link
Contributor

@oraNod oraNod commented Nov 17, 2025

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

@oraNod oraNod requested a review from a team as a code owner November 17, 2025 17:59
@ansible-documentation-bot ansible-documentation-bot bot added the sc_approval This PR requires approval from the Ansible Community Steering Committee label Nov 17, 2025
@oraNod oraNod requested review from gundalow and samccann November 17, 2025 17:59
@oraNod
Copy link
Contributor Author

oraNod commented Nov 17, 2025

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

This change modifies url references to the community package docs on
docs.ansible.com to include the Read the Docs projects subdirectory.
@felixfontein
Copy link
Collaborator

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

@oraNod
Copy link
Contributor Author

oraNod commented Nov 18, 2025

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?

@felixfontein
Copy link
Collaborator

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

@gotmax23
Copy link
Collaborator

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

@mariolenz
Copy link
Contributor

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.

@oraNod
Copy link
Contributor Author

oraNod commented Nov 19, 2025

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 oraNod added backport-2.18 Automatically create a backport for the stable-2.18 branch backport-2.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch backport-2.17 Automatically create a backport for the stable-2.17 branch labels Nov 19, 2025
@oraNod
Copy link
Contributor Author

oraNod commented Nov 19, 2025

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 oraNod merged commit 1da1e1d into ansible:devel Nov 19, 2025
12 checks passed
@patchback
Copy link

patchback bot commented Nov 19, 2025

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

❌ Failed to cleanly apply 1da1e1d 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 bulk update urls to insert the projects subdir #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 bulk update urls to insert the projects subdir #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
Copy link

patchback bot commented Nov 19, 2025

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

❌ Failed to cleanly apply 1da1e1d 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 bulk update urls to insert the projects subdir #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 bulk update urls to insert the projects subdir #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
Copy link

patchback bot commented Nov 19, 2025

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

❌ Failed to cleanly apply 1da1e1d 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 bulk update urls to insert the projects subdir #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 bulk update urls to insert the projects subdir #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
Copy link

patchback bot commented Nov 19, 2025

Backport to stable-2.20: 💚 backport PR created

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

Backported as #3275

🤖 @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 Nov 19, 2025
This change modifies url references to the community package docs on
docs.ansible.com to include the Read the Docs projects subdirectory.

(cherry picked from commit 1da1e1d)
oraNod added a commit that referenced this pull request Nov 19, 2025
This change modifies url references to the community package docs on
docs.ansible.com to include the Read the Docs projects subdirectory.

(cherry picked from commit 1da1e1d)

Co-authored-by: Don Naro <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.19 Automatically create a backport for the stable-2.19 branch backport-2.20 Automatically create a backport for the stable-2.20 branch sc_approval This PR requires approval from the Ansible Community Steering Committee

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants