Skip to content
This repository was archived by the owner on Apr 23, 2025. It is now read-only.

Change how Bitbucket auth variables are shown #280

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

RCdeWit
Copy link
Contributor

@RCdeWit RCdeWit commented Jul 25, 2022

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.

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.
@shcheklein shcheklein temporarily deployed to cml-dev-bitbucket-auth--uu2nyh July 25, 2022 13:42 Inactive
@github-actions
Copy link

Link Check Report

There were no links to check!

@dacbd
Copy link
Contributor

dacbd commented Jul 28, 2022

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?

@jorgeorpinel
Copy link
Contributor

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.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants