Documenting with GitLab Web IDE๏ƒ

Overview๏ƒ

This guide outlines the process for contributing to Read the Docs documentation projects, such as this one, via the GitLab Web IDE. To learn more about GitLab Web IDE visit the GitLab documentation pages.

Prerequisites๏ƒ

Before diving into this How-To, you should be acquainted with the following key areas and tools:

  1. Overview of Version control

  2. Git version control system basics

  3. Introduction to reStructuredText

  4. Libre Space Foundation contribution guide

  5. GitLab Merge Requests

Steps๏ƒ

Locate the page๏ƒ

  • Navigate to the page you intend to contribute improvements or changes to.

  • In the top right corner, locate and select the edit-on-gitlab link. This action redirects you to the pageโ€™s source code.

Edit the page๏ƒ

  • Press the gitlab-edit-button button, then choose Open in Web IDE to proceed with modifications.

  • Update the page content as needed. The Web IDE allows the editing of additional pages simultaneously.

Commit changes๏ƒ

  • To finalize edits, press Ctrl+Shift+G, or alternatively, click the gitlab-ide-source-control Source Control icon. This opens the Source Control panel, highlighting all modified files with an M indicator.

  • Compose a concise commit message that encapsulates your updates. Adhere to the LSF contribution guidelines: include a sign-off line post an empty line following your messageโ€™s subject or body.

  • Confirm your changes by clicking the dropdown on the gitlab-ide-commit-to button, opting for Commit to new branch from the available choices.

  • Assign a distinctive name to the new branch and confirm with Enter.

Create a Merge Request๏ƒ

  • A popup message will soon appear on the bottom left corner of the IDE prompting you with an option to initiate a merge request; select this to proceed.

  • The merge request form pre-populates with relevant details. Simply click gitlab-create-mr to move forward.

Evaluation and Reviewing๏ƒ

  • An automatic CI pipeline commences, evaluating the quality and integrity of your submitted changes.

  • Monitor the pipelineโ€™s progress. Address any detected issues by either updating your current branch or initiating a new merge request (MR).

  • Await a review of your contributions or proceed to self-merge, in alignment with the LSF merge request management protocols.

../_images/docs-with-gitlab-ide.gif