Use verbose command line flags in empty repository instructions
Problem to solve
- To my knowledge, this issue affects all products.
- This issue affects the "Command line instructions" in projects with empty repositories
- I don't know which document this exactly is. I would be interested in that information.
- I would like to propose making all command line flags explicit for increased readability, especially to new users.
The current instructions use both abbreviated (e.g. c
) and verbose (e.g. --global
) command line flags:
Command line instructions
You can also upload existing files from your computer using the instructions below.
Git global setup
git config --global user.name "Bengt Lüers"
git config --global user.email "bengt.lueers@gmail.com"
Create a new repository
git clone git@gitlab.com:bengt/myproject.git
cd myproject
git switch -c main
touch README.md
git add README.md
git commit -m "add README"
git push -u origin main
Push an existing folder
cd existing_folder
git init --initial-branch=main
git remote add origin git@gitlab.com:bengt/myproject.git
git add .
git commit -m "Initial commit"
git push -u origin main
Push an existing Git repository
cd existing_repo
git remote rename origin old-origin
git remote add origin git@gitlab.com:bengt/myproject.git
git push -u origin --all
git push -u origin --tags
Further details
- The command line instructions are potentially one of the first bits of documentation new users of GitLab see.
- Therefore, GitLab should assume as little as possible prior knowledge from the users.
- A good solution will not negatively affect experienced users, who potentially create new projects with empty repositories routinely.
- The command line instructions are faced by all users when creating a "New project" after they choose "Create blank project".
Proposal
- I would like to propose to more consistently use verbose command line options in these instructions, like so:
Command line instructions
You can also upload existing files from your computer using the instructions below.
Git global setup
git config --global user.name "Bengt Lüers"
git config --global user.email "bengt.lueers@gmail.com"
Create a new repository
git clone git@gitlab.com:bengt/myproject.git
cd myproject
git switch --create main
touch README.md
git add README.md
git commit -m "add README"
git push --set-upstream origin main
Push an existing folder
cd existing_folder
git init --initial-branch=main
git remote add origin git@gitlab.com:bengt/myproject.git
git add .
git commit -m "Initial commit"
git push --set-upstream origin main
Push an existing Git repository
cd existing_repo
git remote rename origin old-origin
git remote add origin git@gitlab.com:bengt/myproject.git
git push --set-upstream origin --all
git push --set-upstream origin --tags
Who can address the issue
- I could create a pull request, if I knew which file I would need to edit.
Other links/references
- None
Edited by Bengt Lüers