Skip to content

Commit e7e308f

Browse files
amyqeread
authored andcommitted
Handle more spelling exceptions
Tackle another round of exceptions to the spelling rule. Most of these needed one-off exclusions.
1 parent dd37ba7 commit e7e308f

11 files changed

Lines changed: 38 additions & 27 deletions

File tree

doc/.vale/gitlab/spelling-exceptions.txt

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ Anthos
1616
approvers
1717
architected
1818
architecting
19+
archiver
1920
Arel
2021
Artifactory
2122
Asana
@@ -183,6 +184,7 @@ failsafe
183184
Falco
184185
falsy
185186
fastlane
187+
Fastzip
186188
favicon
187189
favorited
188190
Figma
@@ -200,6 +202,8 @@ fuzzer
200202
Gantt
201203
Gemnasium
202204
Gemojione
205+
Getter
206+
Getters
203207
gettext
204208
Git
205209
Gitaly

doc/architecture/blueprints/graphql_api/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ this knowledge onto GraphQL and make it performant and secure by default.
113113
- Design direct uploads for GraphQL
114114
- Build GraphQL query depth and complexity histograms
115115
- Visualize the amount of GraphQL queries reaching limits
116-
- Add support for GraphQL etags for existing features
116+
- Add support for GraphQL ETags for existing features
117117

118118
### Design GraphQL interoperability with REST API
119119

@@ -138,7 +138,7 @@ state synchronization mechanisms and hooking into existing ones.
138138

139139
- Design a scalable state synchronization mechanism
140140
- Evaluate state synchronization through pub/sub and websockets
141-
- Build a generic support for GraphQL feature correlation and feature etags
141+
- Build a generic support for GraphQL feature correlation and feature ETags
142142
- Redesign frontend code responsible for managing shared global state
143143

144144
## Iterations

doc/ci/runners/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ On GitLab.com, you cannot override the job timeout for shared runners and must u
280280
To set the maximum job timeout:
281281

282282
1. In a project, go to **Settings > CI/CD > Runners**.
283-
1. Select your specific runner to edit the settings.
283+
1. Select your specific runner to edit the settings.
284284
1. Enter a value under **Maximum job timeout**.
285285
1. Select **Save changes**.
286286

@@ -844,5 +844,5 @@ variables:
844844
| Variable | Description |
845845
|---------------------------------|--------------------------------------------------------|
846846
| `TRANSFER_METER_FREQUENCY` | Specify how often to print the meter's transfer rate. It can be set to a duration (for example, `1s` or `1m30s`). A duration of `0` disables the meter (default). When a value is set, the pipeline shows a progress meter for artifact and cache uploads and downloads. |
847-
| `ARTIFACT_COMPRESSION_LEVEL` | To adjust compression ratio, set to `fastest`, `fast`, `default`, `slow`, or `slowest`. This setting works with the fastzip archiver only, so the GitLab Runner feature flag [`FF_USE_FASTZIP`](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags) must also be enabled. |
848-
| `CACHE_COMPRESSION_LEVEL` | To adjust compression ratio, set to `fastest`, `fast`, `default`, `slow`, or `slowest`. This setting works with the fastzip archiver only, so the GitLab Runner feature flag [`FF_USE_FASTZIP`](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags) must also be enabled. |
847+
| `ARTIFACT_COMPRESSION_LEVEL` | To adjust compression ratio, set to `fastest`, `fast`, `default`, `slow`, or `slowest`. This setting works with the Fastzip archiver only, so the GitLab Runner feature flag [`FF_USE_FASTZIP`](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags) must also be enabled. |
848+
| `CACHE_COMPRESSION_LEVEL` | To adjust compression ratio, set to `fastest`, `fast`, `default`, `slow`, or `slowest`. This setting works with the Fastzip archiver only, so the GitLab Runner feature flag [`FF_USE_FASTZIP`](https://docs.gitlab.com/runner/configuration/feature-flags.html#available-feature-flags) must also be enabled. |

doc/development/fe_guide/design_anti_patterns.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w
99
Anti-patterns may seem like good approaches at first, but it has been shown that they bring more ills than benefits. These should
1010
generally be avoided.
1111

12-
Throughout the GitLab codebase, there may be historic uses of these anti-patterns. Please [use descretion](https://about.gitlab.com/handbook/engineering/#balance-refactoring-and-velocity)
12+
Throughout the GitLab codebase, there may be historic uses of these anti-patterns. Please [use discretion](https://about.gitlab.com/handbook/engineering/#balance-refactoring-and-velocity)
1313
when figuring out whether or not to refactor, when touching code that uses one of these legacy patterns.
1414

1515
**Please note:** For new features, anti-patterns are not necessarily prohibited, but it is **strongly suggested** to find another approach.
@@ -45,7 +45,7 @@ the convenience does not always outweigh their heavy cost:
4545
- **No access control.** When Shared Global Objects manage some state, this can create some very buggy and difficult
4646
coupling situations because there is no access control to this object.
4747
- **Possible circular references.** Shared Global Objects can also create some circular referencing situations since submodules
48-
of the Shared Global Object can reference modules that reference itself (see
48+
of the Shared Global Object can reference modules that reference itself (see
4949
[this MR for an example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/33366)).
5050

5151
Here are some historic examples where this pattern was identified to be problematic:
@@ -72,7 +72,7 @@ To read more on this topic, check out the following references:
7272

7373
## Singleton (Anti-pattern)
7474

75-
The classic [Singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern) is an approach to ensure that only one
75+
The classic [Singleton pattern](https://en.wikipedia.org/wiki/Singleton_pattern) is an approach to ensure that only one
7676
instance of a thing exists.
7777

7878
Here's an example of this pattern:
@@ -114,7 +114,7 @@ Here are some ills that Singletons often produce:
114114

115115
1. **Non-deterministic tests.** Singletons encourage non-deterministic tests because the single instance is shared across
116116
individual tests, often causing the state of one test to bleed into another.
117-
1. **High coupling.** Under the hood, clients of a singleton class all share a single specific
117+
1. **High coupling.** Under the hood, clients of a singleton class all share a single specific
118118
instance of an object, which means this pattern inherits all the [problems of Shared Global Object](#what-problems-do-shared-global-objects-cause)
119119
such as no clear ownership and no access control. These leads to high coupling situations that can
120120
be buggy and difficult to untangle.
@@ -174,13 +174,13 @@ export const fuzzify = (id) => { /* ... */ };
174174
#### Dependency Injection
175175

176176
[Dependency Injection](https://en.wikipedia.org/wiki/Dependency_injection) is an approach which breaks
177-
coupling by declaring a module's dependencies to be injected from outside the module (e.g., through constructor parameters, a bon-a-fide Dependency Injection framework, and even Vue's `provide/inject`).
177+
coupling by declaring a module's dependencies to be injected from outside the module (e.g., through constructor parameters, a bona-fide Dependency Injection framework, and even Vue's `provide/inject`).
178178

179179
```javascript
180180
// bad - Vue component coupled to Singleton
181181
export default {
182182
created() {
183-
this.mediator = MyFooMediator.getInstance();
183+
this.mediator = MyFooMediator.getInstance();
184184
},
185185
};
186186

@@ -194,7 +194,7 @@ export default {
194194
// bad - We're not sure where the singleton is in it's lifecycle so we init it here.
195195
export class Foo {
196196
constructor() {
197-
Bar.getInstance().init();
197+
Bar.getInstance().init();
198198
}
199199

200200
stuff() {

doc/development/fe_guide/index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@ across the GitLab frontend team.
1212
## Overview
1313

1414
GitLab is built on top of [Ruby on Rails](https://rubyonrails.org). It uses [Haml](https://haml.info/) and a JavaScript0based frontend with [Vue.js](https://vuejs.org).
15-
Be wary of [the limitations that come with using Hamlit](https://github.com/k0kubun/hamlit/blob/master/REFERENCE.md#limitations). We also use [SCSS](https://sass-lang.com) and plain JavaScript with
15+
<!-- vale gitlab.Spelling = NO -->
16+
Be wary of [the limitations that come with using Hamlit](https://github.com/k0kubun/hamlit/blob/master/REFERENCE.md#limitations).
17+
<!-- vale gitlab.Spelling = YES -->
18+
We also use [SCSS](https://sass-lang.com) and plain JavaScript with
1619
modern ECMAScript standards supported through [Babel](https://babeljs.io/) and ES module support through [webpack](https://webpack.js.org/).
1720

1821
Working with our frontend assets requires Node (v10.13.0 or greater) and Yarn

doc/development/fe_guide/performance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,7 +219,7 @@ Use the following rules when creating real-time solutions.
219219
1. A response with HTTP status different from 2XX should disable polling as well.
220220
1. Use a common library for polling.
221221
1. Poll on active tabs only. Please use [Visibility](https://github.com/ai/visibilityjs).
222-
1. Use regular polling intervals, do not use backoff polling, or jitter, as the interval is
222+
1. Use regular polling intervals, do not use <!-- vale gitlab.Spelling = NO --> backoff polling <!-- vale gitlab.Spelling = YES --> or jitter, as the interval is
223223
controlled by the server.
224224
1. The backend code is likely to be using ETags. You do not and should not check for status
225225
`304 Not Modified`. The browser transforms it for you.

doc/development/fe_guide/style/javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ In addition to the style guidelines set by Airbnb, we also have a few specific r
1414
listed below.
1515

1616
NOTE:
17-
You can run eslint locally by running `yarn eslint`
17+
You can run ESLint locally by running `yarn eslint`
1818

1919
## Avoid forEach
2020

doc/development/fe_guide/style/scss.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ easy to maintain, and performant for the end-user.
1212

1313
## Rules
1414

15-
Our CSS is a mixture of current and legacy approaches. That means sometimes it may be difficult to follow this guide to the letter; it means you are likely to run into exceptions, where following the guide is difficult to impossible without outsized effort. In those cases, you may work with your reviewers and maintainers to identify an approach that does not fit these rules. Please endeavor to limit these cases.
15+
Our CSS is a mixture of current and legacy approaches. That means sometimes it may be difficult to follow this guide to the letter; it means you are likely to run into exceptions, where following the guide is difficult to impossible without major effort. In those cases, you may work with your reviewers and maintainers to identify an approach that does not fit these rules. Please endeavor to limit these cases.
1616

1717
### Utility Classes
1818

@@ -21,10 +21,12 @@ In order to reduce the generation of more CSS as our site grows, prefer the use
2121
#### Where are utility classes defined?
2222

2323
Prefer the use of [utility classes defined in GitLab UI](https://gitlab.com/gitlab-org/gitlab-ui/-/blob/main/doc/css.md#utilities).
24+
<!-- vale gitlab.Spelling = NO -->
2425
An easy list of classes can also be [seen on Unpkg](https://unpkg.com/browse/@gitlab/ui/src/scss/utilities.scss).
26+
<!-- vale gitlab.Spelling = YES -->
2527

2628
Classes in [`utilities.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/utilities.scss) and [`common.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/framework/common.scss) are being deprecated.
27-
Classes in [`common.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/framework/common.scss) that use non-design system values should be avoided in favor of conformant values.
29+
Classes in [`common.scss`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/app/assets/stylesheets/framework/common.scss) that use non-design-system values should be avoided. Use classes with conforming values instead.
2830

2931
Avoid [Bootstrap's Utility Classes](https://getbootstrap.com/docs/4.3/utilities/).
3032

@@ -49,7 +51,7 @@ We recommend a "utility-first" approach.
4951
1. Start with utility classes.
5052
1. If composing utility classes into a component class removes code duplication and encapsulates a clear responsibility, do it.
5153

52-
This encourages an organic growth of component classes and prevents the creation of one-off unreusable classes. Also, the kind of classes that emerge from "utility-first" tend to be design-centered (e.g. `.button`, `.alert`, `.card`) rather than domain-centered (e.g. `.security-report-widget`, `.commit-header-icon`).
54+
This encourages an organic growth of component classes and prevents the creation of one-off non-reusable classes. Also, the kind of classes that emerge from "utility-first" tend to be design-centered (e.g. `.button`, `.alert`, `.card`) rather than domain-centered (e.g. `.security-report-widget`, `.commit-header-icon`).
5355

5456
Inspiration:
5557

doc/development/fe_guide/vue.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ What is described in the following sections can be found in these examples:
2020

2121
All new features built with Vue.js must follow a [Flux architecture](https://facebook.github.io/flux/).
2222
The main goal we are trying to achieve is to have only one data flow and only one data entry.
23-
In order to achieve this goal we use [vuex](#vuex).
23+
In order to achieve this goal we use [Vuex](#vuex).
2424

2525
You can also read about this architecture in Vue documentation about
2626
[state management](https://vuejs.org/v2/guide/state-management.html#Simple-State-Management-from-Scratch)
@@ -345,12 +345,12 @@ component under test, with the `computed` property, for example). Remember to us
345345

346346
```javascript
347347
const checkbox = wrapper.findByTestId('checkboxTestId');
348-
348+
349349
expect(checkbox.attributes('disabled')).not.toBeDefined();
350-
350+
351351
findChildComponent().vm.$emit('primary');
352352
await nextTick();
353-
353+
354354
expect(checkbox.attributes('disabled')).toBeDefined();
355355
```
356356

@@ -359,7 +359,7 @@ component under test, with the `computed` property, for example). Remember to us
359359
```javascript
360360
// bad
361361
expect(findChildComponent().find('.error-alert').exists()).toBe(false);
362-
362+
363363
// good
364364
expect(findChildComponent().props('withAlertContainer')).toBe(false);
365365
```

doc/development/fe_guide/vue3_migration.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ Component's computed properties / methods or external helpers.
2626

2727
**What to use instead**
2828

29-
Vue documentation recommends using the [mitt](https://github.com/developit/mitt) library. It's relatively small (200 bytes gzipped) and has a clear API:
29+
Vue documentation recommends using the [mitt](https://github.com/developit/mitt) library. It's relatively small (200 bytes, compressed) and has a clear API:
3030

3131
```javascript
3232
import mitt from 'mitt'
@@ -51,7 +51,7 @@ emitter.off('foo', onFoo) // unlisten
5151

5252
**Event hub factory**
5353

54-
We have created a factory that you can use to instantiate a new mitt-based event hub.
54+
We have created a factory that you can use to instantiate a new mitt-based event hub.
5555
This makes it easier to migrate existing event hubs to the new recommended approach, or
5656
to create new ones.
5757

0 commit comments

Comments
 (0)