diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 21:09:19 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 21:09:19 +0000 |
commit | 7915c41e4261719719e791602c8235574157164c (patch) | |
tree | 6c1fc8c4ad4e974878c879fcc2c7c8f7d56d0cee /doc | |
parent | 495c22d1245b6212b21b7379a542df73dfa77206 (diff) | |
download | gitlab-ce-7915c41e4261719719e791602c8235574157164c.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/geo/replication/img/geo_node_dashboard.png | bin | 26266 -> 200732 bytes | |||
-rw-r--r-- | doc/development/documentation/styleguide.md | 31 | ||||
-rw-r--r-- | doc/user/admin_area/settings/usage_statistics.md | 2 | ||||
-rw-r--r-- | doc/user/asciidoc.md | 11 |
4 files changed, 43 insertions, 1 deletions
diff --git a/doc/administration/geo/replication/img/geo_node_dashboard.png b/doc/administration/geo/replication/img/geo_node_dashboard.png Binary files differindex 99792d0770d..0d3dc5895af 100644 --- a/doc/administration/geo/replication/img/geo_node_dashboard.png +++ b/doc/administration/geo/replication/img/geo_node_dashboard.png diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 75e38c3a5be..8e9ff0fb218 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -769,7 +769,7 @@ To indicate the steps of navigation through the UI: a valid name for an illustration is `devops_diagram_v11_1.png`. - Keep all file names in lower case. - Consider using PNG images instead of JPEG. -- Compress all images with <https://pngquant.org/> or similar tool. +- [Compress all PNG images](#compress-images). - Compress gifs with <https://ezgif.com/optimize> or similar tool. - Images should be used (only when necessary) to _illustrate_ the description of a process, not to _replace_ it. @@ -796,6 +796,35 @@ directly to an HTML `img` tag: <img src="path/to/image.jpg" alt="Alt text (required)" class="image-noshadow"> ``` +### Compress images + +You should always compress any new images you add to the documentation. One +known tool is [`pngquant`](https://pngquant.org/), which is cross-platform and +open source. Install it by visiting the official website and following the +instructions for your OS. + +GitLab has a [raketask](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/tasks/pngquant.rake) +that you can use to automate the process. In the root directory of your local +copy of `https://gitlab.com/gitlab-org/gitlab`, run in a terminal: + +- Before compressing, if you want, check that all documentation PNG images have + been compressed: + + ```shell + bundle exec rake pngquant:lint + ``` + +- Compress all documentation PNG images using `pngquant`: + + ```shell + bundle exec rake pngquant:compress + ``` + +The only caveat is that the task runs on all images under `doc/`, not only the +ones you might have included in a merge request. In that case, you can run the +compress task and only commit the images that are relevant to your merge +request. + ## Videos Adding GitLab's existing YouTube video tutorials to the documentation is diff --git a/doc/user/admin_area/settings/usage_statistics.md b/doc/user/admin_area/settings/usage_statistics.md index 9e7fae05be7..cbfdf2d188c 100644 --- a/doc/user/admin_area/settings/usage_statistics.md +++ b/doc/user/admin_area/settings/usage_statistics.md @@ -327,6 +327,8 @@ but commented out to help encourage others to add to it in the future. --> |dependency_scanning_jobs|counts|| |license_management_jobs|counts|| |sast_jobs|counts|| +|status_page_projects|counts|monitor| +|status_page_issues|counts|monitor| |epics_deepest_relationship_level|counts|| |operations_dashboard_default_dashboard|counts|| |operations_dashboard_users_with_projects_added|counts|| diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index c35d1da5a88..8834deb8d50 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -91,6 +91,8 @@ stem:[sqrt(4) = 2] ### Attributes +**User-defined attributes** + ```asciidoc // define attributes in the document header :name: value @@ -104,6 +106,15 @@ C{pp} is not required, only Ruby. Use a leading backslash to output a word enclosed in curly braces, like \{name}. ``` +**Environment attributes** + +GitLab sets the following environment attributes: + +| Attribute | Description | +| :-------------- | :--------------------------------------------------------------------------------------------------------------------- | +| `docname` | Root name of the source document (no leading path or file extension). | +| `outfilesuffix` | File extension corresponding to the backend output (defaults to `.adoc` to make inter-document cross references work). | + ### Links ```asciidoc |