GitLab basics overhaul: command line basics

From @rdickenson's video teardown (https://www.youtube.com/watch?v=DglPwjs9XiA) of https://docs.gitlab.com/ee/gitlab-basics/command-line-commands.html, improve the command line basics page using the following notes:

• It could be thought that this covers GitLab CLI tools.
• Leaps into working on a project, gives no context on what this topic covers. The opening paragraph doesn't really match the title of the topic.
• Might need to mention pre-requisite knowledge required to read this topic. For example, knowing what a clone is.
• Screenshots are out of date.
• Minor grammatical issues.
• Gives the reader choices (SSH vs HTTPS) without really going into the pros and cons of either.
• Not prescriptive enough for beginners.
• In the On the command line section, we discuss commands that our audience is likely already familiar with. If they aren't familiar, they perhaps would use GUIs and GitLab UI.
• We mention cloning in two separate places.
• The first section has no stated outcome. What do you get when you "Start working on your project".
• Sample Git task flow seems out of place for an "Intro to GitLab Basics" section of the docs.
• Perhaps remove the topic altogether? We might already expect our audience to know 95% of this material.
• Or, create a workflow that uses all the commands in context.

Suggestions from video:

• Replace out of date screenshots.
• Fix grammar issues.
• Ensure instructions match current state of UI.
• Given it's a "basics" topic, perhaps go into detail on the SSH one that's easier after configuration.
• Add more introductory information.
• CLI commands should be introduced in context, rather than in a list.

@rdickenson, could you do any refactoring of the bullet lists here you think are neccessary?

Relates to: https://gitlab.com/gitlab-org/gitlab-ce/issues/59815.

CC @gl-docsteam

added docsimprovement documentation labels

marked this issue as related to #59815 (moved)

added to epic &1179

@eread My opinion of this content is that it should be deleted. If anyone wanting to use GitLab does not already know these basic CLI commands, they should be using either the GitLab UI or other graphical Git client. Content on either or both of those topics should be added elsewhere.

added devopscreate docs-only labels

added [deprecated] Accepting merge requests label

removed [deprecated] Accepting merge requests label

Hey!

GitLab is moving all development for both GitLab Community Edition and Enterprise Edition into a single codebase. The current gitlab-ce repository will become a read-only mirror, without any proprietary code. All development is moved to the current gitlab-ee repository, which we will rename to just gitlab in the coming weeks. As part of this migration, issues will be moved to the current gitlab-ee project.

If you have any questions about all of this, please ask them in our dedicated FAQ issue.

https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

You can also find more information here:

• https://gitlab.com/gitlab-org/gitlab-ee/issues/13304
• https://about.gitlab.com/2019/08/23/a-single-codebase-for-gitlab-community-and-enterprise-edition/

Frequently Asked Questions

For an up to date list of questions and answers, please take a look at https://gitlab.com/gitlab-org/gitlab-ee/issues/13855

What will we do with the repository names?

https://gitlab.com/gitlab-org/gitlab-ee/ will become https://gitlab.com/gitlab-org/gitlab, and https://gitlab.com/gitlab-org/gitlab-ce will become https://gitlab.com/gitlab-org/gitlab-foss.

Why rename gitlab-ce to gitlab-foss?

Using "gitlab" and "gitlab-ce" would be confusing, so we decided to rename gitlab-ce to gitlab-foss to make the purpose of this FOSS repository more clear

I created a merge requests for CE, and this got closed. What do I need to do?

You will need to create a merge request at https://gitlab.com/gitlab-org/gitlab-ee/. This link will eventually redirect to https://gitlab.com/gitlab-org/gitlab.

How does the licensing work in this new setup?

Everything in the ee/ directory is proprietary. Everything else is free and open source software. If your merge request does not change anything in the ee/ directory, the process of contributing changes is the same as when using the gitlab-ce repository.

Will you accept merge requests on the gitlab-ce/gitlab-foss project after it has been renamed?

No. Merge requests submitted to this project will be closed automatically.

Will I still be able to view old issues and merge requests in gitlab-ce/gitlab-foss?

Yes.

How will this affect users of GitLab CE using Omnibus?

No changes will be necessary, as the packages built remain the same.

How will this affect users of GitLab CE that build from source?

Once the project has been renamed, you will need to change your Git remotes to use this new URL. GitLab will take care of redirecting Git operations so there is no hard deadline, but we recommend doing this as soon as the projects have been renamed.

Where can I see a timeline of the remaining steps?

https://gitlab.com/gitlab-org/gitlab-ee/issues/13304

Will community contributions submitted to the new "gitlab" repository be available in the new gitlab-foss repository?

Yes, these changes will be synced to gitlab-foss automatically, several times per day.

locked this issue