Commit Graph

130 Commits

Author SHA1 Message Date
Marcel Amirault b41b03d47c Docs: Fix missed or newly added broken anchors 2019-03-25 04:56:57 +00:00
Evan Read 1cfe83ea5e Change line length recommendation 2019-03-14 10:57:40 +00:00
Marcel Amirault 9c8dc7ddf6 Docs: Fix broken anchors in development docs 2019-03-05 13:06:32 +00:00
Evan Read 2ee23bb312 Add confidential issue linking guidance 2019-03-01 19:07:47 +00:00
Takuya Noguchi e8fee6b8f7 Fix misspellings in docs
Signed-off-by: Takuya Noguchi <takninnovationresearch@gmail.com>
2019-02-25 10:31:35 +09:00
Evan Read eb86630959 Ensure all lists are surrounded by new lines
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.
2019-02-22 13:17:10 +00:00
Mike Lewis a2a8d91dea Minor fixes to development/documentation docs, mostly aligning all link text to relevant page names 2019-02-21 16:56:24 +00:00
Mike Lewis fc3975a553 Update some headers to remove apostrophes 2019-02-19 18:34:10 +00:00
Mike Lewis 07c32a0df5 Merge branch 'master' into 'template-improvements-for-documentation'
# Conflicts:
#   .gitlab/merge_request_templates/Documentation.md
2019-02-18 21:38:24 +00:00
Mike Lewis d4aa26176d Update feature-change-workflow to clarify who can create follow-up TW review issue 2019-02-18 21:20:40 +00:00
Mike Lewis f0c1bae7db Update improvement-workflow re who creates and confirms tech writer review issues 2019-02-18 21:10:26 +00:00
Evan Read 47fb1c5235 Remove consecutive blank lines from markdown files
For the sake of consistency, removes any extraneous
consecutive blank lines from the doc suite.
2019-02-18 09:36:13 +00:00
Mike Lewis 23b781057b Remove numbers from headers 2019-02-14 15:15:47 +00:00
Mike Lewis 2f66d23d93 Fix typo and updatee tech writer planning section 2019-02-14 15:06:49 +00:00
Mike Lewis e1a1ca0ed8 Edits to feature-change-workflow.md 2019-02-14 14:59:51 +00:00
k-nakayama-pg 70c6628076 Fix a typo 2019-02-12 11:36:04 +00:00
Mike Lewis 181db28385 Merge branch 'master' into 'template-improvements-for-documentation'
# Conflicts:
#   .gitlab/issue_templates/Feature proposal.md
2019-02-11 21:20:33 +00:00
Evan Read 91b88e0be4 Merge branch 'docs-correct-word' into 'master'
Docs: correct word

See merge request gitlab-org/gitlab-ce!25065
2019-02-11 05:52:43 +00:00
Merve 4d4af21a83 Docs: correct word 2019-02-09 13:23:45 +00:00
Mike Lewis 30b4b42e2f Add Documentation requirements section 2019-02-08 18:15:41 +00:00
Mike Lewis 53840eacc9 Simplify doc work discussion in feature-change-workflow.md 2019-02-07 03:29:03 +00:00
Evan Read 82a6f87ed0 Fix many 'when manual' anchors 2019-02-06 14:14:23 +10:00
Achilleas Pipinellis 34908dd284 Merge branch 'docs-correct-link' into 'master'
Docs: corrects link

See merge request gitlab-org/gitlab-ce!24865
2019-02-04 08:44:49 +00:00
Merve f72722dead Docs: Corrects link 2019-01-31 19:30:14 +00:00
Mike Lewis 8205f1e18b Merge branch 'master' into 'template-improvements-for-documentation'
# Conflicts:
#   .gitlab/issue_templates/Feature proposal.md
2019-01-30 18:29:17 +00:00
Mike Lewis ad8b8aa98c Add more detail on deciding when to have TW review 2019-01-30 17:48:08 +00:00
Marcia Ramos 7aa251308f Fixes a typo 2019-01-24 14:19:22 +00:00
Marcia Ramos 0bfd119ee1 Document docs style exceptions 2019-01-24 13:46:51 +00:00
Evan Read c2c2d04b3a Fix most instances of bare URLs in markdown 2019-01-24 06:52:33 +00:00
Mike Lewis f8e6a3957e Minor edits to feature-change-workflow.md 2019-01-23 15:26:42 +00:00
Mike Lewis 6dfa8538b1 Update improvement workflow 2019-01-23 05:53:14 +00:00
Mike Lewis c4d1aa97f6 Additional edits to feature workflow 2019-01-18 04:13:39 +00:00
Mike Lewis 1f54c38140 Merge branch 'master' into 'template-improvements-for-documentation'
# Conflicts:
#   .gitlab/issue_templates/Feature proposal.md
2019-01-18 02:59:01 +00:00
Mike Lewis 75cf4bdf93 Update improvement workflow 2019-01-17 23:07:01 +00:00
Mike Lewis 77f3cbc008 Update the feature change workflow 2019-01-17 22:37:02 +00:00
Evan Read c9f2ccaea1 Promote sections and minor improvements 2019-01-16 11:56:07 +10:00
Evan Read ca74ba9777 Document four backticks feature in markdown 2019-01-15 13:20:52 +00:00
Achilleas Pipinellis a45c223606
Fix indentation and markup for Markdown codeblock 2019-01-11 12:48:37 +01:00
Achilleas Pipinellis b7b7d014f5 Merge branch 'docs/fix-styleguide' into 'master'
Fix broken markdown and other lint problems

See merge request gitlab-org/gitlab-ce!24208
2019-01-09 09:55:25 +00:00
carla 50f5f3c721 docs: Fix 'Gilab' typo 2019-01-09 06:28:01 +00:00
Evan Read 868d8ec6e7 Fix broken markdown and other lint problems 2019-01-09 10:37:25 +10:00
Evan Read 4671cb7836 Add API topic template 2019-01-07 14:11:39 +10:00
Evan Read 2268ddc7de Implement some review comments
Also:

- Slight restructure.
- Some Markdown improvements.
2019-01-07 14:11:39 +10:00
Evan Read 40aba81218 Add new styleguide sections for verbs
Also fixes spelling, and makes the Markdown style more consistent.
2019-01-07 14:06:55 +10:00
Evan Read c86f86adcd Merge branch 'docs/fake-token-no-more' into 'master'
Do not use tokens that look like tokens in docs

Closes #38064

See merge request gitlab-org/gitlab-ce!24044
2019-01-07 01:40:05 +00:00
Marcia Ramos 550126f1a5 Fixes broken link 2019-01-04 18:26:00 +00:00
Achilleas Pipinellis 0e078d1a8a
Replace look-alike token with '<your_access_token>'
Replace all '9koXpg98eAheJpvBs5tK' occurrences with
'<your_access_token>' in API docs.
2019-01-04 13:19:27 +01:00
carla 7904f92d26 Make correction to URL, from https://about.gitab.com/handbook/documentation/ to https://about.gitlab.com/handbook/documentation/ (I searched to see if this is a duplicate of an existing fix, didn't find one) 2019-01-04 03:19:42 +00:00
Mike Lewis a4e7b7704e Add to the 'how to update' section 2018-12-31 20:35:24 +00:00
Mike Lewis 35e5833df4 Fixed typo in structure.md link 2018-12-31 20:20:55 +00:00