cml.dev icon indicating copy to clipboard operation
cml.dev copied to clipboard

Change how Bitbucket auth variables are shown

Open RCdeWit opened this issue 3 years ago • 3 comments

While following the getting started docs for CML on Bitbucket, I ran into an issue because I generated the REPO_TOKEN incorrectly. I made a mistake while following echo -n $USERNAME:$PASSWORD | base64; left in the first $.

$USERNAME and $PASSWORD are not necessarily variables that are set when the user runs this command. Worst case, the local $USERNAME is different from the Bitbucket username.

I am not sure if my proposed solution is the ideal one, but earlier in this page we use {} to denote that the user should specify a variable here. Maybe we could use that approach here too.

RCdeWit avatar Jul 25 '22 13:07 RCdeWit

Link Check Report

There were no links to check!

github-actions[bot] avatar Jul 25 '22 13:07 github-actions[bot]

We should probably give other areas of the docs a scrub to be consistent, @jorgeorpinel do the DVC docs have a consistent format for this same type thing?

dacbd avatar Jul 28 '22 18:07 dacbd

Yes, we try to be consistent in general. Even in hypothetic metavars for remote modify param samples, for example. But it can be tricky. Probably worth it if someone is running into issues due to inconsistent formatting though.

jorgeorpinel avatar Jul 29 '22 08:07 jorgeorpinel