BCDA-APS / bluesky_training

Bluesky training, including instrument package
https://bcda-aps.github.io/bluesky_training/
Other
11 stars 0 forks source link

DOC git advice for the reference section #131

Closed prjemian closed 1 year ago

prjemian commented 1 year ago

With a new account, the default git user and email are not set. These are the steps:

git config --global user.name "Lynn User"
git config --global user.email "YOUR_EMAIL"

At the same time, extend the interval when you don't have to retype your github credentials (a 1 hour period is shown):

git config credential.helper 'cache --timeout=3600'
prjemian commented 1 year ago

Seems to be a FAQ.

prjemian commented 1 year ago

Also for the git help document.

prjemian commented 1 year ago

Related to #141

prjemian commented 1 year ago

Ultimately, do not repeat what GitLab and GitHub provide online. Just point at that.

rodolakis commented 1 year ago

With a new account, the default git user and email are not set. These are the steps:

git config --global user.name "Lynn User"
git config --global user.email "YOUR_EMAIL"

The error message for this is very straightforward, give you those exact instructions. I don't think we need to explain this. Users should be able to handle it? (it is also easy to find the answer on google)

rodolakis commented 1 year ago

At the same time, extend the interval when you don't have to retype your github credentials (a 1 hour period is shown):

git config credential.helper 'cache --timeout=3600'

SSH keys allow you to establish a secure connection between your computer and GitLab/Hub, so you never have to authenticate (that is if you have used an SSH URL to clone a repository to your computer). I am thinking that authentification preferences and ssh vs https URLs might be outside of the scope of our documentation?