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.

Sign up for GitHub

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

Jump to bottom

Docs: fix its vs. it's #9442

Merged
merged 3 commits into from
Dec 29, 2024
Merged

Docs: fix its vs. it's #9442

merged 3 commits into from
Dec 29, 2024

Conversation

felixfontein
Copy link
Collaborator

SUMMARY

"its" vs. "it's". The latter should usually be "it is", but sometimes it actually should be "its"...

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

various

@felixfontein felixfontein added backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch labels Dec 28, 2024
@felixfontein felixfontein requested a review from russoz December 28, 2024 13:29
@ansibullbot
Copy link
Collaborator

@felixfontein This PR was evaluated as a potentially problematic PR for the following reasons:

  • More than 50 changed files.

Such PR can only be merged by human. Contact a Core team member to review this PR on IRC: #ansible-devel on Libera.chat IRC

click here for bot help

@ansibullbot ansibullbot added docs needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR labels Dec 28, 2024
@felixfontein
Copy link
Collaborator Author

bot_skip

@felixfontein felixfontein removed needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR needs_rebase https://docs.ansible.com/ansible/devel/dev_guide/developing_rebasing.html labels Dec 28, 2024
russoz
russoz reviewed Dec 28, 2024
View reviewed changes
Copy link
Collaborator

@russoz russoz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some comments.

plugins/module_utils/_filelock.py Outdated Show resolved Hide resolved
plugins/module_utils/identity/keycloak/keycloak.py Outdated Show resolved Hide resolved
plugins/module_utils/redfish_utils.py Outdated Show resolved Hide resolved
plugins/modules/influxdb_retention_policy.py Outdated Show resolved Hide resolved
plugins/modules/keycloak_userprofile.py Outdated Show resolved Hide resolved
plugins/modules/ovh_ip_failover.py Outdated Show resolved Hide resolved
plugins/modules/vmadm.py Outdated Show resolved Hide resolved
plugins/modules/vmadm.py Outdated Show resolved Hide resolved
plugins/modules/sl_vm.py
@@ -138,11 +138,11 @@
type: int
public_vlan:
description:
- VLAN by its Id to be assigned to the public NIC.
- VLAN by its ID to be assigned to the public NIC.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are way too many instances of this as id as well. I can tweak andebox to look for that as well, but I wasn't clear about a "standard" to adopt. Should it always be upper case?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it should always be ID (upper-case).

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okie, I'll put it on the radar, but not entirely sure the upper-case is going to work in every situation.

felixfontein and others added 2 commits December 29, 2024 01:05
@felixfontein @russoz
Improvements from review.
47179cc 
Co-authored-by: Alexei Znamensky <[email protected]>
@felixfontein @russoz
Improve formulations.
e516549 
Co-authored-by: Alexei Znamensky <[email protected]>
@felixfontein felixfontein merged commit ec58539 into ansible-collections:main Dec 29, 2024
129 checks passed
@patchback Patchback
Copy link

patchback bot commented Dec 29, 2024 •
edited
Loading

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

❌ Failed to cleanly apply ec58539 on top of patchback/backports/stable-9/ec585392e5a8f43cbfb50fb9a9ddf7d7bdafe508/pr-9442

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

patchback bot commented Dec 29, 2024 •
edited
Loading

Backport to stable-10: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-10/ec585392e5a8f43cbfb50fb9a9ddf7d7bdafe508/pr-9442

Backported as #9458

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

@felixfontein
Copy link
Collaborator Author

@russoz thanks for reviewing this!

patchback bot pushed a commit that referenced this pull request Dec 29, 2024
@felixfontein @patchback
Docs: fix its vs. it's (#9442)
e5eb68d 
* Fix its vs. it's.

* Improvements from review.

Co-authored-by: Alexei Znamensky <[email protected]>

* Improve formulations.

Co-authored-by: Alexei Znamensky <[email protected]>

---------

Co-authored-by: Alexei Znamensky <[email protected]>
(cherry picked from commit ec58539)
@patchback patchback bot mentioned this pull request Dec 29, 2024
Merged
felixfontein added a commit that referenced this pull request Dec 29, 2024
@patchback @felixfontein
[PR #9442/ec585392 backport][stable-10] Docs: fix its vs. it's (#9458)
98a956a 
Docs: fix its vs. it's (#9442)

* Fix its vs. it's.

* Improvements from review.

Co-authored-by: Alexei Znamensky <[email protected]>

* Improve formulations.

Co-authored-by: Alexei Znamensky <[email protected]>

---------

Co-authored-by: Alexei Znamensky <[email protected]>
(cherry picked from commit ec58539)

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

@russoz russoz russoz left review comments

Assignees
No one assigned
Labels
backport-9 Automatically create a backport for the stable-9 branch backport-10 Automatically create a backport for the stable-10 branch docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@felixfontein @ansibullbot @russoz