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: overall minor renovations #1874

Open
wants to merge 10 commits into
base: devel
Choose a base branch
from
Open

docs: overall minor renovations #1874

wants to merge 10 commits into from

Conversation

kurokobo
Copy link
Contributor

@kurokobo kurokobo commented May 26, 2024

SUMMARY

Live preview: https://ansible--1874.org.readthedocs.build/projects/awx-operator/en/1874/

This PR is overall minor renovation for documentation.

Main changes:

  • Simplify and update README.md of this repository and use it as Home page of the doc site
  • Correct levels of headings for the most pages
    • All pages begin with a level 1 heading. This makes the page toc to work properly.
      image
    • Currently there is no toc because the level of headlines is too low.
  • Use admonitions instead of text-based notes, tips, warnings, etc.
  • Re-order navigations
  • The content about hostAlias changed to a separate page
  • Merge default-execution-environments-from-private-registries.md into deploying-a-specific-version-of-awx.md and change title to Using images from private registries
  • Add an example to integrate LDAP via extra_settings_files on enabling-ldap-integration-at-awx-bootstrap.md
  • Add existing pages to navigations: kind-installation.md, container-probes.md, security-context.md
  • Remove adding-execution-nodes.md

Misc. changes:

  • Add links to related pages on some pages (e.g. add link to minikube installation page on basic install page)
  • Correct some misleading or out-of-date descriptions
  • Move images under images directory
  • Remove unused docs/awx-demo.svg
  • Remove mailing list from Get Involved page
  • Correct linting issues
  • Fix indentation for some codeblocks
  • Fix typos
ISSUE TYPE
  • Bug, Docs Fix or other nominal change
ADDITIONAL INFORMATION

Live preview for this PR is here: https://ansible--1874.org.readthedocs.build/projects/awx-operator/en/1874/

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 couple of nits for you. Thanks for the docs renovations @kurokobo

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
docs/contributors-guide/get-involved.md Outdated Show resolved Hide resolved
@oraNod
Copy link
Contributor

oraNod commented Jun 5, 2024

@kurokobo I don't know why the readthedocs project was not configured to generate build previews for PR but I've enabled that. If you'd like to close and reopen this issue, it should generate the preview for you now. Cheers.

@kurokobo
Copy link
Contributor Author

kurokobo commented Jun 9, 2024

@oraNod @tvo318
Hi, thanks for your comments! Sorry for the late reply, I haven't been feeling well and couldn't find the time to respond.
Will update this PR in next few days. Thanks!

@kurokobo kurokobo marked this pull request as draft June 10, 2024 12:52
@kurokobo kurokobo marked this pull request as ready for review June 10, 2024 12:52
@kurokobo kurokobo closed this Jun 10, 2024
@kurokobo kurokobo reopened this Jun 10, 2024
@kurokobo
Copy link
Contributor Author

@oraNod @tvo318
Thanks for reviewing this, I've updated this PR. Now ready for review again 😃
Live Preview: https://ansible--1874.org.readthedocs.build/projects/awx-operator/en/1874/

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.

Very minor nits. The rest looks great! Thanks so much @kurokobo

Co-authored-by: Don Naro <dnaro@redhat.com>
@kurokobo
Copy link
Contributor Author

@oraNod
Thanks again, updated!

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