-
Notifications
You must be signed in to change notification settings - Fork 0
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
Community health, templates, diagnostics, and CLI #6
Conversation
… dependency, and CUDA information, and printing out this information.
…e project's community health documents.
…he installed instance of RIA Core.
…an be accessed from the command line by executing 'ria version', or by calling the ria.print_version_info() function in Python.
Instructions for building docs with |
Thanks @UmairK5669. Ya, when we run As I understand, the only thing that is not automatic is adding the Perhaps for now the I should just update step 3 to read: "A working copy of the docs will now be available at http://localhost:8000/, and any changes made to the configurations in the |
…age is easier to identify within site-packages
…y alongside 'ria'.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
reviewed diffs and tested ria version
and all appears to be working.
These new instructions are great. I don't necessarily think we need to further explain |
Added several community health documents:
Made a few updates to the README, mostly just adding links to relevant community health documents and the to support forum.
Added issue templates for bug reports and feature requests, and added a link to the support forum on the issue selection page. Now, when uses go to submit an issue, they will see this:
When drafting an issue, they will be reminded at the bottom that their contribution must align with the relevant community health documents.
Added pull request template.
Initialized RIA CLI, powered by Click. CLI is now composable, so all commands are executed using
ria [OPTIONS] COMMAND [ARGS]...
syntax. Furthermore, all commands are defined independently of the RIA CLI and found and integrated automatically, meaning no need to ever updateria_cli.py
nor to modify the command definitions when pulling them in from development repos.Added
diagnostics
package withprint_version_info()
function. This function finds and prints out system, dependency, and CUDA information. We prompt the users to include this information in their bug reports. Example output (on my work laptop):This information can also be accessed from the command line using
ria version
. Further work is required to find all the version information for the libraries that don't provide metadata in the expected format.Note: If you want to test the issue or pull request templates prior to merging, you'll have to do so in my workspace: https://github.com/qoherent/michael.
@Alec1234567, you'll want to check out how I'm generating a composable CLI with Click.
@UmairK5669, can you verify whether my instructions for building the project's docs for
sphinx-autobuild
are accurate and complete? (They're in CODING.md)