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

Removed UI-focused user docs from AWX. #15641

Merged
merged 11 commits into from
Nov 22, 2024
Merged

Conversation

tvo318
Copy link
Member

@tvo318 tvo318 commented Nov 17, 2024

SUMMARY

Removed user docs with UI-focus from AWX as part of the AWX modernization efforts.

ISSUE TYPE
  • Bug, Docs Fix or other nominal change
COMPONENT NAME
  • Docs
AWX VERSION

latest

@oraNod
Copy link
Collaborator

oraNod commented Nov 18, 2024

Hey @tvo318 Looks like there is some funky indentation in the left nav:

image

@oraNod
Copy link
Collaborator

oraNod commented Nov 18, 2024

I think the left nav is off because "Release Notes" is an external link instead of a local RST file. could you try creating a file called something like release_notes.rst that has this in it?

Release Notes
============
.. raw:: html
   <meta http-equiv="refresh" content="0; url=https://github.com/ansible/awx/releases">

then put that in the toctree before known_issues like this:

.. toctree::
   :maxdepth: 2
   :caption: Welcome

   release_notes
   known_issues

Copy link

sonarcloud bot commented Nov 18, 2024

Copy link
Collaborator

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

LGTM. Thank you @tvo318

gundalow

This comment was marked as resolved.

@tvo318

This comment was marked as resolved.

Copy link
Contributor

@samccann samccann left a comment

Choose a reason for hiding this comment

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

LGTM. A couple of conf.py suggestions you could consider.

@@ -8,10 +8,10 @@
sys.path.insert(0, os.path.abspath('./rst/rest_api/_swagger'))

project = u'Ansible AWX'
copyright = u'2023, Red Hat'
copyright = u'2024, Red Hat'
Copy link
Contributor

Choose a reason for hiding this comment

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

RH legal said we don't need to have a date in the copyright statement. So you can pull 2024 out of this and never have to edit it again! Also if this is opensource, we may want a more generic owner. like copyright = "AWX project contributors"

Copy link
Member Author

Choose a reason for hiding this comment

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

Let's do this is in a subsequent PR.

author = u'Red Hat'

pubdateshort = '2023-08-04'
pubdateshort = '2024-11-22'
pubdate = datetime.strptime(pubdateshort, '%Y-%m-%d').strftime('%B %d, %Y')
Copy link
Contributor

Choose a reason for hiding this comment

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

you could experiment with removing this pubdate info and pubdateshort with something like this which we use on the core/package docs... and ... never update it again :-)

Copy link
Member Author

Choose a reason for hiding this comment

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

As agreed, let's do this is in a subsequent PR.

@tvo318 tvo318 merged commit 790875c into ansible:devel Nov 22, 2024
25 checks passed
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.

7 participants