Docs: Improve the why and how for the include keyword for CI/CD

What does this MR do?

For the Contribute Challenge 2020 I want to help improve the documentation regarding the CI keywords.

Today I was preparing my GitLab meetup demo, and struggled from creating a symlink for the .gitlab-ci.yml file. I've then found an issue comment suggesting to use include.

I had opened the docs and I needed to read the entire section with all different methods in order to understand how include works and how I might use that for symlinks.

This MR does the following:

• Add the why in the introduction, structured CI config and avoiding clutter is important
• Moves the methods from a list into a table and adding a short description that you immediately know which one you are looking at. Local file, makes sense - remote file, maybe not. Template - ah, that's just the GitLab templates known from the editor. No need to read further.
• Changes the structure a bit moving the important overview on the top
• Moves the templates to the last one, local, file and remote are equally the same, templates is different.

Related issues

#17090 (comment 214945841)

Author's checklist (required)

• Follow the Documentation Guidelines and Style Guide.
• Apply the documentation label, plus:
  • The corresponding DevOps stage and group label, if applicable.
  • development guidelines when changing docs under doc/development/*, CONTRIBUTING.md, or README.md.
  • development guidelines and Documentation guidelines when changing docs under development/documentation/*.
  • development guidelines and Description templates (.gitlab/*) when creating/updating issue and MR description templates.
• Assign the designated Technical Writer.

When applicable:

• Update the permissions table.
• Link docs to and from the higher-level index page, plus other related docs where helpful.
• Add GitLab's version history note(s).
• Add the product tier badge.
• Add/update the feature flag section.
• If you're changing document headings, search doc/*, app/views/*, and ee/app/views/* for old headings replacing with the new ones to avoid broken anchors.

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

• Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

• Optional: Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.
  • Add Technical Writing and docs:: workflow label.
  • Add docs-only when the only files changed are under doc/*.

3. Maintainer

1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
2. Ensure a release milestone is set.
3. If there has not been a technical writer review, create an issue for one using the Doc Review template.