From db1c1e2b3ecf87656bb288d25fcece597f177e42 Mon Sep 17 00:00:00 2001 From: Evan Read <eread@gitlab.com> Date: Tue, 12 Sep 2023 10:50:00 +1000 Subject: [PATCH] Remove trailing whitespace from documentation --- .../blueprints/cells/diagrams/index.md | 2 +- .../cells/impacted_features/ci-cd-catalog.md | 2 +- .../cells/impacted_features/personal-namespaces.md | 2 +- .../index.md | 4 ++-- doc/development/code_suggestions/index.md | 2 +- doc/user/profile/preferences.md | 14 +++++++------- 6 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/architecture/blueprints/cells/diagrams/index.md b/doc/architecture/blueprints/cells/diagrams/index.md index 77d1261281940..14db888382e13 100644 --- a/doc/architecture/blueprints/cells/diagrams/index.md +++ b/doc/architecture/blueprints/cells/diagrams/index.md @@ -22,7 +22,7 @@ Load the `.drawio.png` or `.drawio.svg` file directly into **draw.io**, which yo To create a diagram from a file: 1. Copy existing file and rename it. Ensure that the extension is `.drawio.png` or `.drawio.svg`. -1. Edit the diagram. +1. Edit the diagram. 1. Save the file. To create a diagram from scratch using [draw.io desktop](https://github.com/jgraph/drawio-desktop/releases): diff --git a/doc/architecture/blueprints/cells/impacted_features/ci-cd-catalog.md b/doc/architecture/blueprints/cells/impacted_features/ci-cd-catalog.md index f39de0a4072fb..3ca2ff042dce1 100644 --- a/doc/architecture/blueprints/cells/impacted_features/ci-cd-catalog.md +++ b/doc/architecture/blueprints/cells/impacted_features/ci-cd-catalog.md @@ -51,4 +51,4 @@ Today we can have multiple catalogs based on the number of namespaces, making it ### 4.2. Cons -- A separate catalog that surfaces components across Organizations would need to be implemented to serve the wider community (community catalog). This catalog will be required for GitLab.com only, later on we can evaluate if a similar catalog is needed for self-managed customers. +- A separate catalog that surfaces components across Organizations would need to be implemented to serve the wider community (community catalog). This catalog will be required for GitLab.com only, later on we can evaluate if a similar catalog is needed for self-managed customers. diff --git a/doc/architecture/blueprints/cells/impacted_features/personal-namespaces.md b/doc/architecture/blueprints/cells/impacted_features/personal-namespaces.md index 53d96ad92628a..55d974bb351bf 100644 --- a/doc/architecture/blueprints/cells/impacted_features/personal-namespaces.md +++ b/doc/architecture/blueprints/cells/impacted_features/personal-namespaces.md @@ -26,7 +26,7 @@ This is especially the case with the merge request, as it is one of the most com Today personal Namespaces serve two purposes that are mostly non-overlapping: -1. They provide a place for users to create personal Projects +1. They provide a place for users to create personal Projects that aren't expected to receive contributions from other people. This use case saves them from having to create a Group just for themselves. 1. They provide a default place for a user to put any forks they create when contributing to Projects where they don't have permission to push a branch. This again saves them from needing to create a Group just to store these forks. But the primary user need here is because they can't push branches to the upstream Project so they create a fork and contribute merge requests from the fork. diff --git a/doc/architecture/blueprints/container_registry_metadata_database_self_managed_rollout/index.md b/doc/architecture/blueprints/container_registry_metadata_database_self_managed_rollout/index.md index df9448309ce61..84a95e3e7c35d 100644 --- a/doc/architecture/blueprints/container_registry_metadata_database_self_managed_rollout/index.md +++ b/doc/architecture/blueprints/container_registry_metadata_database_self_managed_rollout/index.md @@ -74,7 +74,7 @@ quick reference for what features we have now, are planning, their statuses, and an excutive summary of the overall state of the migration experience. This could be advertised to self-managed users via a simple chart, allowing them to tell at a glance the status of this project and determine if it is feature- -complete enough for their needs and level of risk tolerance. +complete enough for their needs and level of risk tolerance. This should be documented in the container registry administration documentation, rather than in this blueprint. Providing this information there will place it in @@ -86,7 +86,7 @@ For example: The metadata database is in early beta for self-managed users. The core migration process for existing registries has been implemented, and online garbage collection -is fully implemented. Certain database enabled features are only enabled for GitLab.com +is fully implemented. Certain database enabled features are only enabled for GitLab.com and automatic database provisioning for the registry database is not available. Please see the table below for the status of features related to the container registry database. diff --git a/doc/development/code_suggestions/index.md b/doc/development/code_suggestions/index.md index 5bda95acb874b..9b94e9020ba17 100644 --- a/doc/development/code_suggestions/index.md +++ b/doc/development/code_suggestions/index.md @@ -8,7 +8,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w ## Code Suggestions development setup -The recommended setup for locally developing and debugging Code Suggestions is to have all 3 different components running: +The recommended setup for locally developing and debugging Code Suggestions is to have all 3 different components running: - IDE Extension (e.g. VSCode Extension) - Main application configured correctly diff --git a/doc/user/profile/preferences.md b/doc/user/profile/preferences.md index 233688e9bd1a5..4592422eee145 100644 --- a/doc/user/profile/preferences.md +++ b/doc/user/profile/preferences.md @@ -13,7 +13,7 @@ You can update your preferences to change the look and feel of GitLab. You can change the color theme of the GitLab UI. These colors are displayed on the left sidebar. Using individual color themes might help you differentiate between your different -GitLab instances. +GitLab instances. To change the color theme: @@ -25,7 +25,7 @@ To change the color theme: > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252) in GitLab 13.1 as an [Experiment](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/28252). -Dark mode makes elements on the GitLab UI stand out on a dark background. +Dark mode makes elements on the GitLab UI stand out on a dark background. - To turn on Dark mode, Select **Preferences > Color theme > Dark Mode**. @@ -44,11 +44,11 @@ To change the syntax highlighting theme: 1. In the **Syntax highlighting theme** section, select a theme. 1. Select **Save changes**. -To view the updated syntax highlighting theme, refresh your project's page. +To view the updated syntax highlighting theme, refresh your project's page. To customize the syntax highlighting theme, you can also [use the Application settings API](../../api/settings.md#list-of-settings-that-can-be-accessed-via-api-calls). Use `default_syntax_highlighting_theme` to change the syntax highlighting colors on a more granular level. -If these steps do not work, your programming language might not be supported by the syntax highlighters. +If these steps do not work, your programming language might not be supported by the syntax highlighters. For more information, view [Rouge Ruby Library](https://github.com/rouge-ruby/rouge) for guidance on code files and Snippets. View [Moncaco Editor](https://microsoft.github.io/monaco-editor/) and [Monarch](https://microsoft.github.io/monaco-editor/monarch.html) for guidance on the Web IDE. ## Change the diff colors @@ -59,7 +59,7 @@ To change the diff colors: 1. On the left sidebar, select your avatar. 1. Select **Preferences**. -1. Go to the **Diff colors** section. +1. Go to the **Diff colors** section. 1. Select a color or enter a color code. 1. Select **Save changes**. @@ -142,7 +142,7 @@ To render whitespace in the Web IDE: 1. Select the **Render whitespace characters in the Web IDE** checkbox. 1. Select **Save changes**. -You can view changes to whitespace in diffs. +You can view changes to whitespace in diffs. To view diffs on the Web IDE, follow these steps: @@ -315,7 +315,7 @@ To integrate with Gitpod: ### Integrate your GitLab instance with Sourcegraph -GitLab supports Sourcegraph integration for all public projects on GitLab. +GitLab supports Sourcegraph integration for all public projects on GitLab. To integrate with Sourcegraph: -- GitLab