diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/contributing/index.md | 2 | ||||
| -rw-r--r-- | doc/development/documentation/index.md | 4 | ||||
| -rw-r--r-- | doc/development/documentation/styleguide/index.md | 2 | ||||
| -rw-r--r-- | doc/development/fe_guide/view_component.md | 8 | ||||
| -rw-r--r-- | doc/development/rake_tasks.md | 12 | ||||
| -rw-r--r-- | doc/development/routing.md | 2 | ||||
| -rw-r--r-- | doc/development/sec/analyzer_development_guide.md | 2 | ||||
| -rw-r--r-- | doc/development/spam_protection_and_captcha/exploratory_testing.md | 2 | ||||
| -rw-r--r-- | doc/development/stage_group_observability/dashboards/stage_group_dashboard.md | 2 |
9 files changed, 24 insertions, 12 deletions
diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index cbccd832d78..8c0d18f877b 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -100,7 +100,7 @@ If you have any questions or need help, visit [Getting Help](https://about.gitla communicate with the GitLab community. GitLab prefers [asynchronous communication](https://about.gitlab.com/handbook/communication/#internal-communication) over real-time communication. We do encourage you to connect and hang out with us. GitLab has a Gitter room dedicated for [contributors](https://gitter.im/gitlab/contributors), which is bridged with our -internal Slack. We actively monitor this channel. There is also a community-run [Discord server](https://discord.gg/S4cwz9sR8u) where you can +internal Slack. We actively monitor this channel. There is also a community-run [Discord server](http://discord.gg/gitlab) where you can find other contributors in the `#contributors` channel. Thanks for your contribution! diff --git a/doc/development/documentation/index.md b/doc/development/documentation/index.md index e0d7ab59429..d52db71b633 100644 --- a/doc/development/documentation/index.md +++ b/doc/development/documentation/index.md @@ -170,8 +170,8 @@ To update the `CODEOWNERS` file: bundle exec rake tw:codeowners > ~/Desktop/updates.md ``` -1. Open the file (for example, `~/Desktop/updates.md`) and copy - the lines in the `^[Documentation Pages]` section. +1. Open the file (for example, `~/Desktop/updates.md`) and copy everything + except the errors at the bottom of the file. 1. Open the [`CODEOWNERS`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/CODEOWNERS) file and paste the lines into the `^[Documentation Pages]` section. diff --git a/doc/development/documentation/styleguide/index.md b/doc/development/documentation/styleguide/index.md index adc999d2a18..f6ed4cdcaa9 100644 --- a/doc/development/documentation/styleguide/index.md +++ b/doc/development/documentation/styleguide/index.md @@ -26,7 +26,7 @@ In addition to this page, the following resources can help you craft and contrib ## The GitLab voice The GitLab brand guidelines define the -[voice used by the larger organization](https://design.gitlab.com/brand/overview#tone-of-voice). +[voice used by the larger organization](https://design.gitlab.com/brand/overview/#tone-of-voice). Building on that guidance, the voice in the GitLab documentation strives to be concise, direct, and precise. The goal is to provide information that's easy to search and scan. diff --git a/doc/development/fe_guide/view_component.md b/doc/development/fe_guide/view_component.md index d9d2b6707f7..b61c23cadef 100644 --- a/doc/development/fe_guide/view_component.md +++ b/doc/development/fe_guide/view_component.md @@ -15,7 +15,7 @@ watch this [introduction video](https://youtu.be/akRhUbvtnmo). ## Browse components with Lookbook -We have a [Lookbook](https://github.com/allmarkedup/lookbook) in [http://gdk.test:3000/rails/lookbook](http://gdk.test:3000/rails/lookbook) (only available in development mode) to browse and interact with ViewComponent previews. +We have a [Lookbook](https://github.com/allmarkedup/lookbook) in `http://gdk.test:3000/rails/lookbook` (only available in development mode) to browse and interact with ViewComponent previews. ## Pajamas components @@ -29,7 +29,7 @@ if the component you are looking for is not yet available. ### Available components -Consider this list a best effort. The full list can be found in [`app/components/pajamas`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/components/pajamas). Also see [our Lookbook](http://gdk.test:3000/rails/lookbook) for a more interactive way to browse our components. +Consider this list a best effort. The full list can be found in [`app/components/pajamas`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/app/components/pajamas). Also see our Lookbook (`http://gdk.test:3000/rails/lookbook`) for a more interactive way to browse our components. #### Alert @@ -155,7 +155,7 @@ For the full list of options, see its #### Checkbox tag -The `Pajamas::CheckboxTagComponent` follows the [Pajamas Checkbox](https://design.gitlab.com/components/checkbox) specification. +The `Pajamas::CheckboxTagComponent` follows the [Pajamas Checkbox](https://design.gitlab.com/components/checkbox/) specification. The `name` argument and `label` slot are required. @@ -176,7 +176,7 @@ For the full list of options, see its #### Checkbox -The `Pajamas::CheckboxComponent` follows the [Pajamas Checkbox](https://design.gitlab.com/components/checkbox) specification. +The `Pajamas::CheckboxComponent` follows the [Pajamas Checkbox](https://design.gitlab.com/components/checkbox/) specification. NOTE: `Pajamas::CheckboxComponent` is used internally by the [GitLab UI form builder](haml.md#use-the-gitlab-ui-form-builder) and requires an instance of [ActionView::Helpers::FormBuilder](https://api.rubyonrails.org/v6.1.0/classes/ActionView/Helpers/FormBuilder.html) to be passed as the `form` argument. diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index 505f480c410..3de74e2e048 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -85,6 +85,18 @@ To import these metrics, you can run: bundle exec rake 'gitlab:seed:development_metrics[your_project_id]' ``` +#### Seed a project with vulnerabilities + +You can seed a project with [security vulnerabilities](../user/application_security/vulnerabilities/index.md). + +```shell +# Seed all projects +bin/rake 'gitlab:seed:vulnerabilities' + +# Seed a specific project +bin/rake 'gitlab:seed:vulnerabilities[group-path/project-path]' +``` + ### Automation If you're very sure that you want to **wipe the current database** and refill diff --git a/doc/development/routing.md b/doc/development/routing.md index 16ed15fdcc6..8f475674c39 100644 --- a/doc/development/routing.md +++ b/doc/development/routing.md @@ -39,7 +39,7 @@ You can view and find routes from the console by running: rails routes | grep crm ``` -You can also view routes in your browser by going to [http://gdk.test:3000/rails/info/routes](http://gdk.test:3000/rails/info/routes). +You can also view routes in your browser by going to `http://gdk.test:3000/rails/info/routes`. ## Global routes diff --git a/doc/development/sec/analyzer_development_guide.md b/doc/development/sec/analyzer_development_guide.md index 002c2fa3581..dda738eb563 100644 --- a/doc/development/sec/analyzer_development_guide.md +++ b/doc/development/sec/analyzer_development_guide.md @@ -82,7 +82,7 @@ go build -o analyzer Video walkthrough of how Dependency Scanning analyzers are using [downstream pipeline](../../ci/pipelines/downstream_pipelines.md) feature to test analyzers using test projects: -[](http://www.youtube.com/watch?v=KauRBlfUbDE) +[](https://www.youtube.com/watch?v=KauRBlfUbDE) ### Testing local changes diff --git a/doc/development/spam_protection_and_captcha/exploratory_testing.md b/doc/development/spam_protection_and_captcha/exploratory_testing.md index e17d25acb9d..f6e3e6814a8 100644 --- a/doc/development/spam_protection_and_captcha/exploratory_testing.md +++ b/doc/development/spam_protection_and_captcha/exploratory_testing.md @@ -91,7 +91,7 @@ CAPTCHA response string does not matter. It can be any string. If you use a real, valid key pair, you must solve the CAPTCHA to obtain a valid CAPTCHA response to use. You can do this once only, and only before it expires. -To directly test the GraphQL API via [GraphQL Explorer](http://gdk.test:3000/-/graphql-explorer), +To directly test the GraphQL API via GraphQL Explorer (`http://gdk.test:3000/-/graphql-explorer`), get a reCAPTCHA response string via this form: `public/recaptcha.html` (`http://gdk.test:3000/recaptcha.html`): ```html diff --git a/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md b/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md index fb5d5bbe379..abc46c52407 100644 --- a/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md +++ b/doc/development/stage_group_observability/dashboards/stage_group_dashboard.md @@ -56,7 +56,7 @@ description, note the following: To inspect the raw data of the panel for further calculation, select **Inspect** from the dropdown list of a panel. Queries, raw data, and panel JSON structure are available. -Read more at [Grafana panel inspection](http://grafana.com/docs/grafana/next/panels/query-a-data-source/). +Read more at [Grafana panel inspection](https://grafana.com/docs/grafana/latest/panels-visualizations/query-transform-data/). All the dashboards are powered by [Grafana](https://grafana.com/), a frontend for displaying metrics. Grafana consumes the data returned from queries to backend Prometheus data source, then presents it |