studio: Add DVC Studio commands to documentation #4981
Conversation
Integrated DVC Studio commands into the existing project documentation. These include the global command (`dvc studio`) and its subcommands (`dvc studio login`, `logout`, `token`). This update provides users with clearer instructions and reference on authorizing DVC with Studio and handling the token. It also enhances accessibility by updating the sidebar to include these new command references.
This commit refactors DVC Studio documentation by relocating the authorization instruction to a new 'studio login' subpage. It was necessary for providing more specific details about the command options and usage while maintaining the brevity of the index page. Additionally, the sidebar.json has been updated with the new command reference for user accessibility.
Introduced two new subpages in the existing DVC Studio documentation - 'studio logout' and 'studio token'. Both pages provide details about the usage and function of their respective commands. Updating the sidebar.json file ensures that these new subpages are correctly displayed on the website's navigation sidebar.
dberenbaum
added
the
⌛ status: wait-core-merge
Updated the description of 'usage' in the 'studio login' command documentation. Parameter descriptions have been changed to indicate clearly where values should be replaced by users. This simplifies the understanding and usage of these command line parameters.
Added a new section 'Available scopes' to DVC Studio's 'login' command reference documentation. The new scopes 'EXPERIMENTS', 'DATASETS', and 'MODELS' have been introduced to indicate operations available for each. This provides clarity to users on what operations they can execute within each scope.
| @@ -0,0 +1,37 @@ | |||
| # studio | |||
|
|
|||
| Set of commands to authorize DVC with Studio and save the token to global [DVC | |||
There was a problem hiding this comment.
let's review here in the code carefully if it's authorize or authenticate.
E.g. here https://cli.github.com/manual/gh_auth_login and here https://learn.microsoft.com/en-us/cli/azure/authenticate-azure-cli it is authenticate.
We should be careful about this terminology.
|
@yathomasi I thought we had a way to deploy forks after an approval, but I don't see it anymore? was it deleted? |
|
@amritghimire could you please create PR from a branch so it's deployed automatically? |
|
Closed in favor of #5015 |
Sorry, but we don't. The proper alternative as of now is to manually trigger it from the Heroku dashboard itself. We had a discussion and a ticket (#3970) without resolution. We can use the fix for running workflows using @0x2b3bfa0 trick: https://iterative.ai/blog/testing-external-contributions-using-github-actions-secrets, but we don't know a way to do that for Heroku deployments and Restyled. |
4 participants
❗ Please read the guidelines in the Contributing to the Documentation list if you make any substantial changes to the documentation or JS engine.
🐛 Please make sure to mention
Fix #issue(if applicable) in the description of the PR. This causes GitHub to close it automatically when the PR is merged.Please choose to allow us to edit your branch when creating the PR.
Add guides for dvc studio login feature introduced in dvc: treeverse/dvc#10074
Closes #4979