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

Create collection maintainer's guide #76976

Merged
merged 7 commits into from
Feb 17, 2022
Merged

Create collection maintainer's guide #76976

merged 7 commits into from
Feb 17, 2022

Conversation

samccann
Copy link
Contributor

@samccann samccann commented Feb 7, 2022

SUMMARY

Pulled from https://github.com/ansible/community-docs

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs/docsite/rst/community/committer_guidelines.rst

ADDITIONAL INFORMATION

@samccann
Copy link
Contributor Author

samccann commented Feb 7, 2022

Remaining items:

NOTE: while this info is being brought into ansible/ansible, it is still TBD whether it will stay in that repo or eventually move to a separate repo and be brought back to docs.ansible.com by . See ansible-community/community-topics#60 for details and discussion.

@ansibot
Copy link
Contributor

ansibot commented Feb 7, 2022

The test ansible-test sanity --test docs-build [explain] failed with 2 errors:

docs/docsite/rst/community/maintainers_guidelines.rst:0:0: not-in-toc-tree: document isn't included in any toctree
docs/docsite/rst/community/maintainers_workflow.rst:0:0: not-in-toc-tree: document isn't included in any toctree

The test ansible-test sanity --test no-smart-quotes [explain] failed with 1 error:

docs/docsite/rst/community/maintainers_workflow.rst:9:153: use ASCII quotes `'` and `"` instead of Unicode quotes

click here for bot help

@ansibot ansibot added affects_2.13 ci_verified Changes made in this PR are causing tests to fail. 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_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. needs_triage Needs a first human triage before being processed. support:core This issue/PR relates to code supported by the Ansible Engineering Team. labels Feb 7, 2022
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 8, 2022
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Feb 8, 2022
Andersson007
Andersson007 reviewed Feb 9, 2022
View reviewed changes
Copy link
Contributor

@Andersson007 Andersson007 left a comment •
edited

Choose a reason for hiding this comment

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

I like the suggested structure, looks very good, thank you!

docs/docsite/rst/community/maintainers_workflow.rst Outdated Show resolved Hide resolved
@Andersson007
Copy link
Contributor

Remaining items:

NOTE: while this info is being brought into ansible/ansible, it is still TBD whether it will stay in that repo or eventually move to a separate repo and be brought back to docs.ansible.com by . See ansible-community/community-topics#60 for details and discussion.

I'm still not in favor of any approach (we should wait for community feedback as we've decided) but, as this kind of doc is a subject to relatively frequent updates compared to ansible-core, it would be great if the latest pages contain actual versions of the docs, not those merged before the previous major ansible-core release, i.e. latest and devel pages would be the same if possible.

@ansibot
Copy link
Contributor

ansibot commented Feb 14, 2022

The test ansible-test sanity --test rstcheck [explain] failed with 1 error:

docs/docsite/rst/community/maintainers_workflow.rst:27:0: Mismatch: both interpreted text role prefix and reference suffix.

click here for bot help

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Feb 14, 2022
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed ci_verified Changes made in this PR are causing tests to fail. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 15, 2022
ariordan-redhat
ariordan-redhat reviewed Feb 16, 2022
View reviewed changes
Copy link
Contributor

@ariordan-redhat ariordan-redhat left a comment

Choose a reason for hiding this comment

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

One link needs a syntax fix. All other comments are just suggestions.

docs/docsite/rst/community/maintainers_workflow.rst Outdated Show resolved Hide resolved
docs/docsite/rst/community/maintainers_workflow.rst Show resolved Hide resolved
docs/docsite/rst/community/maintainers_workflow.rst Outdated Show resolved Hide resolved
@samccann @ariordan-redhat
Apply suggestions from code review
8c624e5 
Co-authored-by: Aine Riordan <44700011+ariordan-redhat@users.noreply.github.com>
@ansibot ansibot added needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. and removed core_review In order to be merged, this PR must follow the core review workflow. labels Feb 16, 2022
@samccann
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed needs_ci This PR requires CI testing to be performed. Please close and re-open this PR to trigger CI. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. labels Feb 16, 2022
@ariordan-redhat ariordan-redhat merged commit e620b96 into ansible:devel Feb 17, 2022
@samccann samccann mentioned this pull request Feb 17, 2022
Closed
@samccann samccann deleted the maintain branch February 28, 2022 21:43
@ansible ansible locked and limited conversation to collaborators Mar 3, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@Andersson007 Andersson007 Andersson007 left review comments

@ariordan-redhat ariordan-redhat ariordan-redhat left review comments

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. 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
5 participants
@samccann @ansibot @Andersson007 @ariordan-redhat @bcoca