Skip to content

docs: overall minor renovations#1874

Merged
rooftopcellist merged 10 commits intoansible:develfrom
kurokobo:docs
Jul 20, 2024
Merged

docs: overall minor renovations#1874
rooftopcellist merged 10 commits intoansible:develfrom
kurokobo:docs

Conversation

@kurokobo
Copy link
Copy Markdown
Contributor

@kurokobo kurokobo commented May 26, 2024 •
edited
Loading

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/

oraNod
oraNod reviewed Jun 5, 2024
View reviewed changes
Copy link
Copy Markdown
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

@oraNod
Copy link
Copy Markdown
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.

tvo318
tvo318 reviewed Jun 6, 2024
View reviewed changes
@kurokobo
Copy link
Copy Markdown
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
Copy Markdown
Contributor Author

kurokobo commented Jun 10, 2024

@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/

oraNod
oraNod approved these changes Jun 11, 2024
View reviewed changes
Copy link
Copy Markdown
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

@kurokobo
Copy link
Copy Markdown
Contributor Author

kurokobo commented Jun 11, 2024

@oraNod
Thanks again, updated!

@jessicamack jessicamack requested a review from tvo318 July 3, 2024 18:28
@rooftopcellist
Copy link
Copy Markdown
Member

rooftopcellist commented Jul 10, 2024

@kurokobo hey, we are ready to merge this now, we just need it to be rebased first to resolve the conflicts. Sorry for the delay on this.

@rooftopcellist rooftopcellist self-requested a review July 10, 2024 18:39
@rooftopcellist rooftopcellist enabled auto-merge (squash) July 10, 2024 18:39
tvo318
tvo318 approved these changes Jul 10, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@tvo318 tvo318 left a comment •
edited
Loading

Choose a reason for hiding this comment

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

I trust the content and renovation work here is solid. Let's go ahead and merge this. If there are anything that jumps out, we can always open a new PR to address them.

kurokobo and others added 10 commits July 11, 2024 21:16
auto-merge was automatically disabled July 11, 2024 12:21

Head branch was pushed to by a user without write access

@kurokobo
Copy link
Copy Markdown
Contributor Author

kurokobo commented Jul 11, 2024

@rooftopcellist @tvo318
I know you're probably busy with streamlining AWX's build process and other tasks, so I'm sorry for bothering you with this big PR, but I appreciate your continuous work on this!
I've rebased my branch, so please take a look. Auto-merge got disabled, because probably the person like me from outside force-pushed.

@rooftopcellist
Copy link
Copy Markdown
Member

rooftopcellist commented Jul 11, 2024

@kurokobo Huge kudos for all of this great work, I love these changes and appreciate you taking the time to do this. Thanks for rebasing the PR, I am taking a final look now.

@oraNod
Copy link
Copy Markdown
Contributor

oraNod commented Jul 11, 2024

I'd also like to chime in with kudos for @kurokobo IMO this is really impressive work and much appreciated. Thanks again for all the time and effort. 🚀

@rooftopcellist rooftopcellist merged commit 2b0221b into ansible:devel Jul 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tvo318 tvo318 tvo318 approved these changes

@rooftopcellist rooftopcellist Awaiting requested review from rooftopcellist

+1 more reviewer

@oraNod oraNod oraNod approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@tvo318 tvo318

Labels

community

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

4 participants

@kurokobo @oraNod @rooftopcellist @tvo318