Commit Graph

150 Commits

Author SHA1 Message Date
Markus Koller 4027acf504
Clarify the process for CE-first documentation
Previously it was unclear if the docs changes should be included in
the MR as well, and adding a changelog entry in the CE MR also triggers
the ee-specific-lines-check job in CI.
2019-06-05 12:38:56 +02:00
Achilleas Pipinellis 8ec7ecf0bc
Use relative URLs in development docs
This is part of https://gitlab.com/gitlab-org/gitlab-ce/issues/61945
2019-05-27 11:13:40 -04:00
Achilleas Pipinellis 7786a0383d
Remove doc/README.md from list of pending files 2019-05-17 11:50:43 -07:00
Achilleas Pipinellis b453fc7375
Add info about the single docs codebase effort 2019-05-08 17:18:06 -05:00
Evan Read c15adde954 Final review feedback applied 2019-05-02 09:55:41 +10:00
Evan Read f7be93a871 Adjust guidance based on feedback 2019-05-02 09:49:52 +10:00
Evan Read 5d4c926d22 Change the guidance for version text 2019-05-02 09:49:52 +10:00
Evan Read f185e4bf9e Adjust how we do version text in docs 2019-05-02 09:49:52 +10:00
Evan Read c135061ff9 Avoid links requiring permissions 2019-04-29 09:33:08 +00:00
Evan Read 0ffb155994 Add whitespace for list so it renders 2019-04-23 12:06:56 +00:00
Achilleas Pipinellis 21600cc7ed Document how to use GitLab.com only badges
Functionality added in
https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/449
2019-04-22 12:11:50 +00:00
Mike Lewis 4fb50b53ce Fix anchor links 2019-04-17 21:55:50 +00:00
Mike Lewis 8b8fdad788 Fix capitalization of term 2019-04-17 21:37:54 +00:00
Mike Lewis d6d823c900 Reduce duplicate language by linking to a SSOT 2019-04-17 21:28:39 +00:00
Mike Lewis e2b960ff93 Resolve duplication of structure info by removing and linking to Style Guide 2019-04-17 21:21:12 +00:00
Mike Lewis 7d9476dc16 Initial content edits 2019-04-17 21:17:39 +00:00
Sid Sijbrandij ab52ff2e92 ssot as principle 2019-04-16 19:25:48 +00:00
Mike Lewis 5051f5b3d6 Development docs: move some docs content from Handbook and improve content/headings 2019-04-16 05:17:36 +00:00
Mike Lewis 92f0163bc7 Edits to documentation dev doc index 2019-04-08 17:37:45 +00:00
Mike Lewis 64ad62bd91 Improvements to Documentation style and structure information 2019-04-08 17:01:49 +00:00
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