diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-29 21:09:56 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-29 21:09:56 +0300 |
commit | 6f2dc439265369de7b1e1b18b208c6d66cf260eb (patch) | |
tree | c961526575126eafdd022ae7b496830dcf252002 /doc | |
parent | 647de7e6fd971d435396cc8730a2d162240e3d7c (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/README.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/index.md | 2 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 6 | ||||
-rw-r--r-- | doc/development/migration_style_guide.md | 6 | ||||
-rw-r--r-- | doc/topics/git/index.md | 6 | ||||
-rw-r--r-- | doc/user/clusters/applications.md | 3 | ||||
-rw-r--r-- | doc/user/clusters/img/fluentd_v12_10.png | bin | 26816 -> 0 bytes | |||
-rw-r--r-- | doc/user/clusters/img/fluentd_v13_0.png | bin | 0 -> 32445 bytes |
8 files changed, 13 insertions, 12 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index 368283f182a..35641fb4085 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -117,7 +117,7 @@ Complementary reads: ### Tooling - [Understanding EXPLAIN plans](understanding_explain_plans.md) -- [explain.depesz.com](https://explain.depesz.com/) for visualising the output +- [explain.depesz.com](https://explain.depesz.com/) for visualizing the output of `EXPLAIN` - [pgFormatter](http://sqlformat.darold.net/) a PostgreSQL SQL syntax beautifier diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index ec57de35dfb..92044d3f942 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -6,7 +6,7 @@ description: Learn how to contribute to GitLab Documentation. GitLab's documentation is [intended as the single source of truth (SSOT)](https://about.gitlab.com/handbook/documentation/) for information about how to configure, use, and troubleshoot GitLab. The documentation contains use cases and usage instructions for every GitLab feature, organized by product area and subject. This includes topics and workflows that span multiple GitLab features, and the use of GitLab with other applications. -In addition to this page, the following resources can help you craft and contribute documentation: +In addition to this page, the following resources can help you craft and contribute to documentation: - [Style Guide](styleguide.md) - What belongs in the docs, language guidelines, Markdown standards to follow, links, and more. - [Structure and template](structure.md) - Learn the typical parts of a doc page and how to write each one. diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 452da7cc85e..d29ae81a3c8 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -17,7 +17,7 @@ that apply to all GitLab content, not just documentation. ### Why a single source of truth -The documentation of GitLab products and features is the SSOT for all information related to implementation, usage, and troubleshooting. It evolves continually, in keeping with new products and features, and with improvements for clarity, accuracy, and completeness. +The documentation of GitLab products and features is the SSOT for all information related to implementation, usage, and troubleshooting. It evolves continuously, in keeping with new products and features, and with improvements for clarity, accuracy, and completeness. This policy prevents information silos, making it easier to find information about GitLab products. @@ -46,12 +46,12 @@ In the software industry, it is a best practice to organize documentation in dif 1. Explanation 1. Reference (for example, a glossary) -At GitLab, we have so many product changes in our monthly releases that we can't afford to continually update multiple types of information. +At GitLab, we have so many product changes in our monthly releases that we can't afford to continuously update multiple types of information. If we have multiple types, the information will become outdated. Therefore, we have a [single template](structure.md) for documentation. We currently do not distinguish specific document types, although we are open to reconsidering this policy once the documentation has reached a future stage of maturity and quality. If you are reading this, then despite our -continual improvement efforts, that point hasn't been reached. +continuous improvement efforts, that point hasn't been reached. ### Link instead of summarize diff --git a/doc/development/migration_style_guide.md b/doc/development/migration_style_guide.md index 371fdf8b7f0..07652707382 100644 --- a/doc/development/migration_style_guide.md +++ b/doc/development/migration_style_guide.md @@ -44,7 +44,7 @@ other people using `db/structure.sql` generated by Rails. When your local database in your GDK is diverging from the schema from `master` it might be hard to cleanly commit the schema changes to -Git. In that case you can use the `script/regenerate-schema` script to +Git. In that case you can use the `scripts/regenerate-schema` script to regenerate a clean `db/structure.sql` for the migrations you're adding. This script will apply all migrations found in `db/migrate` or `db/post_migrate`, so if there are any migrations you don't want to @@ -53,10 +53,10 @@ targetting `master` you can set the `TARGET` environment variable. ```sh # Regenerate schema against `master` -bin/regenerate-schema +scripts/regenerate-schema # Regenerate schema against `12-9-stable-ee` -TARGET=12-9-stable-ee bin/regenerate-schema +TARGET=12-9-stable-ee scripts/regenerate-schema ``` ## What Requires Downtime? diff --git a/doc/topics/git/index.md b/doc/topics/git/index.md index 019194d1bba..84f9d7f1c4a 100644 --- a/doc/topics/git/index.md +++ b/doc/topics/git/index.md @@ -36,12 +36,12 @@ The following resources will help you get started with Git: ### Concepts -The following are resources about version control concepts: +The following are resources on version control concepts: - [Git concepts](../../university/training/user_training.md#git-concepts) - [Why Git is Worth the Learning Curve](https://about.gitlab.com/blog/2017/05/17/learning-curve-is-the-biggest-challenge-developers-face-with-git/) - [The future of SaaS hosted Git repository pricing](https://about.gitlab.com/blog/2016/05/11/git-repository-pricing/) -- [Git website topic about version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) +- [Git website on version control](https://git-scm.com/book/en/v2/Getting-Started-About-Version-Control) - [GitLab University presentation about Version Control](https://docs.google.com/presentation/d/16sX7hUrCZyOFbpvnrAFrg6tVO5_yT98IgdAqOmXwBho/edit?usp=sharing) ## Git tips @@ -79,7 +79,7 @@ The following are advanced topics for those who want to get the most out of Git: [Gitignore templates](../../api/templates/gitignores.md) API allow for Git-related queries from GitLab. -## Git LFS +## Git Large File Storage (LFS) The following relate to Git Large File Storage: diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index f6e924c8d2f..d1f49d6ea1f 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -570,9 +570,10 @@ To enable Fluentd: 1. Provide the host domain name or URL in **SIEM Hostname**. 1. Provide the host port number in **SIEM Port**. 1. Select a **SIEM Protocol**. +1. Select at least one of the available logs (such as WAF or Cilium). 1. Click **Save changes**. -![Fluentd input fields](img/fluentd_v12_10.png) +![Fluentd input fields](img/fluentd_v13_0.png) ### Future apps diff --git a/doc/user/clusters/img/fluentd_v12_10.png b/doc/user/clusters/img/fluentd_v12_10.png Binary files differdeleted file mode 100644 index 48cf3699886..00000000000 --- a/doc/user/clusters/img/fluentd_v12_10.png +++ /dev/null diff --git a/doc/user/clusters/img/fluentd_v13_0.png b/doc/user/clusters/img/fluentd_v13_0.png Binary files differnew file mode 100644 index 00000000000..edc73285238 --- /dev/null +++ b/doc/user/clusters/img/fluentd_v13_0.png |