Update tool commands #117
Update tool commands #117
Conversation
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
rogermparent
temporarily deployed
to
gatsby-theme-main-cml-p-o1zorl
|
Nice. LGTM but we'd need to ask the product teams to confirm these are the publicly available commands now cc @dberenbaum |
Yes, they are already public. This PR is generated based on the |
|
Nothing looks very out of place to me, though I can't say I have a great base to confirm. If nothing else, the subcommands seem to all be in the right order! |
| 'pr', | ||
| 'comment', | ||
| 'check', | ||
| 'workflow', | ||
| 'tensorboard' |
There was a problem hiding this comment.
are subcommands meant to be included? If so...
| 'pr', | |
| 'comment', | |
| 'check', | |
| 'workflow', | |
| 'tensorboard' | |
| 'runner launch', | |
| 'pr', | |
| 'pr create', | |
| 'comment', | |
| 'comment create', | |
| 'comment update', | |
| 'check', | |
| 'check create', | |
| 'workflow', | |
| 'workflow rerun', | |
| 'tensorboard' | |
| 'tensorboard connect' |
Also not sure if order is important, i.e.:
| 'pr', | |
| 'comment', | |
| 'check', | |
| 'workflow', | |
| 'tensorboard' | |
| 'runner launch', | |
| 'runner', | |
| 'pr create', | |
| 'pr', | |
| 'comment create', | |
| 'comment update', | |
| 'comment', | |
| 'check create', | |
| 'check', | |
| 'workflow rerun', | |
| 'workflow', | |
| 'tensorboard connect' | |
| 'tensorboard' |
There was a problem hiding this comment.
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.
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.
If we ensure consistency, it will be picked up by the GHA automation.
createandupdateshould be on the same page - trying to separate them would harm reader experience.
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.
what do you mean by "the GHA automation" - can you provide a link to some code/logic?
There was a problem hiding this comment.
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.
Automated commits for 37b8a4f created by CML.