diff options
| author | Marcel Amirault <mamirault@gitlab.com> | 2019-07-19 02:20:32 +0000 |
|---|---|---|
| committer | Evan Read <eread@gitlab.com> | 2019-07-19 02:20:32 +0000 |
| commit | 7da80b2d36adc30964423042e956ef880a2650f9 (patch) | |
| tree | 81c5e21931e2d2134fbedb8c0a859aeac6d14c5b /doc/development/fe_guide | |
| parent | acdb1f79688adae87933b34c3140e286ebab055c (diff) | |
| download | gitlab-ce-7da80b2d36adc30964423042e956ef880a2650f9.tar.gz | |
Update numbered lists for docs standards
Ensure that all numbered lists use only 1. and no other numbers.
Also ensure that numbered lists use proper spacing.
Diffstat (limited to 'doc/development/fe_guide')
| -rw-r--r-- | doc/development/fe_guide/frontend_faq.md | 6 | ||||
| -rw-r--r-- | doc/development/fe_guide/style_guide_js.md | 4 | ||||
| -rw-r--r-- | doc/development/fe_guide/style_guide_scss.md | 2 |
3 files changed, 6 insertions, 6 deletions
diff --git a/doc/development/fe_guide/frontend_faq.md b/doc/development/fe_guide/frontend_faq.md index e4225f2bc39..0d2aeffeac0 100644 --- a/doc/development/fe_guide/frontend_faq.md +++ b/doc/development/fe_guide/frontend_faq.md @@ -5,12 +5,12 @@ 1. **You talk about Frontend FAQ.** Please share links to it whenever applicable, so more eyes catch when content gets outdated. -2. **Keep it short and simple.** +1. **Keep it short and simple.** Whenever an answer needs more than two sentences it does not belong here. -3. **Provide background when possible.** +1. **Provide background when possible.** Linking to relevant source code, issue / epic, or other documentation helps to understand the answer. -4. **If you see something, do something.** +1. **If you see something, do something.** Please remove or update any content that is outdated as soon as you see it. ## FAQ diff --git a/doc/development/fe_guide/style_guide_js.md b/doc/development/fe_guide/style_guide_js.md index b50159c2b75..18ef754642d 100644 --- a/doc/development/fe_guide/style_guide_js.md +++ b/doc/development/fe_guide/style_guide_js.md @@ -548,7 +548,7 @@ Please check this [rules][eslint-plugin-vue-rules] for more documentation. <component @click="eventHandler"/> ``` -2. Shorthand `:` is preferable over `v-bind` +1. Shorthand `:` is preferable over `v-bind` ```javascript // bad @@ -558,7 +558,7 @@ Please check this [rules][eslint-plugin-vue-rules] for more documentation. <component :class="btn"/> ``` -3. Shorthand `#` is preferable over `v-slot` +1. Shorthand `#` is preferable over `v-slot` ```javascript // bad diff --git a/doc/development/fe_guide/style_guide_scss.md b/doc/development/fe_guide/style_guide_scss.md index 5220c9eeea3..f895cfd36ac 100644 --- a/doc/development/fe_guide/style_guide_scss.md +++ b/doc/development/fe_guide/style_guide_scss.md @@ -35,7 +35,7 @@ New utility classes should be added to [`utilities.scss`](https://gitlab.com/git We recommend a "utility-first" approach. 1. Start with utility classes. -2. If composing utility classes into a component class removes code duplication and encapsulates a clear responsibility, do it. +1. If composing utility classes into a component class removes code duplication and encapsulates a clear responsibility, do it. 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`). |