diff --git a/doc/gitlab-basics/add-file.md b/doc/gitlab-basics/add-file.md index ca6af56b89d1aee988857c2ff0747af58981881a..51f418885f3384c507c6e302d4497745b0a16501 100644 --- a/doc/gitlab-basics/add-file.md +++ b/doc/gitlab-basics/add-file.md @@ -360,3 +360,4 @@ To merge changes from a local branch to a feature branch, follow this workflow. - [Add file from the UI](../user/project/repository/index.md#add-a-file-from-the-ui) - [Add file from the Web IDE](../user/project/repository/web_editor.md#upload-a-file) +- [Sign commits](../user/project/repository/signed_commits/gpg.md) diff --git a/doc/topics/git/branch.md b/doc/topics/git/branch.md index 189c3f193de3f343ed536f76eb871d4f3e55bbda..6853387d201cfb3d413f79acf58ad951719409ad 100644 --- a/doc/topics/git/branch.md +++ b/doc/topics/git/branch.md @@ -61,3 +61,8 @@ To update your branch with the latest changes in the default branch, either: - Run `git pull <remote-name> <default-branch-name>`. Use this command when you want your changes to appear in Git logs in chronological order with the changes from the default branch, or if you're sharing your branch with others. If you're unsure of the correct value for `<remote-name>`, run: `git remote`. + +## Related topics + +- [Branches](../../user/project/repository/branches/index.md) +- [Tags](../../user/project/repository/tags/index.md) diff --git a/doc/topics/git/index.md b/doc/topics/git/index.md index eed63c9f87618be25e71e1fcd843e10f06d90447..119471721bdae6432112611e55427f2aeab3c0a3 100644 --- a/doc/topics/git/index.md +++ b/doc/topics/git/index.md @@ -15,110 +15,14 @@ GitLab is built on top of (and with) Git, and provides you a Git-based, fully-in platform for software development. GitLab adds many powerful [features](https://about.gitlab.com/features/) on top of Git to enhance your workflow. -These resources can help you to get the best from using Git with GitLab. - -## Learn about Git - -New to Git? These resources can help you understand basic Git concepts before -you dive in: - -- [Git concepts](get_started.md) -- <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> - GitLab workflow video tutorial: [GitLab source code management walkthrough](https://www.youtube.com/watch?v=wTQ3aXJswtM) -- <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> - Git basics video tutorial: [Git-ing started with Git](https://www.youtube.com/watch?v=Ce5nz5n41z4) -- PDF download: [GitLab Git Cheat Sheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf) - -The official Git documentation also offers information on -[Git basics](https://git-scm.com/book/en/v2/Getting-Started-Git-Basics). - -## Begin using Git - -After you learn how Git works, you're ready to try it out. These resources are -appropriate for when you're ready to start learning Git by doing: - -- [How to install Git](how_to_install_git/index.md) -- Tutorial: [Make your first Git commit](../../tutorials/make_first_git_commit/index.md) -- Tutorial: [Update Git commit messages](../../tutorials/update_commit_messages/index.md) -- The [GitLab CLI](https://gitlab.com/gitlab-org/cli/) - -A typical Git user encounters these concepts soon after starting to use Git: - -- [`git add`](../../gitlab-basics/add-file.md) to start tracking files with Git. -- [Tags](../../user/project/repository/tags/index.md) and - [branches](../../user/project/repository/branches/index.md). -- [How to undo changes](undo.md), including `git reset`. -- View a chronological list of changes to a file with - [Git history](../../user/project/repository/files/git_history.md). -- View a line-by-line editing history of a file with - [`git blame`](../../user/project/repository/files/git_blame.md). -- [Sign commits](../../user/project/repository/signed_commits/gpg.md) - for increased accountability and trust. - -## Learn more complex commands - -When you're comfortable with basic Git commands, you're ready to dive into the -more complex features of Git. These commands aren't required when creating -straightforward changes. When you begin managing multiple branches or need more complex -change management, you're ready for these features: - -- To stop tracking changes to a file, because you don't want to commit them, - [unstage the changes](undo.md). -- [Stash your changes](../../gitlab-basics/add-file.md) when your current work isn't ready to create a commit locally, - but you need to switch branches to work on something else. -- If you create many small commits locally, you can use - [squash and merge](../../user/project/merge_requests/squash_and_merge.md) - to combine them into fewer commits before pushing them. -- [Cherry-pick](../../user/project/merge_requests/cherry_pick_changes.md) the contents - of a commit from one branch to another. -- [Revert an existing commit](../../user/project/merge_requests/revert_changes.md#revert-a-commit) - if it contains changes you no longer want. - -## Learn branching and workflow strategies - -When you're comfortable with the creation and handling of individual branches, -you're ready to learn about Git workflows and branching strategies: - -- [Feature branch workflow](../../gitlab-basics/feature_branch_workflow.md) -- [Introduction to Git rebase, force-push, and merge conflicts](git_rebase.md) -- [GitLab Flow](https://about.gitlab.com/topics/version-control/what-is-gitlab-flow/) - - [GitLab Flow best practices](https://about.gitlab.com/topics/version-control/what-are-gitlab-flow-best-practices/) -- From the official Git documentation: - - [Git Branching - Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell) - - [Git Branching - Branching Workflows](https://git-scm.com/book/en/v2/Git-Branching-Branching-Workflows) - -## Learn advanced topics in Git management - -Git and GitLab, combined together, provide advanced features for repository management: - -- Enforce commit policies and run tasks with [Git server hooks](../../administration/server_hooks.md). -- Define which file types to treat as binary, and set the languages to use for - syntax highlighting with [the `.gitattributes` file](../../user/project/git_attributes.md). -- To keep a Git repository as a subdirectory in another repository, - [use Git submodules with GitLab CI](../../ci/git_submodules.md). -- When working with extremely large repositories, you can use a [partial clone](partial_clone.md) - of a repository instead of a complete clone. -- GitLab APIs for [`.gitignore` files](../../api/templates/gitignores.md), - [commits](../../api/commits.md), [tags](../../api/tags.md), - and [repositories](../../api/repositories.md). - -### Git Large File Storage (LFS) - -Many Git projects must manage large binary assets, such as videos and images. -Implementing [Git Large File Storage](https://git-lfs.com) can help manage these assets while keeping -your repository small: - -- [User documentation](lfs/index.md) for Git LFS at GitLab -- [Administrator documentation](../../administration/lfs/index.md) for Git LFS at GitLab -- Blog post: [Getting Started with Git LFS](https://about.gitlab.com/blog/2017/01/30/getting-started-with-git-lfs-tutorial/) -- [Migrate an existing Git repository](lfs/index.md#migrate-an-existing-repository-to-git-lfs) to Git LFS -- [Stop tracking a file](lfs/index.md#stop-tracking-a-file-with-git-lfs) with Git LFS -- Blog post: [Towards a production-quality open source Git LFS server](https://about.gitlab.com/blog/2015/08/13/towards-a-production-quality-open-source-git-lfs-server/) - -## Related topics - -- Official [Git documentation](https://git-scm.com), including - [Git on the Server - GitLab](https://git-scm.com/book/en/v2/Git-on-the-Server-GitLab) -- [Git troubleshooting](troubleshooting_git.md) techniques -- Blog post: [Git Tips & Tricks](https://about.gitlab.com/blog/2016/12/08/git-tips-and-tricks/) -- Blog post: [Eight Tips to help you work better with Git](https://about.gitlab.com/blog/2015/02/19/8-tips-to-help-you-work-better-with-git/) +- [Get started](get_started.md) +- [Install Git](how_to_install_git/index.md) +- [Tutorial: Create your first commit](../../tutorials/make_first_git_commit/index.md) +- [Clone a repository to your local machine](clone.md) +- [Create a branch for your changes](branch.md) +- [Add files and make changes](../../gitlab-basics/add-file.md) +- [Undo changes](undo.md) +- [Tutorial: Update Git commit messages](../../tutorials/update_commit_messages/index.md) +- [Common Git commands](../../gitlab-basics/start-using-git.md) +- [Rebase and force-push](git_rebase.md) +- [Troubleshooting](troubleshooting_git.md) diff --git a/doc/topics/git/undo.md b/doc/topics/git/undo.md index e053d1a4614836fbe6c3f33cff4cb01bb0ffca04..23a9a15d77a7ec37ba955409e4f5f2adfbfbb624 100644 --- a/doc/topics/git/undo.md +++ b/doc/topics/git/undo.md @@ -573,16 +573,10 @@ git checkout -- <file> git rm <filename> --cache ``` -<!-- ## Troubleshooting +## Related topics -Include any troubleshooting steps that you can foresee. If you know beforehand what issues -one might have when setting this up, or when something is changed, or on upgrading, it's -important to describe those, too. Think of things that may go wrong and include them here. -This is important to minimize requests for support, and to avoid doc comments with -questions that you know someone might ask. - -Each scenario can be a third-level heading, for example `### Getting error message X`. -If you have none to add when creating a doc, leave this section in place -but commented out to help encourage others to add to it in the future. --> - -<!-- Identifiers, in alphabetical order --> +- [`git blame`](../../user/project/repository/files/git_blame.md) +- [Cherry-pick](../../user/project/merge_requests/cherry_pick_changes.md) +- [Git history](../../user/project/repository/files/git_history.md) +- [Revert an existing commit](../../user/project/merge_requests/revert_changes.md#revert-a-commit) +- [Squash and merge](../../user/project/merge_requests/squash_and_merge.md) diff --git a/doc/tutorials/learn_git.md b/doc/tutorials/learn_git.md index a8333734982409195efe46a2158f1874e95fe5aa..29f1b99883c3982ea111c3b7b7c9d0c6de8456ed 100644 --- a/doc/tutorials/learn_git.md +++ b/doc/tutorials/learn_git.md @@ -17,3 +17,5 @@ the most out of GitLab. | [Take advantage of Git rebase](https://about.gitlab.com/blog/2022/10/06/take-advantage-of-git-rebase/) | Learn how to use the `rebase` command in your workflow. | | | [Update Git commit messages](update_commit_messages/index.md) | Learn how to update commit messages and push the changes to GitLab. | | | [Git cheat sheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf) | Download a PDF of common Git commands. | | +| [Git-ing started with Git](https://www.youtube.com/watch?v=Ce5nz5n41z4) | Git basics video tutorial. | | +| [GitLab source code management walkthrough](https://www.youtube.com/watch?v=wTQ3aXJswtM) | GitLab workflow video tutorial. | | diff --git a/doc/tutorials/make_first_git_commit/index.md b/doc/tutorials/make_first_git_commit/index.md index c95cabfe7f25d83e97837e0491c6176f2c795bb9..e8b55d784cdbff2df5daaf5765c0249fef3d2971 100644 --- a/doc/tutorials/make_first_git_commit/index.md +++ b/doc/tutorials/make_first_git_commit/index.md @@ -274,3 +274,8 @@ Nice work. - Get a complete introduction to Git in the <i class="fa fa-youtube-play youtube" aria-hidden="true"></i> [Git for GitLab](https://www.youtube.com/watch?v=4lxvVj7wlZw) beginner's course (1h 33m). - Find other tutorials about Git and GitLab on the [tutorials page](../index.md). +- PDF download: [GitLab Git Cheat Sheet](https://about.gitlab.com/images/press/git-cheat-sheet.pdf). +- Blog post: [Git Tips & Tricks](https://about.gitlab.com/blog/2016/12/08/git-tips-and-tricks/). +- Blog post: [Eight Tips to help you work better with Git](https://about.gitlab.com/blog/2015/02/19/8-tips-to-help-you-work-better-with-git/). +- Official [Git documentation](https://git-scm.com), including + [Git on the Server - GitLab](https://git-scm.com/book/en/v2/Git-on-the-Server-GitLab).