gitlab-org / gitlab

GitLab Docs & Support - gitlab-org/gitlab

GitLab Docs & Support

GitLab provides extensive documentation and support resources to help users and developers make the most of its features. Here are some of the options available:

GitLab Docs

GitLab Docs is the official documentation for GitLab, covering everything from installation and configuration to advanced features and development. The documentation is available in multiple formats, including online versions and offline archives.

Online documentation

The online documentation is available at https://docs.gitlab.com/archives/. This page has links to online versions of the GitLab documentation, including the default version, which is built from the documentation directories on the default branches of GitLab Omnibus, GitLab, GitLab Runner, GitLab Charts, and GitLab Operator.

The documentation is organized into several categories, including:

Offline documentation

The offline archives are available for download at https://about.gitlab.com/downloads/. They are available for various GitLab versions and can be browsed through locally.

Documentation Style Guide

The Documentation Style Guide defines the standards for GitLab documentation, including grammar, formatting, and more. It is available at https://docs.gitlab.com/ee/development/documentation/styleguide/.

Features inside the .gitlab/ directory

GitLab has implemented standard features that depend on configuration files in the .gitlab/ directory. The features include:

  • Issue Templates: .gitlab/issue_templates/
  • Merge request Templates: .gitlab/merge_request_templates/
  • GitLab agent: .gitlab/agents/
  • CODEOWNERS: .gitlab/CODEOWNERS
  • Route Maps: .gitlab/route-map.yml
  • Customize Auto DevOps Helm Values: .gitlab/auto-deploy-values.yaml
  • Insights: .gitlab/insights.yml
  • Service Desk Templates: .gitlab/service_desk_templates/
  • Secret Detection Custom Rulesets: .gitlab/secret-detection-ruleset.toml
  • Static Analysis Custom Rulesets: .gitlab/sast-ruleset.toml

Folder structure for documentation

The folder structure for documentation is available at https://docs.gitlab.com/ee/development/documentation/site_architecture/folder_structure.html. It includes:

  • doc/user/: Documentation for users.
  • doc/administration/: Documentation that requires the user to have access to the server where GitLab is installed.
  • doc/api/: Documentation for the API.
  • doc/development/: Documentation related to the development of GitLab, whether contributing code or documentation.
  • doc/legal/: Legal documents about contributing to GitLab.
  • doc/install/: Instructions for installing GitLab.
  • doc/update/: Instructions for updating GitLab.
  • doc/tutorials/: Tutorials for how to use GitLab.

Steps after installing GitLab

After installing GitLab, users can follow the steps at https://docs.gitlab.com/ee/install/next_steps.html to configure and use GitLab. The steps include:

  • Pricing: Pricing for the different tiers.
  • Cross-repository Code Search: Leverage Elasticsearch or OpenSearch for faster, more advanced code search across your entire GitLab instance.
  • Scaling and replication: Scaling GitLab and Geo replication.
  • Installing the product documentation: An optional step to host the documentation on your own server.

Tutorials

GitLab provides tutorials to help users get started with GitLab. The tutorials are available at https://docs.gitlab.com/ee/tutorials/.

Troubleshooting a GitLab installation

If users encounter issues with their GitLab installation, they can refer to the troubleshooting documentation at https://docs.gitlab.com/ee/administration/troubleshooting/.

Contribute to GitLab development

GitLab encourages community contributions to its development. The contributing documentation is available at https://docs.gitlab.com/ee/development/contributing/.

Support

GitLab provides support resources to help users and developers with their questions and issues. The support options are available at https://about.gitlab.com/support/.

GitLab Community Forum

The GitLab Community Forum is a place for users and developers to ask questions, share knowledge, and collaborate on GitLab. The forum is available at https://forum.gitlab.com/.

GitLab Issues

Users and developers can report issues and feature requests at https://gitlab.com/gitlab-org/gitlab/-/issues.

GitLab Support Ticket

GitLab offers paid support plans for its Enterprise Edition. Users can submit a support ticket at https://about.gitlab.com/support/.

GitLab Documentation Contributions

GitLab welcomes contributions to its documentation. The documentation contributions guidelines are available at https://docs.gitlab.com/ee/development/documentation/contributing/.

GitLab Documentation Feedback

Users can provide feedback on the documentation at https://gitlab.com/gitlab-org/gitlab/-/issues/new?issue[issue_type]=doc.

GitLab Documentation Translations

GitLab provides documentation translations for several languages. The translations are available at https://docs.gitlab.com/ee/development/documentation/translations/.

GitLab Documentation Mailing List

Users can join the GitLab documentation mailing list at https://groups.google.com/g/gitlab-docs.

GitLab Documentation Slack Channel

Users can join the GitLab documentation Slack channel at https://gitlab.com/gitlab-org/community-relations/-/wikis/home#gitlab-docs-team.

GitLab Documentation Style Guide

The GitLab documentation style guide is available at https://docs.gitlab.com/ee/development/documentation/styleguide/.

GitLab Documentation Code of Conduct

The GitLab documentation code of conduct is available at https://docs.gitlab.com/ee/development/documentation/code_of_conduct/.

GitLab Documentation License

The GitLab documentation is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International (CC BY-NC-SA 4.0) license. The license is available at https://creativecommons.org/licenses/by-nc-sa/4.0/.

GitLab Documentation Contributing Guide

The GitLab documentation contributing guide is available at https://docs.gitlab.com/ee/development/documentation/contributing/.

GitLab Documentation Changelog

The GitLab documentation changelog is available at https://docs.gitlab.com/ee/development/documentation/changelog/.

GitLab Documentation Versioning

The GitLab documentation versioning is available at https://docs.gitlab.com/ee/development/documentation/versioning/.