Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-10-21 21:10:33 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2022-10-21 21:10:33 +0300
commitc742109766862e8a7e105c3101c50d73c46e27b1 (patch)
tree57b1f88fc13a8ccb955c467654704a60180d885e /doc/development
parent68613feb1d0df32fae0c1960368e517defc2b67d (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r--doc/development/documentation/index.md40
-rw-r--r--doc/development/documentation/styleguide/word_list.md4
-rw-r--r--doc/development/fe_guide/vue.md3
3 files changed, 24 insertions, 23 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index c52b3b5adae..0350171544d 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -181,32 +181,30 @@ To prepare an update to the `CODEOWNERS` file:
bundle exec rake tw:codeowners > ~/Desktop/updates.md
```
-1. Open the file you just created (`~/Desktop/updates.md` in this example), and prepare the output:
- - Find and replace `./` with `/`.
- - Sort the lines in alphabetical (ascending) order. If you use VS Code, you can
- select everything, press <kbd>F1</kbd>, type `sort`, and select **Sort lines (ascending, case insensitive**.
-1. Create a new branch for your `CODEOWNERS` updates.
-1. Replace the documentation-related lines in the `^[Documentation Pages]` section
- with the output you prepared.
-
- WARNING:
- The documentation section is not the last section of the `CODEOWNERS` file. Don't
- delete data that isn't ours!
-
-1. Create a commit with the raw changes.
-1. From the command line, run `git diff master`.
-1. In the diff, look for directory-level assignments to manually restore to the
- `CODEOWNERS` file. If all files in a single directory are assigned to the same
- technical writer, we simplify these entries. Remove all the lines for the individual
- files, and leave a single entry for the directory, for example: `/doc/directory/ @tech.writer`.
-1. In the diff, look for changes that don't match your expectations:
+1. Open the file you just created (`~/Desktop/updates.md` in this example). Check
+ that the lines are in alphabetical (ascending) order. If you have to sort
+ the lines and you use VS Code, you can select everything, press <kbd>F1</kbd>,
+ type `sort`, and select **Sort lines (ascending, case insensitive)**.
+1. In the output, look for changes that don't match your expectations:
- New pages, or newly moved pages, show up as added lines.
- Deleted pages, and pages that are now redirects, show up as deleted lines.
- If you see an unusual number of changes to pages that all seem related,
check the metadata for the pages. A group might have been renamed and the Rake task
must be updated to match.
-1. Create another commit with your manual changes, and create a second merge request
- with your changes to the `CODEOWNERS` file. Assign it to a technical writing manager for review.
+ - If all files in a single directory are assigned to the same
+ technical writer, simplify these entries. Remove all the lines for the individual
+ files, and leave a single entry for the directory, for example: `/doc/directory/ @tech.writer`.
+1. When you are happy with the output, create a new branch to update the
+ [`CODEOWNERS`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/CODEOWNERS)
+ file. Replace the documentation-related lines in the `^[Documentation Pages]`
+ section with the output you prepared.
+
+ WARNING:
+ The documentation section is not the last section of the `CODEOWNERS` file. Don't
+ delete data that isn't ours!
+
+1. Create a merge request from this branch with your changes to the `CODEOWNERS` file.
+ Assign it to a technical writing manager for review.
## Move, rename, or delete a page
diff --git a/doc/development/documentation/styleguide/word_list.md b/doc/development/documentation/styleguide/word_list.md
index ce1ba5f2dc9..a5dc7a727d8 100644
--- a/doc/development/documentation/styleguide/word_list.md
+++ b/doc/development/documentation/styleguide/word_list.md
@@ -77,9 +77,9 @@ Instead of:
- The documentation is written by contributors.
NOTE:
-If you can add the phrase "by zombies" to the end of the sentence,
+If you can add the phrase "by zombies" to the phrase,
the construction is passive. For example, `The button is selected by zombies`
-is passive. `Select the button` is active.
+is passive. `Zombies select the button` is active.
## administrator
diff --git a/doc/development/fe_guide/vue.md b/doc/development/fe_guide/vue.md
index 00d9588d087..779010b8aa1 100644
--- a/doc/development/fe_guide/vue.md
+++ b/doc/development/fe_guide/vue.md
@@ -65,6 +65,9 @@ To do that, you can use the `data` attributes in the HTML element and query them
You should only do this while initializing the application, because the mounted element is replaced
with a Vue-generated DOM.
+The `data` attributes are [only able to accept String values](https://developer.mozilla.org/en-US/docs/Learn/HTML/Howto/Use_data_attributes#javascript_access),
+so you will need to cast or convert other variable types to String.
+
The advantage of providing data from the DOM to the Vue instance through `props` or
`provide` in the `render` function, instead of querying the DOM inside the main Vue
component, is that you avoid creating a fixture or an HTML element in the unit test.