Improve usabilty of user documentation #1667
This issue is for capturing actions arising from @horenmar 's request on Discord of 2019-06-15 "Help wanted: documentation"
We (Clare and Martin, in discussion) have agreed we'll stick with Markdown for now and see how far we can get with improving the docs - so moving to things that need a separate rendering/processing step e.g. sphinx, Doxygen, ASCIIdoc is out of scope for this ticket
Types of user
The intention is to consider 3 categories of user:
Examples of the kind of thing wanted:
Pages - and actions for them
I had a look at the "Introduced in GitLab 11.11." text in gitlab https://docs.gitlab.com/ee/ci/variables/#variable-types to see how they formatted it, and if they had any automated processing.
It looks like simple markdown:
> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/46806) in GitLab 11.11.