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

o*: style adjustments #9526

Merged
merged 6 commits into from
Jan 12, 2025

Conversation

russoz
Copy link
Collaborator

@russoz russoz commented Jan 4, 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/modules/ocapi_command.py
plugins/modules/ocapi_info.py
plugins/modules/oci_vcn.py
plugins/modules/office_365_connector_card.py
plugins/modules/ohai.py
plugins/modules/one_host.py
plugins/modules/one_image.py
plugins/modules/one_image_info.py
plugins/modules/one_service.py
plugins/modules/one_template.py
plugins/modules/one_vm.py
plugins/modules/one_vnet.py
plugins/modules/oneandone_firewall_policy.py
plugins/modules/oneandone_load_balancer.py
plugins/modules/oneandone_monitoring_policy.py
plugins/modules/oneandone_server.py
plugins/modules/onepassword_info.py
plugins/modules/oneview_datacenter_info.py
plugins/modules/oneview_enclosure_info.py
plugins/modules/oneview_ethernet_network_info.py
plugins/modules/oneview_logical_interconnect_group.py
plugins/modules/oneview_network_set_info.py
plugins/modules/oneview_san_manager.py
plugins/modules/open_iscsi.py
plugins/modules/openbsd_pkg.py
plugins/modules/opendj_backendprop.py
plugins/modules/openwrt_init.py
plugins/modules/opkg.py
plugins/modules/osx_defaults.py
plugins/modules/ovh_ip_failover.py
plugins/modules/ovh_ip_loadbalancing_backend.py

@ansibullbot ansibullbot added docs module module plugins plugin (any type) labels Jan 4, 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 4, 2025
@felixfontein
Copy link
Collaborator

Can you please either change the example to

- name: Wait for SSH to come up
  ansible.builtin.wait_for:
    port: 22
    host: '{{ vm.instances[0].networks[0].ip }}' 

(as you initially suggested), or change the module reference back to wait_for_instance in both the documentation and the example?

@russoz
Copy link
Collaborator Author

russoz commented Jan 12, 2025

Can you please either change the example to

- name: Wait for SSH to come up
  ansible.builtin.wait_for:
    port: 22
    host: '{{ vm.instances[0].networks[0].ip }}' 

done

Co-authored-by: Felix Fontein <felix@fontein.de>
@felixfontein felixfontein merged commit d325cfc into ansible-collections:main Jan 12, 2025
138 checks passed
Copy link

patchback bot commented Jan 12, 2025

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

❌ Failed to cleanly apply d325cfc on top of patchback/backports/stable-9/d325cfc3437e080c63b544afd5ddd9339a209f9f/pr-9526

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

patchback bot commented Jan 12, 2025

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/d325cfc3437e080c63b544afd5ddd9339a209f9f/pr-9526

Backported as #9566

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

@felixfontein
Copy link
Collaborator

@russoz thanks a lot!

patchback bot pushed a commit that referenced this pull request Jan 12, 2025
* o*: style adjustments

* apply recommendations from review

* Update plugins/modules/one_vm.py

* fix example

* adjustment from review

* Update plugins/modules/one_vm.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d325cfc)
felixfontein pushed a commit that referenced this pull request Jan 12, 2025
o*: style adjustments (#9526)

* o*: style adjustments

* apply recommendations from review

* Update plugins/modules/one_vm.py

* fix example

* adjustment from review

* Update plugins/modules/one_vm.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
(cherry picked from commit d325cfc)

Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
@russoz russoz deleted the o-doc-style branch January 12, 2025 18:56
Massl123 pushed a commit to Massl123/community.general that referenced this pull request Feb 7, 2025
* o*: style adjustments

* apply recommendations from review

* Update plugins/modules/one_vm.py

* fix example

* adjustment from review

* Update plugins/modules/one_vm.py

Co-authored-by: Felix Fontein <felix@fontein.de>

---------

Co-authored-by: Felix Fontein <felix@fontein.de>
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 module module plugins plugin (any type)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants