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

Do not use dollar signs in shell codeblocks when
no output is shown

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

Clean up capitalization in /development /gitlab-basics and
/install

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

Deletes extra spaces and line, makes lists consistent, and
fixes links.

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

Emilie Schario authored 5 years ago and Achilleas Pipinellis committed 5 years ago

Make clearer that the memory team is working
to reduce the memory requirement

Part of: https://gitlab.com/gitlab-org/gitaly/issues/1715

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

Fix links as discovered by the lint in the docs project

I'm adding some wording to our hardware requirements to explain that needs vary
by workload. I also included some examples of factors that may influence the
workload.

Update the Unicorn worker documentation based on the new scaling
formula.

https://gitlab.com/gitlab-org/omnibus-gitlab/issues/4535

* Use `GiB memory` to describe memory needs.
* Add local storage recommendation for monitoring node.
* Better align CPU/Memory to match common cloud provider instnace types.
* Update requirements based on the new 10k user standard.

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

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

Updating redirected links in the development, install, policy
raketasks and university dirs. Should now link to final
URL to avoid redirect hops

The installation link has changed from /installation/ to /install/. This
commit will update all the remaining links that are missing.

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

Previously, we used brackets to denote the tier badges,
but this made Kramdown, the docs site Markdown renderer,
show many warnings when building the site. This is now
fixed by using parentheses instead of square brackets.

This was caused by [PREMIUM] looking like a link to
Kramdown, which couldn't find a URL there.

See:
- https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/484
- https://gitlab.com/gitlab-org/gitlab-ce/issues/63800

Kyohei Uemura authored 5 years ago and Achilleas Pipinellis committed 5 years ago

Line 170(make install) causes permission error.
This command should execute with sudo.

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

Change assorted absolute links to ce and ee docs
to relative links

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

Add backticks around square brackets, or fix links, as necessary.

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

Linting rule not enabled for now
because tooling produces false
positives.

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

Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass