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

Docs: Issue 78082 move basic concepts to start (1/3) #78097

Merged
merged 1 commit into from
Jun 23, 2022

Conversation

oraNod
Copy link
Contributor

@oraNod oraNod commented Jun 20, 2022

SUMMARY

Part one of #78082 that moves the basic concepts page to getting started.

ISSUE TYPE
  • Docs Pull Request
COMPONENT NAME

Documentation: User Guide: Getting Started

ADDITIONAL INFORMATION

Relocates the basic concepts detail to the getting started page.

@oraNod oraNod requested a review from samccann June 20, 2022 15:32
@oraNod oraNod marked this pull request as draft June 20, 2022 15:32
@ansibot
Copy link
Contributor

ansibot commented Jun 20, 2022

Thanks for your Ansible docs contribution! We talk about Ansible documentation on maxtrix 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.14 docs This issue/PR relates to or includes documentation. docs_only All changes are to files within the docs/docsite/ directory 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 Jun 20, 2022
@oraNod
Copy link
Contributor Author

oraNod commented Jun 20, 2022

@samccann Here's part one. I'll create more PRs tomorrow. I wanted to ask about the redirect strategy. If we keep all these changes on devel would it be better to orphan any pages that we move (in this case basic_concepts.rst) and leave them in the User Guide with internal link/href to the new location?

IMO it probably makes sense to set things up in the .htaccess file once we're ready to merge everything onto latest. We avoid 404s and don't need to touch those redirects. But I guess it will mean more work once we get around to doing the redirects. Or maybe we just leave the orphaned pages as-is when we merge to latest?

Sorry for all the questions. Just want to make sure I get the correct approach. Cheers.

Edit: I pushed a commit that orphans the page in the user guide. I think it is the least hassle as it keeps everything in the one PR and avoids breaking bookmarks and causing 404s.

@oraNod oraNod marked this pull request as ready for review June 21, 2022 09:48
@ansibot ansibot added core_review In order to be merged, this PR must follow the core review workflow. and removed WIP This issue/PR is a work in progress. Nevertheless it was shared for getting input from peers. labels Jun 21, 2022
@s-hertel s-hertel removed the needs_triage Needs a first human triage before being processed. label Jun 21, 2022
@bcoca bcoca changed the title move basic concepts to start move basic concepts to start (1/2) Jun 21, 2022
@oraNod oraNod changed the title move basic concepts to start (1/2) Docs: Issue 78082 move basic concepts to start (1/3) Jun 21, 2022
@samccann samccann merged commit 08327c6 into ansible:devel Jun 23, 2022
@ansible ansible locked and limited conversation to collaborators Jun 30, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
affects_2.14 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. 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.

4 participants