Skip to content

Create new project from command line docs improvements

Problem

The Create a project from the command line guidance presented on the "create new project" flow offers the following command

image

git push --set-upstream git@gitlab.com:danielgruesso/$(git rev-parse --show-toplevel | xargs basename).git $(git rev-parse --abbrev-ref HEAD)

However, the docs for the "Push to create a new project" feature contain the following commands:

## Git push using SSH
git push --set-upstream git@gitlab.example.com:namespace/nonexistent-project.git master

## Git push using HTTPS
git push --set-upstream https://gitlab.example.com/namespace/nonexistent-project.git master

The following high level problems are present:

  1. The commands presented are different in the app vs docs
  2. The "what does this command do?" link takes user to docs that don't actually explain what the command does, instead it simply instructs on how to create a new project from the command line
  3. For new users, instructing them to push via SSH has pre-reqs, this is not stated in the docs
  4. For new users, instructing them to push via HTTPS requires them to know their namespace, docs don't indicate how to obtain it
  5. Docs don't indicate how to name the project, seasoned users can infer that nonexistent-project.git will be the new name, but this will be harder for new users

Proposal

  1. Use the same commands in-app and in-docs
  2. Consider a "step by step" approach to instructions. Current docs assume user will know to open terminal, setup ssh, etc.
  3. Add a section that breaks down the command and what is doing
  4. Add section on how to create projects on a group vs personal namespace

Further info

Edited by Daniel Gruesso