Project

General

Profile

Idea #21847

Updated by Brett Smith 6 months ago

I would find the "Get API Token" dialog nicer to use, and *easier to write documentation around*, if it was organized like this: 

 # Example @settings.conf@ 
 # "Copy to clipboard" button for @settings.conf@ 
 # Example shell to set environment variables 
 # "Copy to clipboard" button for shell (NOTE: the current button says "Copy link to clipboard" - that's weird since there is no link) 
 # Current token expiration time 
 # "Get new token" button that works as now 

 I have seen users copy the shell commands into @settings.conf@. This would eliminate that confusion. I think this also puts the functionality that users want most at the top of the dialog, and goes down from there. 

 The capitalization of the "Get API token" menu entry should match the capitalization of the "Get API Token" dialog title. 

 Our web documentation includes several walkthroughs of this dialog. When you change the dialog, you should update the documentation to match. 

 <pre>% git grep -li get.api.token doc 
 doc/user/cwl/arvados-vscode-training.html.md.liquid 
 doc/user/reference/api-tokens.html.textile.liquid 
 doc/user/topics/arv-copy.html.textile.liquid 
 </pre>

Back