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

Fix typos in docs #76526

Merged
merged 1 commit into from
Dec 14, 2021
Merged

Fix typos in docs #76526

merged 1 commit into from
Dec 14, 2021

Conversation

kianmeng
Copy link
Contributor

SUMMARY
ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME
ADDITIONAL INFORMATION

@ansibot ansibot added affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory docsite This issue/PR relates to the documentation website. needs_triage Needs a first human triage before being processed. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Dec 10, 2021
samccann
samccann reviewed Dec 14, 2021
View reviewed changes
docs/docsite/rst/porting_guides/porting_guide_5.rst
@@ -309,7 +309,7 @@ amazon.aws
~~~~~~~~~~

- amazon.aws collection - Due to the AWS SDKs announcing the end of support for Python less than 3.6 (https://boto3.amazonaws.com/v1/documentation/api/1.17.64/guide/migrationpy3.html) this collection now requires Python 3.6+ (https://github.com/ansible-collections/amazon.aws/pull/298).
- amazon.aws collection - The amazon.aws collection has dropped support for ``botocore<1.18.0`` and ``boto3<1.15.0``. Most modules will continue to work with older versions of the AWS SDK, however compatability with older versions of the SDK is not guaranteed and will not be tested. When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/502).
- amazon.aws collection - The amazon.aws collection has dropped support for ``botocore<1.18.0`` and ``boto3<1.15.0``. Most modules will continue to work with older versions of the AWS SDK, however compatibility with older versions of the SDK is not guaranteed and will not be tested. When using older versions of the SDK a warning will be emitted by Ansible (https://github.com/ansible-collections/amazon.aws/pull/502).
Copy link
Contributor

Choose a reason for hiding this comment

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

Just FYI - the porting guides are autogenerated. While earlier guides seldom get updated, these fixes to Ansible 5 will be overwritten on the next dot release (Ansible 5.0.1) because this typo for example is actually in the amazon.aws collection and would need to be fixed there.

@samccann samccann removed the needs_triage Needs a first human triage before being processed. label Dec 14, 2021
@samccann samccann merged commit e5967c0 into ansible:devel Dec 14, 2021
@samccann
Copy link
Contributor

Thanks @kianmeng for the Ansible docs fix. As noted in the comment above, changes to the more recent porting guide (Ansible5) will be overwritten soon as the snippet comes from the collection itself and is just imported as is into the porting guide for each release. The rest is great, thanks!

@kianmeng
Copy link
Contributor Author

Thanks @kianmeng for the Ansible docs fix. As noted in the comment above, changes to the more recent porting guide (Ansible5) will be overwritten soon as the snippet comes from the collection itself and is just imported as is into the porting guide for each release. The rest is great, thanks!

@samccann Thanks for the feedback.

From the original PR, #76383, besides the code in these folders below which have been migrated to other repos:

  • test/support/integration/plugins/inventory
  • test/support/windows-integration/plugins/modules/
  • test/support/windows-integration/collections/ansible_collections/
  • test/support/integration/plugins/

Which other folders within this ansible repo we shouldn't submit typo fixes?

bcoca pushed a commit to bcoca/ansible that referenced this pull request Dec 15, 2021
@kianmeng @bcoca
Fix typos in docs (ansible#76526)
1e26afb
@samccann
Copy link
Contributor

Anything that ends in .po you don't need to change. Those are the results of translation of the English and any English typos would be retranslated the next time we generate a translation (picking up the correct spelling).

I'm only familiar with the user-facing documentation (module .py files and .rst files) so I'm not sure what else might not be worth touching.

@ansible ansible locked and limited conversation to collaborators Dec 28, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann approved these changes

Assignees
No one assigned
Labels
affects_2.13 core_review In order to be merged, this PR must follow the core review workflow. docs_only All changes are to files within the docs/docsite/ directory docs This issue/PR relates to or includes documentation. docsite This issue/PR relates to the documentation website. new_contributor This PR is the first contribution by a new community member. support:core This issue/PR relates to code supported by the Ansible Engineering Team.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@kianmeng @samccann @ansibot