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.

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

creates new structure for network docs #35514

Merged
merged 1 commit into from
Jan 31, 2018

Conversation

acozine
Copy link
Contributor

@acozine acozine commented Jan 30, 2018

SUMMARY

Creates a bare-bones landing page for the network docs at the top level of the documentation. This structural change will allow future work on network docs to move ahead more independently.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Network documentation

ANSIBLE VERSION
2.5
ADDITIONAL INFORMATION

See https://docs.google.com/document/d/1JzmxJn6DUPgQ-tjpgEqq-pjtTb4LbhRQicpBM28lCdI for the bigger picture.

@ansibot ansibot added docs_pull_request 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 Jan 30, 2018
@acozine
Copy link
Contributor Author

acozine commented Jan 30, 2018

@dharmabumstead since this PR removes the old intro_network page, I'd like to set a redirect from there to the new network page, so external links remain workable. I've heard you're doing a bunch of redirects as part of your refactoring work - can you add this one to the list? I'm happy to help when you get to that stage.

@gundalow gundalow self-assigned this Jan 30, 2018
@gundalow gundalow added networking Network category and removed needs_triage Needs a first human triage before being processed. labels Jan 30, 2018
Copy link
Contributor

@gundalow gundalow left a comment

Choose a reason for hiding this comment

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

Just a minor thing

@@ -0,0 +1,15 @@
Ansible Network
Copy link
Contributor

Choose a reason for hiding this comment

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

***************
Ansible Network
***************

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Current docs have inconsistent header styling (it has probably accumulated through the years). I'd prefer to discuss this, come up with a consistent notation, and submit one PR that makes all the docs use the same notation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Created #35520 to address this.

Copy link
Contributor

Choose a reason for hiding this comment

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

Agreed. Ignore this comment and we can address this in the bulk fix up PR.

As long as Shippable RST check passes (which it is) I'm happy.

@dharmabumstead dharmabumstead self-assigned this Jan 30, 2018
Copy link
Contributor

@dharmabumstead dharmabumstead left a comment

Choose a reason for hiding this comment

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

This is a great start! Nicely done, @acozine!

@ansibot ansibot added the needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. label Jan 30, 2018
@dharmabumstead dharmabumstead merged commit 9dad5d6 into ansible:devel Jan 31, 2018
@acozine acozine deleted the network_docs_structure branch January 31, 2018 21:21
Lujeni pushed a commit to Lujeni/ansible that referenced this pull request Feb 1, 2018
@ansibot ansibot added docs This issue/PR relates to or includes documentation. and removed docs_pull_request labels Mar 4, 2018
@ansible ansible locked and limited conversation to collaborators Apr 27, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs This issue/PR relates to or includes documentation. needs_revision This PR fails CI tests or a maintainer has requested a review/revision of the PR. networking Network category 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
Development

Successfully merging this pull request may close these issues.

None yet

4 participants