-
Notifications
You must be signed in to change notification settings - Fork 1
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
Update tool commands #117
Merged
Merged
Update tool commands #117
Changes from 1 commit
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
10 changes: 5 additions & 5 deletions
10
packages/gatsby-theme-iterative/config/prismjs/cml-commands.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| module.exports = [ | ||
| 'ci', | ||
| 'pr', | ||
| 'publish', | ||
| 'runner', | ||
| 'send-comment', | ||
| 'send-github-check', | ||
| 'tensorboard-dev' | ||
| 'pr', | ||
| 'comment', | ||
| 'check', | ||
| 'workflow', | ||
| 'tensorboard' | ||
| ] | ||
146 changes: 72 additions & 74 deletions
146
packages/gatsby-theme-iterative/config/prismjs/dvc-commands.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,82 +1,80 @@ | ||
| /* eslint-env node */ | ||
|
|
||
| module.exports = [ | ||
| 'version', | ||
| 'update', | ||
| 'unprotect', | ||
| 'unfreeze', | ||
| 'tag', | ||
| 'status', | ||
| 'stage list', | ||
| 'stage add', | ||
| 'stage', | ||
| 'run', | ||
| 'root', | ||
| 'repro', | ||
| 'remove', | ||
| 'remote rename', | ||
| 'remote remove', | ||
| 'remote modify', | ||
| 'remote list', | ||
| 'remote default', | ||
| 'remote add', | ||
| 'remote', | ||
| 'queue stop', | ||
| 'queue start', | ||
| 'queue remove', | ||
| 'queue logs', | ||
| 'queue kill', | ||
| 'queue', | ||
| 'push', | ||
| 'pull', | ||
| 'pkg', | ||
| 'plots show', | ||
| 'plots modify', | ||
| 'plots diff', | ||
| 'plots', | ||
| 'move', | ||
| 'metrics show', | ||
| 'metrics diff', | ||
| 'metrics', | ||
| 'params diff', | ||
| 'params', | ||
| 'list-url', | ||
| 'ls-url', | ||
| 'list', | ||
| 'ls', | ||
| 'install', | ||
| 'init', | ||
| 'import-url', | ||
| 'import', | ||
| 'help', | ||
| 'get-url', | ||
| 'get', | ||
| 'gc', | ||
| 'freeze', | ||
| 'fetch', | ||
| 'exp show', | ||
| 'add', | ||
| 'cache dir', | ||
| 'cache', | ||
| 'check-ignore', | ||
| 'checkout', | ||
| 'commit', | ||
| 'config', | ||
| 'dag', | ||
| 'data status', | ||
| 'data', | ||
| 'destroy', | ||
| 'diff', | ||
| 'doctor', | ||
| 'exp init', | ||
| 'exp run', | ||
| 'exp show', | ||
| 'exp diff', | ||
| 'exp list', | ||
| 'exp apply', | ||
| 'exp branch', | ||
| 'exp remove', | ||
| 'exp gc', | ||
| 'exp push', | ||
| 'exp pull', | ||
| 'exp gc', | ||
| 'exp diff', | ||
| 'exp branch', | ||
| 'exp apply', | ||
| 'exp init', | ||
| 'exp', | ||
| 'fetch', | ||
| 'freeze', | ||
| 'gc', | ||
| 'get-url', | ||
| 'get', | ||
| 'import-url', | ||
| 'import', | ||
| 'init', | ||
| 'install', | ||
| 'list-url', | ||
| 'list', | ||
| 'metrics show', | ||
| 'metrics diff', | ||
| 'metrics', | ||
| 'move', | ||
| 'params diff', | ||
| 'params', | ||
| 'plots show', | ||
| 'plots diff', | ||
| 'plots modify', | ||
| 'plots templates', | ||
| 'plots', | ||
| 'pull', | ||
| 'push', | ||
| 'queue start', | ||
| 'queue stop', | ||
| 'queue status', | ||
| 'queue logs', | ||
| 'queue remove', | ||
| 'queue kill', | ||
| 'queue', | ||
| 'remote add', | ||
| 'remote modify', | ||
| 'remote default', | ||
| 'remote list', | ||
| 'remote remove', | ||
| 'remote rename', | ||
| 'remote', | ||
| 'remove', | ||
| 'repro', | ||
| 'root', | ||
| 'run', | ||
| 'stage add', | ||
| 'stage list', | ||
| 'stage', | ||
| 'status', | ||
| 'unfreeze', | ||
| 'unprotect', | ||
| 'update', | ||
| 'version', | ||
| 'experiments', | ||
| 'doctor', | ||
| 'diff', | ||
| 'destroy', | ||
| 'data status', | ||
| 'data', | ||
| 'dag', | ||
| 'config', | ||
| 'commit', | ||
| 'checkout', | ||
| 'check-ignore', | ||
| 'cache dir', | ||
| 'cache', | ||
| 'add' | ||
| 'ls-url', | ||
| 'ls' | ||
| ] |
22 changes: 12 additions & 10 deletions
22
packages/gatsby-theme-iterative/config/prismjs/mlem-commands.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,19 +1,21 @@ | ||
| module.exports = [ | ||
| 'init', | ||
| 'list', | ||
| 'pprint', | ||
| 'apply-remote', | ||
| 'apply', | ||
| 'build', | ||
| 'checkenv', | ||
| 'clone', | ||
| 'declare', | ||
| 'serve', | ||
| 'deployment apply', | ||
| 'deployment run', | ||
| 'deployment status', | ||
| 'deployment remove', | ||
| 'deployment wait', | ||
| 'deployment', | ||
| 'types', | ||
| 'link', | ||
| 'clone', | ||
| 'import', | ||
| 'build', | ||
| 'apply-remote', | ||
| 'apply' | ||
| 'init', | ||
| 'link', | ||
| 'pprint', | ||
| 'serve', | ||
| 'types', | ||
| 'ls' | ||
| ] |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
are subcommands meant to be included? If so...
Also not sure if order is important, i.e.:
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.
Yes, we would want subcommands as well to highlight them properly.
Can we do it organize the subcommands similarly to dvc.org (eg:
dvc data status) to ensure consistency and also it will provide better navigation on the sidebar?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.
Unlike DVC, atm it doesn't make sense for CML subcommands to have separate pages.
i.e. https://dvc.org/doc/command-reference/exp/init and https://dvc.org/doc/command-reference/exp/run are big enough to be on separate pages, but https://cml.dev/doc/ref/comment#create and https://cml.dev/doc/ref/comment#update should be on the same page - trying to separate them would harm reader experience.
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.
If we ensure consistency, it will be picked up by the GHA automation.
This seems to be a compromise we can work on(linking each other with a little more description) if we want to use the automation to generate the commands list upon addition.
In a long run, we want to have these commands listed on the consumer project themself instead of on the theme project (#134).
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.
what do you mean by "the GHA automation" - can you provide a link to some code/logic?
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.
This PR was generated by https://github.com/iterative/gatsby-theme-iterative/blob/main/.github/workflows/update-commands.yml.
The script basically gets all the commands from the sidebar.json from the respective tool's repository and updates the command list.