Skip to content
代码片段 群组 项目
未验证 提交 421c64da 编辑于 作者: Amy Qualls's avatar Amy Qualls 提交者: GitLab
浏览文件

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.
上级 de064faa
No related branches found
No related tags found
2 合并请求!3031Merge per-main-jh to main-jh by luzhiyuan,!3030Merge per-main-jh to main-jh
显示
24 个添加0 个删除
...@@ -43,6 +43,8 @@ Tutorials should be in this format: ...@@ -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") 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. A paragraph that explains what the tutorial does, and the expected outcome.
To create a website: To create a website:
...@@ -109,6 +111,7 @@ you can: ...@@ -109,6 +111,7 @@ you can:
- Add encouraging or congratulatory phrases after tasks. - Add encouraging or congratulatory phrases after tasks.
- Use future tense from time to time, especially when you're introducing - Use future tense from time to time, especially when you're introducing
steps. For example, `Next, you will associate your issues with your epics`. 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`. - Be more conversational. For example, `This task might take a while to complete`.
## Metadata ## Metadata
......
...@@ -5,6 +5,8 @@ info: For assistance with this tutorial, see https://handbook.gitlab.com/handboo ...@@ -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' 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 To run an Agile development iteration in GitLab, you use multiple GitLab features
that work together. that work together.
......
...@@ -22,6 +22,8 @@ This change is a breaking change. For more information, see the [migration guide ...@@ -22,6 +22,8 @@ This change is a breaking change. For more information, see the [migration guide
{{< /alert >}} {{< /alert >}}
<!-- vale gitlab_base.FutureTense = NO -->
You can use [compliance pipelines](../../user/compliance/compliance_pipelines.md) to ensure specific 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 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). to projects through [compliance frameworks](../../user/compliance/compliance_frameworks.md).
......
...@@ -5,6 +5,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -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' 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. 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. A runner is an agent in the GitLab Runner application that runs jobs in a GitLab CI/CD pipeline.
......
...@@ -12,6 +12,8 @@ title: 'Tutorial: Perform fuzz testing in GitLab' ...@@ -12,6 +12,8 @@ title: 'Tutorial: Perform fuzz testing in GitLab'
{{< /details >}} {{< /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 [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. your application for unstable behaviors and crashes.
......
...@@ -12,6 +12,8 @@ title: 'Tutorial: Install and secure a single node GitLab instance' ...@@ -12,6 +12,8 @@ title: 'Tutorial: Install and secure a single node GitLab instance'
{{< /details >}} {{< /details >}}
<!-- vale gitlab_base.FutureTense = NO -->
In this tutorial you will learn how to install and securely configure a single In this tutorial you will learn how to install and securely configure a single
node GitLab instance that can accommodate up to node GitLab instance that can accommodate up to
[20 RPS or 1,000 users](../../administration/reference_architectures/1k_users.md). [20 RPS or 1,000 users](../../administration/reference_architectures/1k_users.md).
......
...@@ -19,6 +19,8 @@ title: 'Tutorial: Use the left sidebar to navigate GitLab' ...@@ -19,6 +19,8 @@ title: 'Tutorial: Use the left sidebar to navigate GitLab'
{{< /history >}} {{< /history >}}
<!-- vale gitlab_base.FutureTense = NO -->
Follow this tutorial to learn how to use the new left sidebar to navigate the UI. Follow this tutorial to learn how to use the new left sidebar to navigate the UI.
## Layout of the left sidebar ## Layout of the left sidebar
......
...@@ -5,6 +5,8 @@ info: For assistance with this tutorial, see https://handbook.gitlab.com/handboo ...@@ -5,6 +5,8 @@ info: For assistance with this tutorial, see https://handbook.gitlab.com/handboo
title: 'Tutorial: Make your first Git commit' 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 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 you through the steps of creating your own project, editing a file, and
committing changes to a Git repository from the command line. committing changes to a Git repository from the command line.
......
...@@ -12,6 +12,8 @@ title: 'Tutorial: Set up your organization' ...@@ -12,6 +12,8 @@ title: 'Tutorial: Set up your organization'
{{< /details >}} {{< /details >}}
<!-- vale gitlab_base.FutureTense = NO -->
In GitLab, you set up and manage your company's GitLab organization by: In GitLab, you set up and manage your company's GitLab organization by:
- Creating groups, subgroups, and projects. - Creating groups, subgroups, and projects.
......
...@@ -16,6 +16,7 @@ For more information, see the history of the [**Distributed tracing** feature](. ...@@ -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. 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.SentenceSpacing = NO -->
<!-- vale gitlab_base.FutureTense = NO -->
## Before you begin ## Before you begin
......
...@@ -13,6 +13,8 @@ title: 'Tutorial: Set up product analytics in a GitLab Pages website project' ...@@ -13,6 +13,8 @@ title: 'Tutorial: Set up product analytics in a GitLab Pages website project'
{{< /details >}} {{< /details >}}
<!-- vale gitlab_base.FutureTense = NO -->
Understanding how your users engage with your website or application is important for making data-driven decisions. 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. By identifying the most and least used features by your users, your team can decide where and how to spend their time effectively.
......
...@@ -5,6 +5,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w ...@@ -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' title: 'Tutorial: Set up the Google Cloud integration'
--- ---
<!-- vale gitlab_base.FutureTense = NO -->
This tutorial shows you how to integrate Google Cloud with GitLab, This tutorial shows you how to integrate Google Cloud with GitLab,
so that you can deploy directly to Google Cloud. so that you can deploy directly to Google Cloud.
......
0% 加载中 .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册