From 421c64da4141dc38ba986f11649f9776378d022f Mon Sep 17 00:00:00 2001
From: Amy Qualls <aqualls@gitlab.com>
Date: Wed, 12 Mar 2025 15:51:06 -0700
Subject: [PATCH] Add expectation of disabling FutureTense rule
Tutorials use future tense, so let's build in the expectation that
we will turn off alerts for future tense on those pages.
---
doc/development/documentation/topic_types/tutorial.md | 3 +++
doc/tutorials/agile_sprint/_index.md | 2 ++
doc/tutorials/compliance_pipeline/_index.md | 2 ++
doc/tutorials/create_register_first_runner/_index.md | 2 ++
doc/tutorials/fuzz_testing/_index.md | 2 ++
doc/tutorials/install_gitlab_single_node/_index.md | 2 ++
doc/tutorials/left_sidebar/_index.md | 2 ++
doc/tutorials/make_first_git_commit/_index.md | 2 ++
doc/tutorials/manage_user/_index.md | 2 ++
doc/tutorials/observability/observability_django_tutorial.md | 1 +
.../product_analytics_onboarding_website_project/_index.md | 2 ++
doc/tutorials/set_up_gitlab_google_integration/_index.md | 2 ++
12 files changed, 24 insertions(+)
diff --git a/doc/development/documentation/topic_types/tutorial.md b/doc/development/documentation/topic_types/tutorial.md
index 95fe65a4d8a0c..93ca4af8f816e 100644
--- a/doc/development/documentation/topic_types/tutorial.md
+++ b/doc/development/documentation/topic_types/tutorial.md
@@ -43,6 +43,8 @@ Tutorials should be in this format:
title: Title (starts with "Tutorial:" followed by an active verb, like "Tutorial: Create a website")
---
+<!-- vale gitlab_base.FutureTense = NO -->
+
A paragraph that explains what the tutorial does, and the expected outcome.
To create a website:
@@ -109,6 +111,7 @@ you can:
- Add encouraging or congratulatory phrases after tasks.
- Use future tense from time to time, especially when you're introducing
steps. For example, `Next, you will associate your issues with your epics`.
+ Disable the Vale rule `gitlab_base.FutureTense` to avoid false positives.
- Be more conversational. For example, `This task might take a while to complete`.
## Metadata
diff --git a/doc/tutorials/agile_sprint/_index.md b/doc/tutorials/agile_sprint/_index.md
index d384c8b72e89f..5fafe685910c6 100644
--- a/doc/tutorials/agile_sprint/_index.md
+++ b/doc/tutorials/agile_sprint/_index.md
@@ -5,6 +5,8 @@ info: For assistance with this tutorial, see https://handbook.gitlab.com/handboo
title: 'Tutorial: Use GitLab to run an Agile iteration'
---
+<!-- vale gitlab_base.FutureTense = NO -->
+
To run an Agile development iteration in GitLab, you use multiple GitLab features
that work together.
diff --git a/doc/tutorials/compliance_pipeline/_index.md b/doc/tutorials/compliance_pipeline/_index.md
index 885e3922a62af..43fa58774f1da 100644
--- a/doc/tutorials/compliance_pipeline/_index.md
+++ b/doc/tutorials/compliance_pipeline/_index.md
@@ -22,6 +22,8 @@ This change is a breaking change. For more information, see the [migration guide
{{< /alert >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
You can use [compliance pipelines](../../user/compliance/compliance_pipelines.md) to ensure specific
compliance-related jobs are run on pipelines for all projects in a group. Compliance pipelines are applied
to projects through [compliance frameworks](../../user/compliance/compliance_frameworks.md).
diff --git a/doc/tutorials/create_register_first_runner/_index.md b/doc/tutorials/create_register_first_runner/_index.md
index 050210e3ea5f9..9f2a59a5ce7ab 100644
--- a/doc/tutorials/create_register_first_runner/_index.md
+++ b/doc/tutorials/create_register_first_runner/_index.md
@@ -5,6 +5,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
title: 'Tutorial: Create, register, and run your own project runner'
---
+<!-- vale gitlab_base.FutureTense = NO -->
+
This tutorial shows you how to configure and run your first runner in GitLab.
A runner is an agent in the GitLab Runner application that runs jobs in a GitLab CI/CD pipeline.
diff --git a/doc/tutorials/fuzz_testing/_index.md b/doc/tutorials/fuzz_testing/_index.md
index 85d0a152f6fb5..5ab74f99b69a4 100644
--- a/doc/tutorials/fuzz_testing/_index.md
+++ b/doc/tutorials/fuzz_testing/_index.md
@@ -12,6 +12,8 @@ title: 'Tutorial: Perform fuzz testing in GitLab'
{{< /details >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
[Coverage-guided fuzz testing](../../user/application_security/coverage_fuzzing/_index.md#coverage-guided-fuzz-testing-process) sends unexpected, malformed, or random data to your application, and then monitors
your application for unstable behaviors and crashes.
diff --git a/doc/tutorials/install_gitlab_single_node/_index.md b/doc/tutorials/install_gitlab_single_node/_index.md
index a3316cd702b2b..903dd44b5550e 100644
--- a/doc/tutorials/install_gitlab_single_node/_index.md
+++ b/doc/tutorials/install_gitlab_single_node/_index.md
@@ -12,6 +12,8 @@ title: 'Tutorial: Install and secure a single node GitLab instance'
{{< /details >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
In this tutorial you will learn how to install and securely configure a single
node GitLab instance that can accommodate up to
[20 RPS or 1,000 users](../../administration/reference_architectures/1k_users.md).
diff --git a/doc/tutorials/left_sidebar/_index.md b/doc/tutorials/left_sidebar/_index.md
index d516cd8d417ac..bbdf4577978a4 100644
--- a/doc/tutorials/left_sidebar/_index.md
+++ b/doc/tutorials/left_sidebar/_index.md
@@ -19,6 +19,8 @@ title: 'Tutorial: Use the left sidebar to navigate GitLab'
{{< /history >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
Follow this tutorial to learn how to use the new left sidebar to navigate the UI.
## Layout of the left sidebar
diff --git a/doc/tutorials/make_first_git_commit/_index.md b/doc/tutorials/make_first_git_commit/_index.md
index db11832bb23a9..9545b59f94a4c 100644
--- a/doc/tutorials/make_first_git_commit/_index.md
+++ b/doc/tutorials/make_first_git_commit/_index.md
@@ -5,6 +5,8 @@ info: For assistance with this tutorial, see https://handbook.gitlab.com/handboo
title: 'Tutorial: Make your first Git commit'
---
+<!-- vale gitlab_base.FutureTense = NO -->
+
This tutorial will teach you a little bit about how Git works. It walks
you through the steps of creating your own project, editing a file, and
committing changes to a Git repository from the command line.
diff --git a/doc/tutorials/manage_user/_index.md b/doc/tutorials/manage_user/_index.md
index b116f7e74020c..e9a91c9a5f893 100644
--- a/doc/tutorials/manage_user/_index.md
+++ b/doc/tutorials/manage_user/_index.md
@@ -12,6 +12,8 @@ title: 'Tutorial: Set up your organization'
{{< /details >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
In GitLab, you set up and manage your company's GitLab organization by:
- Creating groups, subgroups, and projects.
diff --git a/doc/tutorials/observability/observability_django_tutorial.md b/doc/tutorials/observability/observability_django_tutorial.md
index a63ce1f171968..589469c1f634e 100644
--- a/doc/tutorials/observability/observability_django_tutorial.md
+++ b/doc/tutorials/observability/observability_django_tutorial.md
@@ -16,6 +16,7 @@ For more information, see the history of the [**Distributed tracing** feature](.
In this tutorial, we'll show you how to create, configure, instrument, and monitor a Django application using GitLab observability features.
<!-- vale gitlab_base.SentenceSpacing = NO -->
+<!-- vale gitlab_base.FutureTense = NO -->
## Before you begin
diff --git a/doc/tutorials/product_analytics_onboarding_website_project/_index.md b/doc/tutorials/product_analytics_onboarding_website_project/_index.md
index 2268fb7272876..5d6b53b429b4c 100644
--- a/doc/tutorials/product_analytics_onboarding_website_project/_index.md
+++ b/doc/tutorials/product_analytics_onboarding_website_project/_index.md
@@ -13,6 +13,8 @@ title: 'Tutorial: Set up product analytics in a GitLab Pages website project'
{{< /details >}}
+<!-- vale gitlab_base.FutureTense = NO -->
+
Understanding how your users engage with your website or application is important for making data-driven decisions.
By identifying the most and least used features by your users, your team can decide where and how to spend their time effectively.
diff --git a/doc/tutorials/set_up_gitlab_google_integration/_index.md b/doc/tutorials/set_up_gitlab_google_integration/_index.md
index f6e15646229dd..30c2545efa0f9 100644
--- a/doc/tutorials/set_up_gitlab_google_integration/_index.md
+++ b/doc/tutorials/set_up_gitlab_google_integration/_index.md
@@ -5,6 +5,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w
title: 'Tutorial: Set up the Google Cloud integration'
---
+<!-- vale gitlab_base.FutureTense = NO -->
+
This tutorial shows you how to integrate Google Cloud with GitLab,
so that you can deploy directly to Google Cloud.
--
GitLab