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

document adjacent docs (sidecar) #79056

Merged
merged 12 commits into from Jan 12, 2023
Merged

document adjacent docs (sidecar) #79056

merged 12 commits into from Jan 12, 2023

Conversation

bcoca
Copy link
Member

@bcoca bcoca commented Oct 6, 2022

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

docs

@ansibot
Copy link
Contributor

ansibot commented Oct 6, 2022

Thanks for your Ansible docs contribution! We talk about Ansible documentation on matrix at #docs:ansible.im and on libera IRC at #ansible-docs if you ever want to join us and chat about the docs! We meet there on Tuesdays (see the Ansible calendar) and welcome additions to our weekly agenda items - scroll down to find the upcoming agenda and add a comment to put something new on that agenda.

click here for bot help

@ansibot ansibot added WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. affects_2.15 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. ci_verified Changes made in this PR are causing tests to fail. labels Oct 6, 2022
oraNod
oraNod reviewed Oct 6, 2022
View reviewed changes
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

A few minor grammar nits and spellings.

docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Oct 6, 2022
@ansible ansible deleted a comment from ansibot Oct 6, 2022
@bcoca bcoca removed the needs_triage Needs a first human triage before being processed. label Oct 6, 2022
@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Oct 7, 2022
@ansible ansible deleted a comment from ansibot Oct 7, 2022
@ansibot
Copy link
Contributor

ansibot commented Oct 7, 2022

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

docs/docsite/rst/dev_guide/sidecar.rst:0:0: not-in-toc-tree: document isn't included in any toctree

click here for bot help

@ansible ansible deleted a comment from ansibot Oct 7, 2022
@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. labels Oct 7, 2022
@ansibot ansibot added the stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. label Oct 15, 2022
@bcoca bcoca changed the title docs on docs document adjacent docs (sidecar) Jan 11, 2023
@bcoca
Copy link
Member Author

bcoca commented Jan 11, 2023

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@ansibot ansibot added ci_verified Changes made in this PR are causing tests to fail. and removed ci_verified Changes made in this PR are causing tests to fail. stale_ci This PR has been tested by CI more than one week ago. Close and re-open this PR to get it retested. labels Jan 11, 2023
bcoca and others added 3 commits January 11, 2023 14:29
@ansibot ansibot removed the ci_verified Changes made in this PR are causing tests to fail. label Jan 11, 2023
@bcoca bcoca marked this pull request as ready for review January 11, 2023 20:41
@ansibot ansibot removed the WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. label Jan 11, 2023
oraNod
oraNod reviewed Jan 12, 2023
View reviewed changes
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/developing_locally.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/sidecar.rst Outdated Show resolved Hide resolved
docs/docsite/rst/dev_guide/testing_documentation.rst Outdated Show resolved Hide resolved
@oraNod
Copy link
Contributor

oraNod commented Jan 12, 2023

@bcoca I don't know if these are too many suggestions or not. I'd be happy to go through the review and provide rationale for some of the changes if you're interested in that side of tech docs too.

This looks really cool though and I enjoyed getting into the dev guide!

@bcoca @oraNod
Apply suggestions from code review
7d1aed9 
Co-authored-by: Don Naro <dnaro@redhat.com>
@ansibot

This comment was marked as resolved.

Sign in to view
@ansibot ansibot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jan 12, 2023
@ansibot ansibot removed the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jan 12, 2023
oraNod
oraNod approved these changes Jan 12, 2023
View reviewed changes
Copy link
Contributor

@oraNod oraNod left a comment

Choose a reason for hiding this comment

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

LGTM

@bcoca bcoca merged commit 8b03215 into ansible:devel Jan 12, 2023
@bcoca bcoca deleted the dev_mod_update branch January 12, 2023 16:47
@ansibot ansibot added 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 Jan 12, 2023
@ansible ansible locked and limited conversation to collaborators Jan 19, 2023
samccann
samccann reviewed Jan 19, 2023
View reviewed changes
docs/docsite/rst/dev_guide/ansible_index.rst
@@ -75,6 +75,7 @@ If you prefer to read the entire guide, here's a list of the pages in order.
developing_python_3
debugging
developing_modules_documenting
adjacent_yaml_doc
Copy link
Contributor

Choose a reason for hiding this comment

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

@oraNod @bcoca FWIW this won't show up on Ansible package docs as it's an incorrect file name (it's sidecar). I'm guessing CI doesn't detect problems like this but we need another PR to correct this pls.

Copy link
Contributor

@samccann samccann Jan 19, 2023 •
edited

Choose a reason for hiding this comment

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

pr at #79779

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@samccann samccann samccann left review comments

@oraNod oraNod oraNod approved these changes

Assignees
No one assigned
Labels
affects_2.15 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. 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.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@bcoca @ansibot @oraNod @samccann