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

(abc*, doc frags): style adjustments #9534

Merged

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 6, 2025

SUMMARY

Second round of doc adjustments. Output width has been slightly reduced in andebox, and a couple of other style improvements have been added (like replacing id with ID)

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

plugins/doc_fragments/clc.py
plugins/doc_fragments/ldap.py
plugins/doc_fragments/oracle.py
plugins/doc_fragments/oracle_creatable_resource.py
plugins/doc_fragments/utm.py
plugins/modules/aerospike_migrations.py
plugins/modules/airbrake_deployment.py
plugins/modules/ali_instance.py
plugins/modules/ali_instance_info.py
plugins/modules/android_sdk.py
plugins/modules/bigpanda.py
plugins/modules/btrfs_info.py
plugins/modules/cargo.py
plugins/modules/catapult.py
plugins/modules/clc_alert_policy.py
plugins/modules/clc_blueprint_package.py
plugins/modules/clc_firewall_policy.py
plugins/modules/clc_modify_server.py
plugins/modules/clc_publicip.py
plugins/modules/clc_server.py
plugins/modules/clc_server_snapshot.py
plugins/modules/composer.py
plugins/modules/consul.py
plugins/modules/consul_agent_service.py
plugins/modules/consul_binding_rule.py
plugins/modules/consul_kv.py
plugins/modules/consul_role.py
plugins/modules/consul_session.py

@ansibullbot ansibullbot added docs docs_fragments docs_fragments plugin (shared docs) module module plugins plugin (any type) labels Jan 6, 2025
@felixfontein felixfontein added check-before-release PR will be looked at again shortly before release and merged if possible. backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Jan 6, 2025
@felixfontein felixfontein merged commit aac7199 into ansible-collections:main Jan 6, 2025
129 checks passed
Copy link

patchback bot commented Jan 6, 2025

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

❌ Failed to cleanly apply aac7199 on top of patchback/backports/stable-9/aac7199087a0aa0ee19ee625e06661dbfab62fbc/pr-9534

Backporting merged PR #9534 into main

  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-collections/community.general.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-9/aac7199087a0aa0ee19ee625e06661dbfab62fbc/pr-9534 upstream/stable-9
  4. Now, cherry-pick PR (abc*, doc frags): style adjustments #9534 contents into that branch:
    $ git cherry-pick -x aac7199087a0aa0ee19ee625e06661dbfab62fbc
    If it'll yell at you with something like fatal: Commit aac7199087a0aa0ee19ee625e06661dbfab62fbc is a merge but no -m option was given., add -m 1 as follows instead:
    $ git cherry-pick -m1 -x aac7199087a0aa0ee19ee625e06661dbfab62fbc
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR (abc*, doc frags): style adjustments #9534 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub:
    $ git push origin patchback/backports/stable-9/aac7199087a0aa0ee19ee625e06661dbfab62fbc/pr-9534
  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 felixfontein removed the check-before-release PR will be looked at again shortly before release and merged if possible. label Jan 6, 2025
Copy link

patchback bot commented Jan 6, 2025

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/aac7199087a0aa0ee19ee625e06661dbfab62fbc/pr-9534

Backported as #9541

🤖 @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 Jan 6, 2025
felixfontein pushed a commit that referenced this pull request Jan 6, 2025
…stments (#9541)

(abc*, doc frags): style adjustments (#9534)

(cherry picked from commit aac7199)

Co-authored-by: Alexei Znamensky <[email protected]>
@russoz russoz deleted the abc-docfrags-doc-style branch January 6, 2025 21:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch docs_fragments docs_fragments plugin (shared docs) docs module module plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants