Commit 57a7d29d authored by Craig Norris's avatar Craig Norris

Merge branch 'docs-aqualls-more-notes' into 'master'

Strip more Note boxes from pages

See merge request gitlab-org/gitlab!45089
parents 05ab390d 6700c389
...@@ -363,8 +363,7 @@ This file lives in `/var/log/gitlab/gitlab-rails/git_json.log` for ...@@ -363,8 +363,7 @@ This file lives in `/var/log/gitlab/gitlab-rails/git_json.log` for
Omnibus GitLab packages or in `/home/git/gitlab/log/git_json.log` for Omnibus GitLab packages or in `/home/git/gitlab/log/git_json.log` for
installations from source. installations from source.
NOTE: **Note:** After GitLab version 12.2, this file was renamed from `githost.log` to
After 12.2, this file was renamed from `githost.log` to
`git_json.log` and stored in JSON format. `git_json.log` and stored in JSON format.
GitLab has to interact with Git repositories, but in some rare cases GitLab has to interact with Git repositories, but in some rare cases
......
...@@ -49,7 +49,6 @@ JSON file individually: ...@@ -49,7 +49,6 @@ JSON file individually:
1. After the dashboard is imported, click the **Save dashboard** icon in the top bar: 1. After the dashboard is imported, click the **Save dashboard** icon in the top bar:
![Grafana save icon](img/grafana_save_icon.png) ![Grafana save icon](img/grafana_save_icon.png)
NOTE: **Note:**
If you don't save the dashboard after importing it, the dashboard is removed If you don't save the dashboard after importing it, the dashboard is removed
when you navigate away from the page. when you navigate away from the page.
......
...@@ -216,9 +216,8 @@ For example, if you move `doc/workflow/lfs/index.md` to ...@@ -216,9 +216,8 @@ For example, if you move `doc/workflow/lfs/index.md` to
git grep -n "lfs/lfs_administration" git grep -n "lfs/lfs_administration"
``` ```
NOTE: **Note:** 1. If the document being moved has any Disqus comments on it, follow the steps
If the document being moved has any Disqus comments on it, there are extra steps described in [Redirections for pages with Disqus comments](#redirections-for-pages-with-disqus-comments).
to follow documented just [below](#redirections-for-pages-with-disqus-comments).
Things to note: Things to note:
...@@ -249,7 +248,8 @@ using the old URL as value. For example, let's say we moved the document ...@@ -249,7 +248,8 @@ using the old URL as value. For example, let's say we moved the document
available under `https://docs.gitlab.com/my-old-location/README.html` to a new location, available under `https://docs.gitlab.com/my-old-location/README.html` to a new location,
`https://docs.gitlab.com/my-new-location/index.html`. `https://docs.gitlab.com/my-new-location/index.html`.
Into the **new document** front matter, we add the following: Into the **new document** front matter, we add the following information. You must
include the file name in the `disqus_identifier` URL, even if it's `index.html` or `README.html`.
```yaml ```yaml
--- ---
...@@ -257,9 +257,6 @@ disqus_identifier: 'https://docs.gitlab.com/my-old-location/README.html' ...@@ -257,9 +257,6 @@ disqus_identifier: 'https://docs.gitlab.com/my-old-location/README.html'
--- ---
``` ```
Note: it is necessary to include the file name in the `disqus_identifier` URL,
even if it's `index.html` or `README.html`.
## Merge requests for GitLab documentation ## Merge requests for GitLab documentation
Before getting started, make sure you read the introductory section Before getting started, make sure you read the introductory section
...@@ -275,9 +272,8 @@ represents a good-faith effort to follow the template and style standards, ...@@ -275,9 +272,8 @@ represents a good-faith effort to follow the template and style standards,
and is believed to be accurate. and is believed to be accurate.
Further needs for what would make the doc even better should be immediately addressed Further needs for what would make the doc even better should be immediately addressed
in a follow-up MR or issue. in a follow-up merge request or issue.
NOTE: **Note:**
If the release version you want to add the documentation to has already been If the release version you want to add the documentation to has already been
frozen or released, use the label `~"Pick into X.Y"` to get it merged into frozen or released, use the label `~"Pick into X.Y"` to get it merged into
the correct release. Avoid picking into a past release as much as you can, as the correct release. Avoid picking into a past release as much as you can, as
...@@ -400,8 +396,7 @@ You will need at least Maintainer permissions to be able to run it. ...@@ -400,8 +396,7 @@ You will need at least Maintainer permissions to be able to run it.
![Manual trigger a docs build](img/manual_build_docs.png) ![Manual trigger a docs build](img/manual_build_docs.png)
NOTE: **Note:** You must push a branch to those repositories, as it doesn't work for forks.
You will need to push a branch to those repositories, it doesn't work for forks.
The `review-docs-deploy*` job will: The `review-docs-deploy*` job will:
...@@ -418,17 +413,16 @@ minutes and it should appear online, otherwise you can check the status of the ...@@ -418,17 +413,16 @@ minutes and it should appear online, otherwise you can check the status of the
remote pipeline from the link in the merge request's job output. remote pipeline from the link in the merge request's job output.
If the pipeline failed or got stuck, drop a line in the `#docs` chat channel. If the pipeline failed or got stuck, drop a line in the `#docs` chat channel.
TIP: **Tip:**
Someone with no merge rights to the GitLab projects (think of forks from
contributors) cannot run the manual job. In that case, you can
ask someone from the GitLab team who has the permissions to do that for you.
NOTE: **Note:**
Make sure that you always delete the branch of the merge request you were Make sure that you always delete the branch of the merge request you were
working on. If you don't, the remote docs branch won't be removed either, working on. If you don't, the remote docs branch won't be removed either,
and the server where the Review Apps are hosted will eventually be out of and the server where the Review Apps are hosted will eventually be out of
disk space. disk space.
TIP: **Tip:**
Someone with no merge rights to the GitLab projects (think of forks from
contributors) cannot run the manual job. In that case, you can
ask someone from the GitLab team who has the permissions to do that for you.
### Troubleshooting review apps ### Troubleshooting review apps
In case the review app URL returns 404, follow these steps to debug: In case the review app URL returns 404, follow these steps to debug:
......
...@@ -287,7 +287,6 @@ method or variable shouldn't be evaluated right away) ...@@ -287,7 +287,6 @@ method or variable shouldn't be evaluated right away)
See our [HOWTO: Use Sidekiq metadata logs](https://www.youtube.com/watch?v=_wDllvO_IY0) for further knowledge on See our [HOWTO: Use Sidekiq metadata logs](https://www.youtube.com/watch?v=_wDllvO_IY0) for further knowledge on
creating visualizations in Kibana. creating visualizations in Kibana.
NOTE: **Note:**
The fields of the context are currently only logged for Sidekiq jobs triggered The fields of the context are currently only logged for Sidekiq jobs triggered
through web requests. See the through web requests. See the
[follow-up work](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/68) [follow-up work](https://gitlab.com/gitlab-com/gl-infra/scalability/-/issues/68)
......
...@@ -35,11 +35,6 @@ After you add or change an existing common metric, you must [re-run the import s ...@@ -35,11 +35,6 @@ After you add or change an existing common metric, you must [re-run the import s
Or, you can create a database migration: Or, you can create a database migration:
NOTE: **Note:**
If a query metric (which is identified by `id:`) is removed it will not be removed from database by default.
You might want to add additional database migration that makes a decision what to do with removed one.
For example: you might be interested in migrating all dependent data to a different metric.
```ruby ```ruby
class ImportCommonMetrics < ActiveRecord::Migration[4.2] class ImportCommonMetrics < ActiveRecord::Migration[4.2]
include Gitlab::Database::MigrationHelpers include Gitlab::Database::MigrationHelpers
...@@ -56,6 +51,10 @@ class ImportCommonMetrics < ActiveRecord::Migration[4.2] ...@@ -56,6 +51,10 @@ class ImportCommonMetrics < ActiveRecord::Migration[4.2]
end end
``` ```
If a query metric (which is identified by `id:`) is removed it will not be removed from database by default.
You might want to add additional database migration that makes a decision what to do with removed one.
For example: you might be interested in migrating all dependent data to a different metric.
## GitLab Prometheus metrics ## GitLab Prometheus metrics
GitLab provides [Prometheus metrics](../administration/monitoring/prometheus/gitlab_metrics.md) GitLab provides [Prometheus metrics](../administration/monitoring/prometheus/gitlab_metrics.md)
......
...@@ -44,7 +44,6 @@ You may also want to enable Sentry's GitLab integration by following the steps i ...@@ -44,7 +44,6 @@ You may also want to enable Sentry's GitLab integration by following the steps i
## Error Tracking List ## Error Tracking List
NOTE: **Note:**
Users with at least Reporter [permissions](../user/permissions.md) Users with at least Reporter [permissions](../user/permissions.md)
can find the Error Tracking list at **Operations > Error Tracking** in your project's sidebar. can find the Error Tracking list at **Operations > Error Tracking** in your project's sidebar.
Here, you can filter errors by title or by status (one of Ignored , Resolved, or Unresolved) and sort in descending order by Frequency, First Seen, or Last Seen. By default, the error list is ordered by Last Seen and filtered to Unresolved errors. Here, you can filter errors by title or by status (one of Ignored , Resolved, or Unresolved) and sort in descending order by Frequency, First Seen, or Last Seen. By default, the error list is ordered by Last Seen and filtered to Unresolved errors.
......
...@@ -45,7 +45,6 @@ Read the documentation on [links](index.md#add-related-links-to-custom-dashboard ...@@ -45,7 +45,6 @@ Read the documentation on [links](index.md#add-related-links-to-custom-dashboard
Dashboards display panel groups in the order they are listed in the dashboard YAML file. Dashboards display panel groups in the order they are listed in the dashboard YAML file.
NOTE: **Note:**
In GitLab versions 13.3 and below, panel groups were ordered by a `priority` key, which In GitLab versions 13.3 and below, panel groups were ordered by a `priority` key, which
is no longer used. is no longer used.
...@@ -60,7 +59,6 @@ Panels in a panel group are laid out in rows consisting of two panels per row. A ...@@ -60,7 +59,6 @@ Panels in a panel group are laid out in rows consisting of two panels per row. A
Dashboards display panels in the order they are listed in the dashboard YAML file. Dashboards display panels in the order they are listed in the dashboard YAML file.
NOTE: **Note:**
In GitLab versions 13.3 and below, panels were ordered by a `weight` key, which In GitLab versions 13.3 and below, panels were ordered by a `weight` key, which
is no longer used. is no longer used.
......
...@@ -78,7 +78,6 @@ provided can manage resources in the `database.crossplane.io` API group: ...@@ -78,7 +78,6 @@ provided can manage resources in the `database.crossplane.io` API group:
See [Configure Your Cloud Provider Account](https://crossplane.github.io/docs/v0.4/cloud-providers.html) See [Configure Your Cloud Provider Account](https://crossplane.github.io/docs/v0.4/cloud-providers.html)
to configure the installed cloud provider stack with a user account. to configure the installed cloud provider stack with a user account.
NOTE: **Note:**
The Secret, and the Provider resource referencing the Secret, must be The Secret, and the Provider resource referencing the Secret, must be
applied to the `gitlab-managed-apps` namespace in the guide. Make sure you change that applied to the `gitlab-managed-apps` namespace in the guide. Make sure you change that
while following the process. while following the process.
......
...@@ -377,7 +377,6 @@ To set these: ...@@ -377,7 +377,6 @@ To set these:
`AWS_SECRET_ACCESS_KEY`. `AWS_SECRET_ACCESS_KEY`.
1. Mask the credentials so they do not show in logs using the **Masked** toggle. 1. Mask the credentials so they do not show in logs using the **Masked** toggle.
NOTE: **Note:**
The AWS credentials you provide must include IAM policies that provision correct access The AWS credentials you provide must include IAM policies that provision correct access
control to AWS Lambda, API Gateway, CloudFormation, and IAM resources. control to AWS Lambda, API Gateway, CloudFormation, and IAM resources.
......
...@@ -173,10 +173,7 @@ one of them will be used: ...@@ -173,10 +173,7 @@ one of them will be used:
> - GitLab 9.3 added the [numeric comparison](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/27439) of the 30 minute averages. > - GitLab 9.3 added the [numeric comparison](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/27439) of the 30 minute averages.
Developers can view the performance impact of their changes within the merge Developers can view the performance impact of their changes within the merge
request workflow. request workflow. This feature requires [Kubernetes](prometheus_library/kubernetes.md) metrics.
NOTE: **Note:**
Requires [Kubernetes](prometheus_library/kubernetes.md) metrics.
When a source branch has been deployed to an environment, a sparkline and When a source branch has been deployed to an environment, a sparkline and
numeric comparison of the average memory consumption will appear. On the numeric comparison of the average memory consumption will appear. On the
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment