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

Expose as command line interface #18

Open
jdkandersson opened this issue Dec 11, 2022 · 1 comment
Open

Expose as command line interface #18

jdkandersson opened this issue Dec 11, 2022 · 1 comment

Comments

@jdkandersson
Copy link
Contributor

Canonical hosts charm source code in places other than GitHub, make this tool available as a command line interface so that it can be run in those places. Publish on PyPI for easy installation

@barrettj12
Copy link

Some more advantages:

  • The Discourse pattern (navigation tables, etc) used for charm docs is also used by other teams (e.g. Juju). These other teams could use the CLI and write their own actions/workflows to drive it, and we could keep this action specific to charm docs.
  • The Discourse -> GitHub docs migration doesn't really make sense as a GitHub action, as it will only be run once. With a CLI this could just be invoked once to pull the Discourse docs into a specified folder, which can be checked into the repo.

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

No branches or pull requests

2 participants