Marcel Amirault authored 5 years ago and Evan Read committed 5 years ago

Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc

Marcel Amirault authored 5 years ago and Achilleas Pipinellis committed 5 years ago

Use of square brackets can cause kramdown warnings, as well
as angle brackets, so they should be removed or put in backticks

Marcel Amirault authored 5 years ago and Evan Read committed 5 years ago

Following the single docs codebase change, all internal links
should be relative. Also cleans up one table

Marcel Amirault authored 5 years ago and Achilleas Pipinellis committed 5 years ago

Many code blocks are 4spaced, and they render in GitLab
without coloring as a result, even though they are
fenced with a language label. If in a list, other items
will render as being in a code block too, even if not
meant to. This fixes all these issues, and cleans up
minor white space issues in install and integration docs

This is an initiative to ensure all documentation complies completely
with the Documentation Style Guide section "Documentation is the single
source of truth (SSOT)" according to this epic
https://gitlab.com/groups/gitlab-org/-/epics/1280.

In particular, the changes of this commit touch all files under
doc/install/. Most notably:

- install/redis.md:
        Redirect to Redis section of install guide.

- install/pivotal/index.md:
        Changed its content to reflect the current status, which is no
        longer supported (since 2017!).

- install/google-protobuf.md:
        Incorporated inside installation.md under the troubleshooting section.

- install/openshift_and_gitlab.md:
        Clarified that this guide is no longer relevant. We might want to
        redirect to the Chart docs in the future.

- install/structure.md:
        Incorporated inside installation.md under its own section.

- install/kubernetes/index.md:
        Redirected to https://docs.gitlab.com/charts

Evan Read authored 6 years ago and Achilleas Pipinellis committed 6 years ago

Markdown renderers find it easier to determine
where lists start and end when lists are surrounded
by new lines.

For consistency, also ensure entries in the list
are aligned when they span multipls lines.

Evan Read authored 6 years ago and Achilleas Pipinellis committed 6 years ago

For the sake of consistency, removes any extraneous
consecutive blank lines from the doc suite.

Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>