Skip to content

Various docs fixups - #792

Merged
softwarefactory-project-zuul[bot] merged 3 commits into
ansible-collections:mainfrom
tremble:docs/broken_links
Apr 26, 2022
Merged

Various docs fixups#792
softwarefactory-project-zuul[bot] merged 3 commits into
ansible-collections:mainfrom
tremble:docs/broken_links

Conversation

@tremble

@tremble tremble commented Apr 26, 2022 •
edited
Loading

Copy link
Copy Markdown
Contributor
SUMMARY

Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``)

ISSUE TYPE
  • Bugfix Pull Request
COMPONENT NAME

docs/docsite/rst/dev_guidelines.rst
docs/docsite/rst/guide_aws.rst
ec2_group
ec2_snapshot
ec2_vpc_dhcp_option_info

ADDITIONAL INFORMATION

For a full list of issues:
https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true

@ansibullbot

ansibullbot commented Apr 26, 2022

Copy link
Copy Markdown

cc @adq @jillr @naslanidis @s-hertel @willthames
click here for bot help

@ansibullbot ansibullbot added bug This issue/PR relates to a bug community_review docs module module needs_triage plugins plugin (any type) labels Apr 26, 2022
@tremble tremble mentioned this pull request Apr 26, 2022
Closed
@softwarefactory-project-zuul

softwarefactory-project-zuul Bot commented Apr 26, 2022

Copy link
Copy Markdown
Contributor

Build succeeded.

@tremble tremble added backport-3 PR should be backported to the stable-3 branch backport-2 PR should be backported to the stable-2 branch backport-1.5 PR should be backported to the stable-1.5 branch labels Apr 26, 2022
@tremble
tremble requested a review from markuman April 26, 2022 15:00
@jillr jillr added the mergeit Merge the PR (SoftwareFactory) label Apr 26, 2022
@softwarefactory-project-zuul

softwarefactory-project-zuul Bot commented Apr 26, 2022

Copy link
Copy Markdown
Contributor

Build succeeded (gate pipeline).

@softwarefactory-project-zuul
softwarefactory-project-zuul Bot merged commit 3f46a94 into ansible-collections:main Apr 26, 2022
@patchback

patchback Bot commented Apr 26, 2022 •
edited
Loading

Copy link
Copy Markdown

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

❌ Failed to cleanly apply 3f46a94 on top of patchback/backports/stable-1.5/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792

Backporting merged PR #792 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/amazon.aws.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-1.5/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792 upstream/stable-1.5
  4. Now, cherry-pick PR Various docs fixups #792 contents into that branch: 
    $ git cherry-pick -x 3f46a945eda0d42f48fe4335de60a261e5ee6927
    If it'll yell at you with something like fatal: Commit 3f46a945eda0d42f48fe4335de60a261e5ee6927 is a merge but no -m option was given., add -m 1 as follows intead: 
    $ git cherry-pick -m1 -x 3f46a945eda0d42f48fe4335de60a261e5ee6927
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Various docs fixups #792 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-1.5/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792
  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

patchback Bot commented Apr 26, 2022 •
edited
Loading

Copy link
Copy Markdown

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

❌ Failed to cleanly apply 3f46a94 on top of patchback/backports/stable-2/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792

Backporting merged PR #792 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/amazon.aws.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/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792 upstream/stable-2
  4. Now, cherry-pick PR Various docs fixups #792 contents into that branch: 
    $ git cherry-pick -x 3f46a945eda0d42f48fe4335de60a261e5ee6927
    If it'll yell at you with something like fatal: Commit 3f46a945eda0d42f48fe4335de60a261e5ee6927 is a merge but no -m option was given., add -m 1 as follows intead: 
    $ git cherry-pick -m1 -x 3f46a945eda0d42f48fe4335de60a261e5ee6927
  5. At this point, you'll probably encounter some merge conflicts. You must
    resolve them in to preserve the patch from PR Various docs fixups #792 as close to the
    original as possible.
  6. Push this branch to your fork on GitHub: 
    $ git push origin patchback/backports/stable-2/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792
  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

patchback Bot commented Apr 26, 2022 •
edited
Loading

Copy link
Copy Markdown

Backport to stable-3: 💚 backport PR created

✅ Backport PR branch: patchback/backports/stable-3/3f46a945eda0d42f48fe4335de60a261e5ee6927/pr-792

Backported as #793

🤖 @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 Apr 26, 2022
@tremble @patchback
Various docs fixups (#792)
3c79a24 
Various docs fixups

SUMMARY
Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``)
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
docs/docsite/rst/dev_guidelines.rst
docs/docsite/rst/guide_aws.rst
ec2_group
ec2_snapshot
ec2_vpc_dhcp_option_info
ADDITIONAL INFORMATION
For a full list of issues:
https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true

Reviewed-by: Felix Fontein <[email protected]>
Reviewed-by: Markus Bergholz <[email protected]>
Reviewed-by: Jill R <None>
(cherry picked from commit 3f46a94)
@patchback patchback Bot mentioned this pull request Apr 26, 2022
Merged
softwarefactory-project-zuul Bot pushed a commit that referenced this pull request Apr 26, 2022
@patchback
Various docs fixups (#792) (#793)
71b3871 
[PR #792/3f46a945 backport][stable-3] Various docs fixups

This is a backport of PR #792 as merged into main (3f46a94).
SUMMARY
Attempting to enable a docs linting workflow (#790) we picked up on a number of issues with the docs formating (mostly related to `foo` vs ``foo``)
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
docs/docsite/rst/dev_guidelines.rst
docs/docsite/rst/guide_aws.rst
ec2_group
ec2_snapshot
ec2_vpc_dhcp_option_info
ADDITIONAL INFORMATION
For a full list of issues:
https://github.com/tremble/amazon.aws/runs/6174097260?check_suite_focus=true

Reviewed-by: Jill R <None>
@tremble tremble mentioned this pull request Apr 28, 2022
Merged
@tremble
tremble deleted the docs/broken_links branch September 9, 2022 08:51
abikouo pushed a commit to abikouo/amazon.aws that referenced this pull request Oct 24, 2023
@tremble
Add missing entries to AWS action group (ansible-collections#792)
5889c02 
Add missing entries to AWS action group

SUMMARY
A couple of entries are missing from the AWS action group
ISSUE TYPE

Bugfix Pull Request

COMPONENT NAME
meta/runtime.yml
ADDITIONAL INFORMATION
Spotted while investigating ansible-collections#557

Reviewed-by: Alina Buzachis <None>
Reviewed-by: None <None>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jillr jillr jillr approved these changes
@felixfontein felixfontein felixfontein approved these changes
@alinabuzachis alinabuzachis Awaiting requested review from alinabuzachis
+1 more reviewer
@markuman markuman markuman approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

backport-1.5 PR should be backported to the stable-1.5 branch backport-2 PR should be backported to the stable-2 branch backport-3 PR should be backported to the stable-3 branch bug This issue/PR relates to a bug community_review docs mergeit Merge the PR (SoftwareFactory) module module plugins plugin (any type)

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@tremble @ansibullbot @markuman @jillr @felixfontein