Change how Bitbucket auth variables are shown #280
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
Link Check ReportThere were no links to check! |
|
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? |
|
Yes, we try to be consistent in general. Even in hypothetic metavars for |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
While following the getting started docs for CML on Bitbucket, I ran into an issue because I generated the
REPO_TOKENincorrectly. I made a mistake while followingecho -n $USERNAME:$PASSWORD | base64; left in the first$.$USERNAMEand$PASSWORDare not necessarily variables that are set when the user runs this command. Worst case, the local$USERNAMEis 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.