Merge branch '297367-pipeline-editor-documentation' into 'master'

Adds the pipeline editor documentation

See merge request gitlab-org/gitlab!51461

doc/ci/README.md

@@ -73,7 +73,7 @@ to your needs:
 
 ![Use a `.gitlab-ci.yml` template](img/add_file_template_11_10.png)
 
-While building your `.gitlab-ci.yml`, you can use the [CI/CD configuration visualization](yaml/visualization.md) to facilitate your writing experience.
+While building your `.gitlab-ci.yml`, you can use the [CI/CD configuration visualization](pipeline_editor/index.md#visualize-ci-configuration) to facilitate your writing experience.
 
 For a broader overview, see the [CI/CD getting started](quick_start/README.md) guide.
 

doc/ci/pipeline_editor/index.md

+---
+stage: Verify
+group: Pipeline Authoring
+info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+type: reference
+---
+
+# Pipeline Editor **(CORE)**
+
+> - [Introduced](https://gitlab.com/groups/gitlab-org/-/epics/4540) in GitLab 13.8.
+> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default.
+> - It's disabled on GitLab.com.
+> - It's not recommended for production use.
+> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-pipeline-editor). **(CORE ONLY)**
+
+WARNING:
+This feature might not be available to you. Check the **version history** note above for details.
+
+The pipeline editor is the primary place to edit the GitLab CI/CD configuration in
+your `.gitlab-ci.yml` file. To access it, go to **CI/CD > Editor**.
+
+From the pipeline editor page you can:
+
+- [Validate](#validate-ci-configuration) your configuration syntax while editing the file.
+- Do a deeper [lint](#lint-ci-configuration) of your configuration, that verifies it with any configuration
+  added with the [`include`](../yaml/README.md#include) keyword.
+- See a [visualization](#visualize-ci-configuration) of the current configuration.
+- [Commit](#commit-changes-to-ci-configuration) the changes to a specific branch.
+
+NOTE:
+You must have already [created a CI/CD configuration file](../quick_start/README.md#create-a-gitlab-ciyml-file)
+to use the editor.
+
+## Validate CI configuration
+
+As you edit your pipeline configuration, it is continually validated against the GitLab CI/CD
+pipeline schema. It checks the syntax of your CI YAML configuration, and also runs
+some basic logical validations.
+
+The result of this validation is shown at the top of the editor page. If your configuration
+is invalid, a tip is shown to help you fix the problem:
+
+![Errors in a CI configuration validation](img/pipeline_editor_validate_v13_8.png)
+
+## Lint CI configuration
+
+To test the validity of your GitLab CI/CD configuration before committing the changes,
+you can use the CI lint tool. To access it, go to **CI/CD > Editor** and select the **Lint** tab.
+
+This tool checks for syntax and logical errors but goes into more detail than the
+automatic [validation](#validate-ci-configuration) in the editor.
+
+The results are updated in real-time. Any changes you make to the configuration are
+reflected in the CI lint. It displays the same results as the existing [CI Lint tool](../lint.md).
+
+![Linting errors in a CI configuration](img/pipeline_editor_lint_v13_8.png)
+
+## Visualize CI configuration
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241722) in GitLab 13.5.
+> - [Moved to **CI/CD > Editor**](https://gitlab.com/gitlab-org/gitlab/-/issues/263141) in GitLab 13.7.
+> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default.
+> - It's disabled on GitLab.com.
+> - It's not recommended for production use.
+> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-cicd-configuration-visualization). **(CORE ONLY)**
+
+WARNING:
+This feature might not be available to you. Check the **version history** note above for details.
+
+To see a visualization of your `gitlab-ci.yml` configuration, navigate to **CI/CD > Editor**
+and select the `visualization` tab. The visualization shows all stages and jobs.
+[`needs`](../yaml/README.md#needs) relationships are displayed as lines connecting jobs together, showing the hierarchy of execution:
+
+![CI configuration Visualization](img/ci_config_visualization_v13_7.png)
+
+Hovering on a job highlights its `needs` relationships:
+
+![CI configuration visualization on hover](img/ci_config_visualization_hover_v13_7.png)
+
+If the configuration does not have any `needs` relationships, then no lines are drawn because
+each job depends only on the previous stage being completed successfully.
+
+### Enable or disable CI/CD configuration visualization **(CORE ONLY)**
+
+CI/CD configuration visualization is under development and not ready for production use. It is
+deployed behind a feature flag that is **disabled by default**.
+[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md)
+can enable it.
+
+To enable it:
+
+```ruby
+Feature.enable(:ci_config_visualization_tab)
+```
+
+To disable it:
+
+```ruby
+Feature.disable(:ci_config_visualization_tab)
+```
+
+## Commit changes to CI configuration
+
+The commit form appears at the bottom of each tab in the editor so you can commit
+your changes at any time.
+
+When you are satisfied with your changes, add a descriptive commit message and enter
+a branch. The branch field defaults to your project's default branch.
+
+If you enter a new branch name, the **Start a new merge request with these changes**
+checkbox appears. Select it to start a new merge request after you commit the changes.
+
+![The commit form with a new branch](img/pipeline_editor_commit_v13_8.png)
+
+## Enable or disable pipeline editor **(CORE ONLY)**
+
+The pipeline editor is under development and not ready for production use. It is
+deployed behind a feature flag that is **disabled by default**.
+[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md)
+can enable it.
+
+To enable it:
+
+```ruby
+Feature.enable(:ci_pipeline_editor_page)
+```
+
+To disable it:
+
+```ruby
+Feature.disable(:ci_pipeline_editor_page)
+```

doc/ci/quick_start/README.md

@@ -129,7 +129,7 @@ The pipeline starts when the commit is committed.
 
 - To validate your `.gitlab-ci.yml` file, use the
   [CI Lint tool](../lint.md), which is available in every project.
-- You can also use [CI/CD configuration visualization](../yaml/visualization.md) to
+- You can also use [CI/CD configuration visualization](../pipeline_editor/index.md#visualize-ci-configuration) to
   view a graphical representation of your `.gitlab-ci.yml` file.
 - For the complete `.gitlab-ci.yml` syntax, see
   [the `.gitlab-ci.yml` reference topic](../yaml/README.md).

doc/ci/yaml/gitlab_ci_yaml.md

@@ -27,7 +27,7 @@ The scripts are grouped into **jobs**, and jobs run as part of a larger
 **pipeline**. You can group multiple independent jobs into **stages** that run in a defined order.
 
 You should organize your jobs in a sequence that suits your application and is in accordance with
-the tests you wish to perform. To [visualize](visualization.md) the process, imagine
+the tests you wish to perform. To [visualize](../pipeline_editor/index.md#visualize-ci-configuration) the process, imagine
 the scripts you add to jobs are the same as CLI commands you run on your computer.
 
 When you add a `.gitlab-ci.yml` file to your

doc/ci/yaml/visualization.md

 ---
-stage: Verify
-group: Pipeline Authoring
-info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
+redirect_to: '../pipeline_editor/index.md#visualize-ci-configuration'
 ---
 
-# Visualize your CI/CD configuration
+This document was moved to [another location](../pipeline_editor/index.md#visualize-ci-configuration).
 
-> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241722) in GitLab 13.5.
-> - [Moved to **CI/CD > Editor**](https://gitlab.com/gitlab-org/gitlab/-/issues/263141) in GitLab 13.7.
-> - It's [deployed behind a feature flag](../../user/feature_flags.md), disabled by default.
-> - It's disabled on GitLab.com.
-> - It's not recommended for production use.
-> - To use it in GitLab self-managed instances, ask a GitLab administrator to [enable it](#enable-or-disable-cicd-configuration-visualization). **(CORE ONLY)**
-
-WARNING:
-This feature might not be available to you. Check the **version history** note above for details.
-
-To see a visualization of your `gitlab-ci.yml` configuration, navigate to **CI/CD > Editor**
-and select the `Visualization` tab. The visualization shows all stages and jobs.
-[`needs`](README.md#needs) relationships are displayed as lines connecting jobs together, showing the hierarchy of execution:
-
-![CI Config Visualization](img/ci_config_visualization_v13_7.png)
-
-Hovering on a job highlights its `needs` relationships:
-
-![CI Config Visualization on hover](img/ci_config_visualization_hover_v13_7.png)
-
-If the configuration does not have any `needs` relationships, then no lines are drawn because
-each job depends only on the previous stage being completed successfully.
-
-You can only preview one `gitlab-ci.yml` file at a time. Configuration imported with
-[`includes`](README.md#include) is ignored and not included in the visualization.
-
-## Enable or disable CI/CD configuration visualization **(CORE ONLY)**
-
-CI/CD configuration visualization is under development and not ready for production use. It is
-deployed behind a feature flag that is **disabled by default**.
-[GitLab administrators with access to the GitLab Rails console](../../administration/feature_flags.md)
-can enable it.
-
-To enable it:
-
-```ruby
-Feature.enable(:ci_config_visualization_tab)
-```
-
-To disable it:
-
-```ruby
-Feature.disable(:ci_config_visualization_tab)
-```
+<!-- This redirect file can be deleted after 2021-04-13. -->
+<!-- Before deletion, see: https://docs.gitlab.com/ee/development/documentation/#move-or-rename-a-page -->