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

Create an AWX CLI Guide #15059

Open
4 of 9 tasks
samccann opened this issue Apr 2, 2024 · 1 comment
Open
4 of 9 tasks

Create an AWX CLI Guide #15059

samccann opened this issue Apr 2, 2024 · 1 comment

Comments

@samccann
Copy link
Contributor

samccann commented Apr 2, 2024

Please confirm the following

  • I agree to follow this project's code of conduct.
  • I have checked the current issues for duplicates.
  • I understand that AWX is open source software provided for free and that I might not receive a timely response.

Feature type

Enhancement to Existing Feature

Feature Summary

The only available CLI guide today is for controller. We should generate an AWX CLI guide that is incorporated into the AWX docsite.

Currently, the controller CLI guide is generated with an internal jenkins job. Ideally, the AWX CLI guide avoids this, but there are some complications that make it beyond me to solve:

  1. It requires an active AWX instance to run against.
  2. Generating the AWX CLI guide locally creates a standalone docsite today (not incorporated into the docs at docs/docsite in this repo).
  3. Even if we can solve the AWX instance through GitHub actions, how do we integrate that with ReadTheDocs publishing?

Select the relevant components

  • UI
  • API
  • Docs
  • Collection
  • CLI
  • Other

Steps to reproduce

none

Current results

none

Sugested feature result

AWX CLI guide appears as another guide in the AWX docsite, something like the following hack:
image

Additional information

No response

@samccann
Copy link
Contributor Author

samccann commented Apr 2, 2024

I'm happy to work on this, but I need some serious guidance. You can see my scramble of thoughts here.

I also got the static files included in a docs build here, but that's the easy stuff, so to speak. I can also generate the standalone awx CLI guide locally from the awxkit/awxkit/cli dir.

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

No branches or pull requests

2 participants