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: moved user guide segment from readme #1480

Merged
merged 1 commit into from Jul 26, 2023

Conversation

LuluNwenyi
Copy link
Contributor

@LuluNwenyi LuluNwenyi commented Jul 5, 2023

SUMMARY

Moved User Guide from ReadME to it's folder in /docs directory.

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
ADDITIONAL INFORMATION

This PR is in line with the docs revamp and tracked by issue #1360

@DesmondSanctity
Copy link
Contributor

DesmondSanctity commented Jul 5, 2023

@LuluNwenyi so few things to update here:

  • The table of content still has the reference to the docs moved, that part should be removed
  • Create another folder inside /docs/user-guide directory for advanced configuration and separate the subtopics to different .md files. I think it will be more readable that way than everything in one file.
  • Also, debugging.md and migration.md are already in the docs root folder. Just move them to docs/user-guide/advanced-configuration folder you will create.

I think every other thing is perfect. Thanks for the PR

@LuluNwenyi
Copy link
Contributor Author

@LuluNwenyi so few things to update here:

  • The table of content still has the reference to the docs moved, that part should be removed
  • Create another folder inside /docs/user-guide directory for advanced configuration and separate the subtopics to different .md files. I think it will be more readable that way than everything in one file.
  • Also, debugging.md and migration.md are already in the docs root folder. Just move them to docs/user-guide/advanced-configuration folder you will create.

I think every other thing is perfect. Thanks for the PR

I think that we should leave the debugging and migration files in the docs root folder, for easy referencing. It's also referenced in the database config topic.

DesmondSanctity

This comment was marked as off-topic.

@DesmondSanctity
Copy link
Contributor

@LuluNwenyi so few things to update here:

  • The table of content still has the reference to the docs moved, that part should be removed
  • Create another folder inside /docs/user-guide directory for advanced configuration and separate the subtopics to different .md files. I think it will be more readable that way than everything in one file.
  • Also, debugging.md and migration.md are already in the docs root folder. Just move them to docs/user-guide/advanced-configuration folder you will create.

I think every other thing is perfect. Thanks for the PR

I think that we should leave the debugging and migration files in the docs root folder, for easy referencing. It's also referenced in the database config topic.

What if we update the reference in database config topic?

@LuluNwenyi
Copy link
Contributor Author

This section should also be in the Admin User Account Configuration md file. I guess the table of content did not capture it and I missed it in my breakdown too.

@LuluNwenyi so few things to update here:

  • The table of content still has the reference to the docs moved, that part should be removed
  • Create another folder inside /docs/user-guide directory for advanced configuration and separate the subtopics to different .md files. I think it will be more readable that way than everything in one file.
  • Also, debugging.md and migration.md are already in the docs root folder. Just move them to docs/user-guide/advanced-configuration folder you will create.

I think every other thing is perfect. Thanks for the PR

I think that we should leave the debugging and migration files in the docs root folder, for easy referencing. It's also referenced in the database config topic.

What if we update the reference in database config topic?

This could work

@DesmondSanctity
Copy link
Contributor

@LuluNwenyi looks good now. Thanks

@LuluNwenyi
Copy link
Contributor Author

@LuluNwenyi looks good now. Thanks

Sure!

@samccann
Copy link
Collaborator

Part of #1360

@samccann
Copy link
Collaborator

Hi @LuluNwenyi ! I'm going to rebase each of your PRs one at a time to get them to the merge state. Just so know who what's happening here.

docs: moved user guide segment from readme

docs: moved user guide segment from readme

docs: updated user guide segment
@samccann samccann merged commit 470c7c3 into ansible:devel Jul 26, 2023
6 checks passed
@samccann
Copy link
Collaborator

Thanks @LuluNwenyi for the docs PR! this was a sizable move for sure!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants