Commit Graph

319 Commits

Author SHA1 Message Date
GitLab Bot 6e81d7f628 Add latest changes from gitlab-org/gitlab@master 2019-11-15 15:06:12 +00:00
GitLab Bot 57e3d49fc0 Add latest changes from gitlab-org/gitlab@master 2019-11-13 18:06:51 +00:00
GitLab Bot 3318518149 Add latest changes from gitlab-org/gitlab@master 2019-11-13 15:07:29 +00:00
GitLab Bot 9b8d0d898e Add latest changes from gitlab-org/gitlab@master 2019-11-01 06:06:29 +00:00
GitLab Bot c4edbefa45 Add latest changes from gitlab-org/gitlab@master 2019-10-24 18:07:05 +00:00
GitLab Bot 9bbb32b297 Add latest changes from gitlab-org/gitlab@master 2019-10-18 06:07:02 +00:00
GitLab Bot 8e45d25f7d Add latest changes from gitlab-org/gitlab@master 2019-10-16 18:08:01 +00:00
GitLab Bot 7b8ec6e718 Add latest changes from gitlab-org/gitlab@master 2019-10-15 18:06:01 +00:00
GitLab Bot 565fa11a26 Add latest changes from gitlab-org/gitlab@master 2019-10-14 21:06:30 +00:00
GitLab Bot 5ff1b520ba Add latest changes from gitlab-org/gitlab@master 2019-10-14 09:07:54 +00:00
GitLab Bot eccfaf7c24 Add latest changes from gitlab-org/gitlab@master 2019-10-14 06:06:06 +00:00
GitLab Bot 934c2d5cf0 Add latest changes from gitlab-org/gitlab@master 2019-10-14 03:06:12 +00:00
GitLab Bot 0dfbcd8f8b Add latest changes from gitlab-org/gitlab@master 2019-10-11 18:06:15 +00:00
GitLab Bot b4e072cbaf Add latest changes from gitlab-org/gitlab@master 2019-10-11 06:06:27 +00:00
GitLab Bot 77a7772c3b Add latest changes from gitlab-org/gitlab@master 2019-10-08 09:06:09 +00:00
GitLab Bot 94611567bd Add latest changes from gitlab-org/gitlab@master 2019-09-30 09:06:31 +00:00
GitLab Bot 45482d5a27 Add latest changes from gitlab-org/gitlab@master 2019-09-27 12:06:07 +00:00
GitLab Bot fbcb36880c Add latest changes from gitlab-org/gitlab@master 2019-09-25 06:06:16 +00:00
GitLab Bot 89861e72b7 Add latest changes from gitlab-org/gitlab@master 2019-09-23 06:06:19 +00:00
GitLab Bot 6cd5b7dbfa Add latest changes from gitlab-org/gitlab@master 2019-09-19 11:50:12 +00:00
GitLab Bot b3e0658cb1 Add latest changes from gitlab-org/gitlab@master 2019-09-19 09:06:27 +00:00
GitLab Bot b082790134 Add latest changes from gitlab-org/gitlab@master 2019-09-18 18:06:14 +00:00
GitLab Bot 80f61b4035 Add latest changes from gitlab-org/gitlab@master 2019-09-18 14:02:45 +00:00
GitLab Bot 4ab54c2233 Add latest changes from gitlab-org/gitlab@master 2019-09-17 14:16:34 +00:00
GitLab Bot e567b4c2df Add latest changes from gitlab-org/gitlab@master 2019-09-17 09:06:11 +00:00
Mike Lewis 9dc6df4feb Merge branch 'docs-sethgitlab-documentationwf' into 'master'
Update documentation requirements

See merge request gitlab-org/gitlab-ce!32222
2019-09-12 00:57:08 +00:00
Seth Berger 47a26caff2 Apply suggestion to doc/development/documentation/feature-change-workflow.md 2019-09-12 00:50:45 +00:00
Seth Berger 7d2c2cc3c5 Apply suggestion to doc/development/documentation/feature-change-workflow.md 2019-09-12 00:49:57 +00:00
Seth Berger 17451e8ce8 Apply suggestion to doc/development/documentation/feature-change-workflow.md 2019-09-12 00:47:39 +00:00
Mike Lewis 88d66248d0 Edits to Lists section of Documentation Style Guide 2019-09-10 07:35:40 +00:00
Paulo Ribeiro 06d4c54119 Correct typo in documentation 2019-09-09 12:51:41 +00:00
Marcel Amirault 3af112a822 Adjust markdown linting guidelines
Move details of markdownlint mostly to the documentation
index for a SSoT, and link apropriately
2019-09-05 13:56:15 +00:00
Evan Read 38c30b3ed5 Provide guidance on how docs global navigation should be structured 2019-09-05 08:56:17 +00:00
Marcel Amirault a52f394bc5 Docs james gill contribution 2019-09-02 13:25:40 +00:00
Ray Paik ee18bf57f3 Merge branch 'patch-78' into 'master'
Fixed spelling

See merge request gitlab-org/gitlab-ce!32432
2019-08-29 22:41:53 +00:00
Shan 9341406805 Fixed spelling 2019-08-29 21:41:42 +00:00
Shan 225fba83ca Fixed spelling 2019-08-29 21:34:41 +00:00
Evan Read 5c8545edf1 Merge branch 'docs/unlinking-emails' into 'master'
Remove a section for a now fixed bug

See merge request gitlab-org/gitlab-ce!32319
2019-08-28 06:36:58 +00:00
Achilleas Pipinellis 295b1b4d02
Remove a section for a now fixed bug
Those guidelines where based on
https://gitlab.com/gitlab-org/gitlab-docs/issues/311 which seems
to be fixed.
2019-08-28 08:10:00 +02:00
Marcel Amirault d7d218628f Fix markdown in various docs
Clean up issues that may cause the docs-lint
test to fail, such as trailing whitespace, no
EOF newline, blockquotes, etc
2019-08-28 06:06:34 +00:00
Seth Berger cf6d467de5 Update documentation requirements
Changed wording to allow features, upon approval to
ship without documentation.
2019-08-26 15:50:30 +00:00
Achilleas Pipinellis 6308a450c7 Fix link to issue template 2019-08-23 21:37:02 +00:00
Marcel Amirault afe4d3e5bb Update docs style for code blocks
Clarify rules for code blocks, including spaces
above and below, and to use tilde when code blocks
contain triple backticks
2019-08-16 12:06:00 +00:00
Achilleas Pipinellis 1ac21f7ae6
Add missing (FREE ONLY) docs tier badge 2019-08-13 10:49:06 +03:00
Marcel Amirault 15f9862bb9 Update list information in docs styleguide
Explain indentation more carefully, and expand examples
2019-08-13 00:57:36 +00:00
David Kartuzinski 49b598b631 Update styleguide.md - just a little typo. 2019-08-12 14:46:06 +00:00
Achilleas Pipinellis 0019ba3e89
Replace redirect_from with disqus_identifier in docs
Let's use disqus_identifier since this is a more
descriptive name. We will need redirect_from for
another purpose anyway (Nanoc redirects).
2019-08-08 00:25:18 +03:00
Marcel Amirault cc76259e8d Fix whitespace in ci docs
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 for most docs in
/development, and cleans up other whitespace issues too
2019-07-31 08:28:51 +00:00
Marcel Amirault 0f7d8c0421 Update links to relative
Following the single docs codebase change, all internal links
should be relative. Also cleans up one table
2019-07-25 22:49:13 +00:00
Marcel Amirault ac7746de01 Update guidance for EE doc submissions 2019-07-25 14:26:38 +00:00
Marcel Amirault d0a60a7525 Add info about mdl to documentation 2019-07-22 06:03:12 +00:00
Marcel Amirault 7da80b2d36 Update numbered lists for docs standards
Ensure that all numbered lists use only 1. and no other numbers.
Also ensure that numbered lists use proper spacing.
2019-07-19 02:20:32 +00:00
Marcel Amirault 746f547877 Fix unordered list spacing
Correct the spacing of unordered markdown lists
in docs, to maintain standards of documentation.
2019-07-18 01:15:58 +00:00
Marcia Ramos cb0edce20e Merge branch 'rename-gitlab-docs-repo' into 'master'
Move the gitlab-docs project under gitlab-org

See merge request gitlab-org/gitlab-ce!30620
2019-07-12 11:43:30 +00:00
Marcel Amirault 143872fa52 Remove trailing whitespace in docs
Remove unneeded trailing whitespace in lines in
/development /ci /api and /administration docs.
2019-07-12 08:15:38 +00:00
Achilleas Pipinellis 99f2c986b5
Move the gitlab-docs project under gitlab-org
Search and replace gitlab-com/gitlab-docs with gitlab-org/gitlab-docs.
For https://gitlab.com/gitlab-com/gitlab-docs/issues/310
2019-07-11 15:24:33 +03:00
Mike Lewis 8c44a7bcb5 Add link to epic for removing /help 2019-07-10 03:55:54 +00:00
Markus Koller 385233981a Centralize config for markdownlint
The configuration is currently only specified in CI, by moving it into
`.mdlrc` we get immediate feedback locally in supported editors.

To ensure `mdl` is available it's also added to the `Gemfile`, though
CI will still use the version installed in the `gitlab-docs-lint` image.
2019-07-09 03:01:04 +00:00
Marcel Amirault 73c6477b7e Changing badges to use parentheses not brackets
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
2019-07-08 08:50:38 +00:00
Marcel Amirault 6feda1df3b Change absolute links to relative
Change assorted absolute links to ce and ee docs
to relative links
2019-07-05 16:25:58 +00:00
Evan Read d05eebe1dd Fix most bare URLs in project
Linting rule not enabled for now
because tooling produces false
positives.
2019-07-02 08:50:00 +00:00
Marcia Ramos f1168386e4 Docs: update global nav document 2019-07-02 08:40:50 +00:00
Mike Lewis 1af71196c0 Update styleguide.md to add Notes usage guidelines 2019-07-01 04:28:18 +00:00
Marcel Amirault 20654fb9bf Enforce consistent prefix for bullet lists
Adjusts asterisks to hyphens in assorted docs to allow lint rule to pass
2019-07-01 03:36:23 +00:00
Evan Read f9c21cce60 Add diagram to site architecture docs 2019-06-28 07:52:02 +00:00
Marcia Ramos bd9a1f0dd0 Address Mike's review
- explictly say not to upload videos
- link videos from any YT account
- embed videos from GL's YT account only
2019-06-27 16:48:02 +00:00
Marcia Ramos a62d93f909 Docs: require release version in image filenames 2019-06-26 14:07:01 +00:00
Evan Read e128239340 Add Markdown linting
Also adds and one linting rule
and makes project conform to it.
2019-06-25 04:34:55 +00:00
Evan Read ef95359362 Https many links in docs 2019-06-18 12:23:07 +00:00
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
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
Mike Lewis 0ed9b252ce Fix link to structure.md and other minor improvements 2018-12-31 20:15:05 +00:00
Mike Lewis 738d547732 Minor refinements to process wording and links 2018-12-31 19:53:07 +00:00
Mike Lewis cb6e991cef Add index.md link and other clarifications 2018-12-31 19:43:21 +00:00
Mike Lewis 66d4197edd More minor edits 2018-12-31 19:40:06 +00:00
Mike Lewis 2b76309b6c Standardize linked page names in index.md 2018-12-31 19:25:53 +00:00
Mike Lewis 7879c33197 Refine workflow wording and names 2018-12-31 19:20:35 +00:00
Mike Lewis f41248b359 Add language on blog posts 2018-12-31 19:08:26 +00:00
Mike Lewis ed917e3618 Improve language/policy on standard for merging 2018-12-31 19:02:55 +00:00
Mike Lewis 92e5e4c12d Fix link to site_architecture index 2018-12-31 18:58:28 +00:00
Mike Lewis 2dc3ecd4df Update regarding who moves content, when to ask, etc 2018-12-31 18:55:47 +00:00
Mike Lewis 0eb7fc065a Update description of resources 2018-12-31 18:50:42 +00:00