diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-12 09:09:55 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-03-12 09:09:55 +0000 |
commit | 18f7828977b74bf6e5153594a098ef90e773b3b7 (patch) | |
tree | 49cb1e16d5341d773807ee583357ae6eb167d61f /doc | |
parent | 8191b1571c017378eac33b3ed296ad5216d0a410 (diff) | |
download | gitlab-ce-18f7828977b74bf6e5153594a098ef90e773b3b7.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/integration/plantuml.md | 4 | ||||
-rw-r--r-- | doc/api/graphql/reference/gitlab_schema.json | 83 | ||||
-rw-r--r-- | doc/api/project_import_export.md | 16 | ||||
-rw-r--r-- | doc/ci/jenkins/index.md | 21 | ||||
-rw-r--r-- | doc/development/contributing/issue_workflow.md | 4 | ||||
-rw-r--r-- | doc/development/documentation/styleguide.md | 12 | ||||
-rw-r--r-- | doc/user/application_security/img/outdated_report_branch_v12_9.png | bin | 0 -> 15172 bytes | |||
-rw-r--r-- | doc/user/application_security/img/outdated_report_pipeline_v12_9.png | bin | 0 -> 16694 bytes | |||
-rw-r--r-- | doc/user/application_security/index.md | 29 | ||||
-rw-r--r-- | doc/user/asciidoc.md | 4 | ||||
-rw-r--r-- | doc/user/markdown.md | 42 |
11 files changed, 176 insertions, 39 deletions
diff --git a/doc/administration/integration/plantuml.md b/doc/administration/integration/plantuml.md index 144076ccb79..009a1a247c0 100644 --- a/doc/administration/integration/plantuml.md +++ b/doc/administration/integration/plantuml.md @@ -122,12 +122,12 @@ our AsciiDoc snippets, wikis and repos using delimited blocks: - **Markdown** - ~~~markdown + ````markdown ```plantuml Bob -> Alice : hello Alice -> Bob : hi ``` - ~~~ + ```` - **AsciiDoc** diff --git a/doc/api/graphql/reference/gitlab_schema.json b/doc/api/graphql/reference/gitlab_schema.json index 0f0abf25047..3c0835a3605 100644 --- a/doc/api/graphql/reference/gitlab_schema.json +++ b/doc/api/graphql/reference/gitlab_schema.json @@ -4988,6 +4988,20 @@ "deprecationReason": null }, { + "name": "descendantWeightSum", + "description": "Total weight of open and closed issues in the epic and its descendants. Available only when feature flag `unfiltered_epic_aggregates` is enabled.", + "args": [ + + ], + "type": { + "kind": "OBJECT", + "name": "EpicDescendantWeights", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "description", "description": "Description of the epic", "args": [ @@ -9738,6 +9752,20 @@ "deprecationReason": null }, { + "name": "healthStatus", + "description": "Current health status. Available only when feature flag `save_issuable_health_status` is enabled.", + "args": [ + + ], + "type": { + "kind": "ENUM", + "name": "HealthStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "id", "description": "Global ID of the epic-issue relation", "args": [ @@ -11118,6 +11146,20 @@ "deprecationReason": null }, { + "name": "healthStatus", + "description": "Current health status. Available only when feature flag `save_issuable_health_status` is enabled.", + "args": [ + + ], + "type": { + "kind": "ENUM", + "name": "HealthStatus", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { "name": "iid", "description": "Internal ID of the issue", "args": [ @@ -13100,6 +13142,47 @@ }, { "kind": "OBJECT", + "name": "EpicDescendantWeights", + "description": "Total weight of open and closed descendant issues", + "fields": [ + { + "name": "closedIssues", + "description": "Total weight of completed (closed) issues in this epic, including epic descendants", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + }, + { + "name": "openedIssues", + "description": "Total weight of opened issues in this epic, including epic descendants", + "args": [ + + ], + "type": { + "kind": "SCALAR", + "name": "Int", + "ofType": null + }, + "isDeprecated": false, + "deprecationReason": null + } + ], + "inputFields": null, + "interfaces": [ + + ], + "enumValues": null, + "possibleTypes": null + }, + { + "kind": "OBJECT", "name": "EpicHealthStatus", "description": "Health status of child issues", "fields": [ diff --git a/doc/api/project_import_export.md b/doc/api/project_import_export.md index d1aaa01d37c..476abc18835 100644 --- a/doc/api/project_import_export.md +++ b/doc/api/project_import_export.md @@ -61,14 +61,20 @@ curl --header "PRIVATE-TOKEN: <your_access_token>" https://gitlab.example.com/ap Status can be one of: - `none` +- `queued` - `started` -- `after_export_action` - `finished` +- `regeneration_in_progress` -The `after_export_action` state represents that the export process has been completed successfully and -the platform is performing some actions on the resulted file. For example, sending -an email notifying the user to download the file, uploading the exported file -to a web server, etc. +`queued` state represents the request for export is received, and is currently in the queue to be processed. + +The `started` state represents that the export process has started and is currently in progress. +It includes the process of exporting, actions performed on the resultant file such as sending +an email notifying the user to download the file, uploading the exported file to a web server, etc. + +`finished` state is after the export process has completed and the user has been notified. + +`regeneration_in_progress` is when an export file is available to download, and a request to generate a new export is in process. `_links` are only present when export has finished. diff --git a/doc/ci/jenkins/index.md b/doc/ci/jenkins/index.md index 3caea124351..fe937bb1f3a 100644 --- a/doc/ci/jenkins/index.md +++ b/doc/ci/jenkins/index.md @@ -19,7 +19,26 @@ to GitLab! If you have questions that are not answered here, the [GitLab community forum](https://forum.gitlab.com/) can be a great resource. -## Important differences +## Managing the organizational transition + +An important part of transitioning from Jenkins to GitLab is the cultural and organizational +changes that comes with the move, and successfully managing them. There are a few +things we have found that helps this: + +- Setting and communicating a clear vision of what your migration goals are helps + your users understand why the effort is worth it. The value will be clear when + the work is done, but people need to be aware while it's in progress too. +- Sponsorship and alignment from the relevant leadership team helps with the point above. +- Spending time educating your users on what's different, sharing this document with them, + and so on will help ensure you are successful. +- Finding ways to sequence or delay parts of the migration can help a lot, but you + don't want to leave things in a non-migrated (or partially-migrated) state for too + long. To gain all the benefits of GitLab, moving your existing Jenkins setup over + as-is, including any current problems, will not be enough. You need to take advantage + of the improvements that GitLab offers, and this requires (eventually) updating + your implementation as part of the transition. + +## Important product differences There are some high level differences between the products worth mentioning: diff --git a/doc/development/contributing/issue_workflow.md b/doc/development/contributing/issue_workflow.md index ab9c543f507..a00f7cff651 100644 --- a/doc/development/contributing/issue_workflow.md +++ b/doc/development/contributing/issue_workflow.md @@ -56,7 +56,7 @@ All labels, their meaning and priority are defined on the [labels page](https://gitlab.com/gitlab-org/gitlab/-/labels). If you come across an issue that has none of these, and you're allowed to set -labels, you can _always_ add the team and type, and often also the subject. +labels, you can _always_ add the type, stage, group, and often the category/feature labels. ### Type labels @@ -75,7 +75,7 @@ A number of type labels have a priority assigned to them, which automatically makes them float to the top, depending on their importance. Type labels are always lowercase, and can have any color, besides blue (which is -already reserved for subject labels). +already reserved for category labels). The descriptions on the [labels page](https://gitlab.com/groups/gitlab-org/-/labels) explain what falls under each type label. diff --git a/doc/development/documentation/styleguide.md b/doc/development/documentation/styleguide.md index 9381082af85..2ae3cd0a290 100644 --- a/doc/development/documentation/styleguide.md +++ b/doc/development/documentation/styleguide.md @@ -476,7 +476,7 @@ as the list item. This can be done with: Items nested in lists should always align with the first character of the list item. In unordered lists (using `-`), this means two spaces for each level of indentation: -~~~md +````markdown - Unordered list item 1 A line nested using 2 spaces to align with the `U` above. @@ -495,11 +495,11 @@ In unordered lists (using `-`), this means two spaces for each level of indentat - Unordered list item 4 ![an image that will nest inside list item 4](image.png) -~~~ +```` For ordered lists, use three spaces for each level of indentation: -~~~md +````markdown 1. Ordered list item 1 A line nested using 3 spaces to align with the `O` above. @@ -518,7 +518,7 @@ For ordered lists, use three spaces for each level of indentation: 1. Ordered list item 4 ![an image that will nest inside list item 4](image.png) -~~~ +```` You can nest full lists inside other lists using the same rules as above. If you wish to mix types, that is also possible, as long as you don't mix items at the same level: @@ -1364,7 +1364,7 @@ on this document. Further explanation is given below. The following can be used as a template to get started: -~~~md +````markdown ## Descriptive title One or two sentence description of what endpoint does. @@ -1392,7 +1392,7 @@ Example response: } ] ``` -~~~ +```` ### Fake tokens diff --git a/doc/user/application_security/img/outdated_report_branch_v12_9.png b/doc/user/application_security/img/outdated_report_branch_v12_9.png Binary files differnew file mode 100644 index 00000000000..6e23cf04b26 --- /dev/null +++ b/doc/user/application_security/img/outdated_report_branch_v12_9.png diff --git a/doc/user/application_security/img/outdated_report_pipeline_v12_9.png b/doc/user/application_security/img/outdated_report_pipeline_v12_9.png Binary files differnew file mode 100644 index 00000000000..2bb1fcaa302 --- /dev/null +++ b/doc/user/application_security/img/outdated_report_pipeline_v12_9.png diff --git a/doc/user/application_security/index.md b/doc/user/application_security/index.md index 8d7891fb973..4382c69a9ac 100644 --- a/doc/user/application_security/index.md +++ b/doc/user/application_security/index.md @@ -198,6 +198,35 @@ An approval is optional when a license report: - Contains no software license violations. - Contains only new licenses that are `approved` or unknown. +## Outdated security reports + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/4913) in GitLab 12.7. + +When a security report generated for a merge request becomes outdated, the merge request shows a warning +message in the security widget and prompts you to take an appropriate action. + +This can happen in two scenarios: + +1. Your [source branch is behind the target branch](#source-branch-is-behind-the-target-branch). +1. The [target branch security report is out of date](#target-branch-security-report-is-out-of-date). + +### Source branch is behind the target branch + +This means the most recent common ancestor commit between the target branch and the source branch is +not the most recent commit on the target branch. This is by far the most common situation. + +In this case you must rebase or merge to incorporate the changes from the target branch. + +![Incorporate target branch changes](img/outdated_report_branch_v12_9.png) + +### Target branch security report is out of date + +This can happen for many reasons, including failed jobs or new advisories. When the merge request shows that a +security report is out of date, you must run a new pipeline on the target branch. +You can do it quickly by following the hyperlink given to run a new pipeline. + +![Run a new pipeline](img/outdated_report_pipeline_v12_9.png) + ## Troubleshooting ### Getting error message `sast job: stage parameter should be [some stage name here]` diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index da6bf287955..b9b346d3be4 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -282,11 +282,11 @@ source - a listing that is embellished with (colorized) syntax highlighting ---- ``` -~~~asciidoc +````asciidoc \```language fenced code - a shorthand syntax for the source block \``` -~~~ +```` ```asciidoc [,attribution,citetitle] diff --git a/doc/user/markdown.md b/doc/user/markdown.md index c8484380127..72570848a61 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -165,7 +165,7 @@ Visit the [official page](https://mermaidjs.github.io/) for more details. If you In order to generate a diagram or flowchart, you should write your text inside the `mermaid` block: -~~~ +````markdown ```mermaid graph TD; A-->B; @@ -173,7 +173,7 @@ graph TD; B-->D; C-->D; ``` -~~~ +```` ```mermaid graph TD; @@ -185,7 +185,7 @@ graph TD; Subgraphs can also be included: -~~~ +````markdown ```mermaid graph TB @@ -202,7 +202,7 @@ graph TB SubGraph1 --> FinalThing[Final Thing] end ``` -~~~ +```` ```mermaid graph TB @@ -280,27 +280,27 @@ The following delimiters are supported: - YAML (`---`): - ~~~yaml + ```yaml --- title: About Front Matter example: language: yaml --- - ~~~ + ``` - TOML (`+++`): - ~~~toml + ```toml +++ title = "About Front Matter" [example] language = "toml" +++ - ~~~ + ``` - JSON (`;;;`): - ~~~json + ```json ;;; { "title": "About Front Matter" @@ -309,7 +309,7 @@ The following delimiters are supported: } } ;;; - ~~~ + ``` Other languages are supported by adding a specifier to any of the existing delimiters. For example: @@ -364,7 +364,7 @@ Math written between dollar signs `$` will be rendered inline with the text. Mat inside a [code block](#code-spans-and-blocks) with the language declared as `math`, will be rendered on a separate line: -~~~ +````markdown This math is inline $`a^2+b^2=c^2`$. This is on a separate line @@ -372,7 +372,7 @@ This is on a separate line ```math a^2+b^2=c^2 ``` -~~~ +```` This math is inline $`a^2+b^2=c^2`$. @@ -613,12 +613,12 @@ Inline `code` has `back-ticks around` it. --- -Similarly, a whole block of code can be fenced with triple backticks ```` ``` ````, +Similarly, a whole block of code can be fenced with triple backticks (```` ``` ````), triple tildes (`~~~`), or indented 4 or more spaces to achieve a similar effect for a larger body of code. -~~~ -``` +````markdown +```python def function(): #indenting works just fine in the fenced code block s = "Python code" @@ -628,7 +628,7 @@ def function(): Using 4 spaces is like using 3-backtick fences. -~~~ +```` ```plaintext ~~~ @@ -651,9 +651,9 @@ is like using 3-backtick fences. ``` -~~~plaintext +```plaintext Tildes are OK too. -~~~ +``` #### Colored code and syntax highlighting @@ -665,10 +665,10 @@ highlighting in code blocks. For a list of supported languages visit the Syntax highlighting is only supported in code blocks, it is not possible to highlight code when it is inline. -Blocks of code are fenced by lines with three back-ticks ```` ``` ```` or three tildes `~~~`, and have +Blocks of code are fenced by lines with three back-ticks (```` ``` ````) or three tildes (`~~~`), and have the language identified at the end of the first fence: -~~~markdown +````markdown ```javascript var s = "JavaScript syntax highlighting"; alert(s); @@ -692,7 +692,7 @@ No language indicated, so no syntax highlighting. s = "There is no highlighting for this." But let's throw in a <b>tag</b>. ``` -~~~ +```` The four examples above render as: |