summaryrefslogtreecommitdiff
path: root/doc/development/documentation
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2020-01-30 15:09:15 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2020-01-30 15:09:15 +0000
commit536aa3a1f4b96abc4ca34489bf2cbe503afcded7 (patch)
tree88d08f7dfa29a32d6526773c4fe0fefd9f2bc7d1 /doc/development/documentation
parent50ae4065530c4eafbeb7c5ff2c462c48c02947ca (diff)
downloadgitlab-ce-536aa3a1f4b96abc4ca34489bf2cbe503afcded7.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation')
-rw-r--r--doc/development/documentation/index.md8
-rw-r--r--doc/development/documentation/site_architecture/release_process.md16
-rw-r--r--doc/development/documentation/styleguide.md18
3 files changed, 21 insertions, 21 deletions
diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md
index 34cf50f61d9..ffb8178326b 100644
--- a/doc/development/documentation/index.md
+++ b/doc/development/documentation/index.md
@@ -98,7 +98,7 @@ For example, if you move `doc/workflow/lfs/lfs_administration.md` to
A quick way to find them is to use `git grep`. First go to the root directory
where you cloned the `gitlab` repository and then do:
- ```sh
+ ```shell
git grep -n "workflow/lfs/lfs_administration"
git grep -n "lfs/lfs_administration"
```
@@ -435,7 +435,7 @@ This list does not limit what other linters you can add to your local documentat
documentation in the [`gitlab` project](https://gitlab.com/gitlab-org/gitlab), run the
following commands from within the `gitlab` project:
-```sh
+```shell
cd doc
proselint **/*.md
```
@@ -480,13 +480,13 @@ run the following commands from within your `gitlab` project root directory, whi
automatically detect the [`.markdownlint.json`](#markdownlint-configuration) config
file in the root of the project, and test all files in `/doc` and its subdirectories:
-```sh
+```shell
markdownlint 'doc/**/*.md'
```
If you wish to use a different config file, use the `-c` flag:
-```sh
+```shell
markdownlint -c <config-file-name> 'doc/**/*.md'
```
diff --git a/doc/development/documentation/site_architecture/release_process.md b/doc/development/documentation/site_architecture/release_process.md
index 51a02528758..de014c121a9 100644
--- a/doc/development/documentation/site_architecture/release_process.md
+++ b/doc/development/documentation/site_architecture/release_process.md
@@ -23,7 +23,7 @@ and tag all tooling images locally:
1. Make sure you're on the `dockerfiles/` directory of the `gitlab-docs` repo.
1. Build the images:
- ```sh
+ ```shell
docker build -t registry.gitlab.com/gitlab-org/gitlab-docs:bootstrap -f Dockerfile.bootstrap ../
docker build -t registry.gitlab.com/gitlab-org/gitlab-docs:builder-onbuild -f Dockerfile.builder.onbuild ../
docker build -t registry.gitlab.com/gitlab-org/gitlab-docs:nginx-onbuild -f Dockerfile.nginx.onbuild ../
@@ -64,13 +64,13 @@ this needs to happen when the stable branches for all products have been created
1. Make sure you're on the root path of the `gitlab-docs` repo.
1. Make sure your `master` is updated:
- ```sh
+ ```shell
git pull origin master
```
1. Run the raketask to create the single version:
- ```sh
+ ```shell
./bin/rake "release:single[12.0]"
```
@@ -96,7 +96,7 @@ this needs to happen when the stable branches for all products have been created
Optionally, you can test locally by building the image and running it:
-```sh
+```shell
docker build -t docs:12.0 -f Dockerfile.12.0 .
docker run -it --rm -p 4000:4000 docs:12.0
```
@@ -111,7 +111,7 @@ version and rotates the old one:
1. Make sure you're on the root path of the `gitlab-docs` repo.
1. Create a branch `release-X-Y`:
- ```sh
+ ```shell
git checkout master
git checkout -b release-12-0
```
@@ -150,7 +150,7 @@ version and rotates the old one:
1. In the end, there should be four files in total that have changed.
Commit and push to create the merge request using the "Release" template:
- ```sh
+ ```shell
git add content/ Dockerfile.master dockerfiles/Dockerfile.archives
git commit -m "Release 12.0"
git push origin release-12-0
@@ -172,7 +172,7 @@ versions:
pipelines succeed. The `release-X-Y` branch needs to be present locally,
otherwise the raketask will fail:
- ```sh
+ ```shell
./bin/rake release:dropdowns
```
@@ -218,7 +218,7 @@ from time to time.
If this is not possible or there are many changes, merge master into them:
-```sh
+```shell
git branch 12.0
git fetch origin master
git merge origin/master
diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md
index b361648b2f0..225e3a65eab 100644
--- a/doc/development/documentation/styleguide.md
+++ b/doc/development/documentation/styleguide.md
@@ -329,7 +329,7 @@ where a reader must replace text with their own value.
For example:
-```sh
+```shell
cp <your_source_directory> <your_destination_directory>
```
@@ -1277,7 +1277,7 @@ METHOD /endpoint
Example request:
-```sh
+```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" 'https://gitlab.example.com/api/v4/endpoint?parameters'
```
@@ -1355,7 +1355,7 @@ Below is a set of [cURL](https://curl.haxx.se) examples that you can use in the
Get the details of a group:
-```bash
+```shell
curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/api/v4/groups/gitlab-org
```
@@ -1363,7 +1363,7 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap
Create a new project under the authenticated user's namespace:
-```bash
+```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects?name=foo"
```
@@ -1373,7 +1373,7 @@ Instead of using `--request POST` and appending the parameters to the URI, you c
cURL's `--data` option. The example below will create a new project `foo` under
the authenticated user's namespace.
-```bash
+```shell
curl --data "name=foo" --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects"
```
@@ -1382,7 +1382,7 @@ curl --data "name=foo" --header "PRIVATE-TOKEN: <your_access_token>" "https://gi
> **Note:** In this example we create a new group. Watch carefully the single
and double quotes.
-```bash
+```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Content-Type: application/json" --data '{"path": "my-group", "name": "My group"}' https://gitlab.example.com/api/v4/groups
```
@@ -1391,7 +1391,7 @@ curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --header "Cont
Instead of using JSON or urlencode you can use multipart/form-data which
properly handles data encoding:
-```bash
+```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" --form "title=ssh-key" --form "key=ssh-rsa AAAAB3NzaC1yc2EA..." https://gitlab.example.com/api/v4/users/25/keys
```
@@ -1405,7 +1405,7 @@ to escape them when possible. In the example below we create a new issue which
contains spaces in its title. Observe how spaces are escaped using the `%20`
ASCII code.
-```bash
+```shell
curl --request POST --header "PRIVATE-TOKEN: <your_access_token>" "https://gitlab.example.com/api/v4/projects/42/issues?title=Hello%20Dude"
```
@@ -1417,7 +1417,7 @@ The GitLab API sometimes accepts arrays of strings or integers. For example, to
restrict the sign-up e-mail domains of a GitLab instance to `*.example.com` and
`example.net`, you would do something like this:
-```bash
+```shell
curl --request PUT --header "PRIVATE-TOKEN: <your_access_token>" --data "domain_whitelist[]=*.example.com" --data "domain_whitelist[]=example.net" https://gitlab.example.com/api/v4/application/settings
```