Merge branch 'fc-ci-config-viz-documenation' into 'master'

Add documentation for CI config visualization

See merge request gitlab-org/gitlab!45044

doc/ci/README.md

@@ -73,6 +73,8 @@ 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 facilate your writing experience.
+
 For a broader overview, see the [CI/CD getting started](quick_start/README.md) guide.
 
 Once you're familiar with how GitLab CI/CD works, see the

doc/ci/quick_start/README.md

@@ -112,6 +112,9 @@ What is important is that each job is run independently from each other.
 If you want to check whether the `.gitlab-ci.yml` of your project is valid, there is a
 [CI Lint tool](../lint.md) available in every project.
 
+You can use the [CI/CD configuration visualization](../yaml/visualization.md) to
+see a graphical representation of your `.gitlab-ci.yml`.
+
 For more information and a complete `.gitlab-ci.yml` syntax, please read
 [the reference documentation on `.gitlab-ci.yml`](../yaml/README.md).
 

doc/ci/yaml/visualization.md

+# Visualize your CI/CD configuration
+
+> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/241722) in GitLab 13.5.
+> - 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)**
+
+CAUTION: **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 any CI/CD
+configuration file and click on 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_5.png)
+
+Hovering on a job highlights its `needs` relationships:
+
+![CI Config Visualization on hover](img/ci_config_visualization_hover_v13_5.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(:gitlab_ci_yml_preview)
+```
+
+To disable it:
+
+```ruby
+Feature.disable(:gitlab_ci_yml_preview)
+```