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
4d4af21a83
Docs: correct word
2019-02-09 13:23:45 +00:00
30b4b42e2f
Add Documentation requirements section
2019-02-08 18:15:41 +00:00
53840eacc9
Simplify doc work discussion in feature-change-workflow.md
2019-02-07 03:29:03 +00:00
82a6f87ed0
Fix many 'when manual' anchors
2019-02-06 14:14:23 +10:00
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
f72722dead
Docs: Corrects link
2019-01-31 19:30:14 +00:00
8205f1e18b
Merge branch 'master' into 'template-improvements-for-documentation'
...
# Conflicts:
# .gitlab/issue_templates/Feature proposal.md
2019-01-30 18:29:17 +00:00
ad8b8aa98c
Add more detail on deciding when to have TW review
2019-01-30 17:48:08 +00:00
7aa251308f
Fixes a typo
2019-01-24 14:19:22 +00:00
0bfd119ee1
Document docs style exceptions
2019-01-24 13:46:51 +00:00
c2c2d04b3a
Fix most instances of bare URLs in markdown
2019-01-24 06:52:33 +00:00
f8e6a3957e
Minor edits to feature-change-workflow.md
2019-01-23 15:26:42 +00:00
6dfa8538b1
Update improvement workflow
2019-01-23 05:53:14 +00:00
c4d1aa97f6
Additional edits to feature workflow
2019-01-18 04:13:39 +00:00
1f54c38140
Merge branch 'master' into 'template-improvements-for-documentation'
...
# Conflicts:
# .gitlab/issue_templates/Feature proposal.md
2019-01-18 02:59:01 +00:00
75cf4bdf93
Update improvement workflow
2019-01-17 23:07:01 +00:00
77f3cbc008
Update the feature change workflow
2019-01-17 22:37:02 +00:00
c9f2ccaea1
Promote sections and minor improvements
2019-01-16 11:56:07 +10:00
ca74ba9777
Document four backticks feature in markdown
2019-01-15 13:20:52 +00:00
a45c223606
Fix indentation and markup for Markdown codeblock
2019-01-11 12:48:37 +01:00
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
50f5f3c721
docs: Fix 'Gilab' typo
2019-01-09 06:28:01 +00:00
868d8ec6e7
Fix broken markdown and other lint problems
2019-01-09 10:37:25 +10:00
4671cb7836
Add API topic template
2019-01-07 14:11:39 +10:00
2268ddc7de
Implement some review comments
...
Also:
- Slight restructure.
- Some Markdown improvements.
2019-01-07 14:11:39 +10:00
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
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
550126f1a5
Fixes broken link
2019-01-04 18:26:00 +00:00
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
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
a4e7b7704e
Add to the 'how to update' section
2018-12-31 20:35:24 +00:00
35e5833df4
Fixed typo in structure.md link
2018-12-31 20:20:55 +00:00
0ed9b252ce
Fix link to structure.md and other minor improvements
2018-12-31 20:15:05 +00:00
738d547732
Minor refinements to process wording and links
2018-12-31 19:53:07 +00:00
cb6e991cef
Add index.md link and other clarifications
2018-12-31 19:43:21 +00:00
66d4197edd
More minor edits
2018-12-31 19:40:06 +00:00
2b76309b6c
Standardize linked page names in index.md
2018-12-31 19:25:53 +00:00
7879c33197
Refine workflow wording and names
2018-12-31 19:20:35 +00:00
f41248b359
Add language on blog posts
2018-12-31 19:08:26 +00:00
ed917e3618
Improve language/policy on standard for merging
2018-12-31 19:02:55 +00:00
92e5e4c12d
Fix link to site_architecture index
2018-12-31 18:58:28 +00:00
2dc3ecd4df
Update regarding who moves content, when to ask, etc
2018-12-31 18:55:47 +00:00
0eb7fc065a
Update description of resources
2018-12-31 18:50:42 +00:00
d4c923e614
Clarify language on review/merge requirements
2018-12-31 18:46:17 +00:00
be17281e27
Small update re introducing the other resources
2018-12-31 18:38:42 +00:00
78148012fc
Added links to top section
2018-12-31 18:37:06 +00:00
517021ffba
Remove redundancies eg detailed workflow summaries, add links to other pages in section
2018-12-31 18:29:36 +00:00
6a625d6df9
Add link to docs repo and renamed page
2018-12-31 18:24:53 +00:00
0197f8cf80
Added additional items formerly in the doc template
2018-12-31 18:07:11 +00:00
9bde1e910f
Further refinements to the page
2018-12-31 18:04:46 +00:00
1d78b3ba4d
Improvements to the intro and template
2018-12-31 17:46:12 +00:00
58e4281477
Another addition formerly in the template
2018-12-31 17:42:05 +00:00
bfc67c3ef4
Improvements to Style Guide, bringing it items from template
2018-12-31 17:34:57 +00:00
613168fa62
Initial edits to intro
2018-12-31 17:05:12 +00:00
1ca583ed74
Update Content section
2018-12-31 15:02:34 +00:00
66b127a5f4
Renamed to Documentation Style Guide
2018-12-31 14:37:03 +00:00
5233ef0768
Fixed a typo
2018-12-31 14:36:20 +00:00
a8f0cd517c
Removed Content section, now added to the Style Guide
2018-12-31 14:31:38 +00:00
38395f9e01
Rename to add 'template' to title
2018-12-31 02:59:22 +00:00
c665b845e9
Move Content section to style guide
2018-12-31 02:40:00 +00:00
10784261e7
Move language about what belongs in docs into Content, other minor improvements
2018-12-31 02:38:58 +00:00
2d085e3fe6
Rewording doc workflows index
2018-12-31 02:14:07 +00:00
e5d1512c54
Remove technical articles content and add some minor edits
2018-12-29 00:29:59 +00:00
f95eebc7d4
Bring in 'content - what belongs in docs' from 'other' workflow page
2018-12-29 00:14:28 +00:00
04e7b1cf14
Clarify that change to doc location requires technical writer review
2018-12-28 22:22:19 +00:00
0ba0dc1daf
Allow contributors to rename files per process
2018-12-28 22:18:32 +00:00
b75d640282
Updates to Location and naming documents
2018-12-28 06:13:27 +00:00
ce7c57f62b
Fix 'other contributions' section; removed comment and updated to remove review requirement
2018-12-27 22:29:29 +00:00
182d960111
Further clarifications to new-feature workflow
2018-12-27 22:24:56 +00:00
21c1a3f927
add link to Documentation handbook section for more on what belongs, incl SSOT details
2018-12-27 22:04:27 +00:00
fb55ba5b91
Updates to doc improvements workflow
2018-12-27 21:59:22 +00:00
01d23dfe2a
Removed line about anything specific to Support
2018-12-27 21:58:08 +00:00
89bd8a15d7
Update improvement-workflow, remove Support-specific items
2018-12-27 20:18:26 +00:00
9bfd4554c3
Updates to feature-change docs workflow
2018-12-27 19:57:10 +00:00
f82f3e2bc6
Add standard on merging
2018-12-24 13:53:35 -05:00
295a02193e
Update with additional policy changes discussed with product
2018-12-24 18:07:07 +00:00
8fe01378b0
Added clarity on where to place content and how to ask for help
2018-12-23 20:03:13 -05:00
70cac23b8c
Add line breaks to improvement workflow
2018-12-22 03:56:10 +00:00
cf414a0b0b
Updates per reviews; split workflow.md into 2 pages
...
Split workflow.md into a new feature workflow page vs other improvement
workflow page because the original page was too long and using 4 heading
levels. Left it in place as an index so we have a single workflow
landing page.
2018-12-21 22:33:44 -05:00
089233e877
Minor punctuation fix
2018-12-21 22:33:07 -05:00
9beb70afa4
Large v small troubleshooting items and review needs for support
2018-12-21 21:03:19 -05:00
f5a0502343
Separate section for non-new-feature docs, Support role
2018-12-20 23:38:46 -05:00
2b0454a03a
New intro, feature vs other updates, support section link
2018-12-20 23:37:54 -05:00
98342b7f7f
Docs: how the global nav works
2018-12-11 13:39:37 +00:00
180d937552
Provide information on /help rspec tests
2018-12-07 16:01:40 +10:00
47da931c9e
deprecate UX Guide and redirect to design.gitlab
2018-11-21 15:25:15 +00:00
3cfdb0acb2
Docs: updates docs development guidelines
2018-11-12 13:30:41 +00:00
6e2570d2d5
Docs: Update Variable naming
2018-11-11 23:43:25 +00:00
8c9da81cda
Add refined sample linting configuration
...
Also:
- Ensures documentation section adheres to linters.
- Makes other minor improvements.
2018-11-06 13:14:39 +10:00
6afcc3992b
Merge branch 'docs/troubleshooting-docs-ra' into 'master'
...
Split troubleshooting docs review apps in own section
See merge request gitlab-org/gitlab-ce!22462
2018-10-18 14:05:23 +00:00
a9049cc9da
Split troubleshooting docs review apps in own section
2018-10-18 15:54:54 +02:00
275325b0a0
Documents help and feedback section and Disqus
...
- Links to MRs that introduced them
- Explains how to omit them
- Follows https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/341
2018-10-18 12:58:55 +01:00
76b0c82706
Adjust link to docs development guide
2018-10-15 11:01:43 +00:00
5849a0ceba
Docs: Fixing some bad links
2018-10-14 22:55:12 +00:00
2139df1bfb
Fix links that 404 and style changes
...
- Some links internal links were incorrect.
- Removed some #overview anchor links, because they don't
jump much content.
- Made text confirm to suggested proselint and mardownlint rules.
2018-10-09 09:43:14 +10:00
5e583dc62f
Add linting section to documentation guidelines
2018-09-26 12:47:56 +10:00
d68ee3cea8
Add clarity to EE feature styles for features introduced before and after 9.2
2018-09-25 11:38:51 +00:00
9b53925481
Explain the docs' CD, relating to the milestone the doc is set to vs online docs
2018-09-20 07:13:30 +00:00
f3507cbf70
docs/ Grammatical Fix workflow.md
2018-09-14 11:08:31 +00:00
79322c3c93
Merge branch 'docs/dangerfile' into 'master'
...
Add Documentation Dangerfile
See merge request gitlab-org/gitlab-ce!21395
2018-09-07 21:18:36 +00:00
15c87796ec
Merge branch 'use-colon-in-lists' into 'master'
...
Add guidance on using colons in bullet lists, and make styleguide adhere closer to styleguide.
Closes #51086
See merge request gitlab-org/gitlab-ce!21549
2018-09-07 21:05:20 +00:00
b0be58a1b3
Resolve "CE documentation is not CommonMark compliant"
2018-09-06 16:52:18 +00:00
b1b55371c6
Add Documentation Dangerfile
...
Every time a doc change is made, a comment to
ping the @gl-docsteam is added.
2018-09-06 10:50:35 +02:00
07554a1d4b
Add guidance on using colons in bullet lists, and make styleguide adhere closer to styleguide.
2018-09-06 10:54:02 +10:00
8dbcd11075
Compress all PNG images under doc/
...
The pngquant tool was used https://pngquant.org , and particularly, the
following command:
/usr/bin/pngquant -f --skip-if-larger --ext .png --speed 1 image.png
Before: 47584K
After : 34924K
2018-08-27 15:52:03 +02:00
819f6d9bce
Documentation process at GitLab
2018-08-16 09:30:04 +00:00
9982ff3f99
Prefer using direct links in docs styleguide
2018-07-25 09:26:47 +02:00
e0af4c1982
Document how the new automatic review apps for docs work
...
This was missed from
https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/20130
2018-06-25 16:35:25 +02:00
c4b185fb5a
clarify what "methods" are
2018-06-20 14:13:03 +01:00
25f90286f2
Update styleguide.md with rules for navigation items
2018-06-20 09:48:34 +00:00
d5a303cf4d
Doc update
2018-06-06 21:01:43 +09:00
cc9928c256
Docs: add the documentation guidelines into its own dir
2018-06-06 11:32:38 +00:00
Evan Read
Merve
Mike Lewis
Achilleas Pipinellis
Marcia Ramos
carla
Sarrah Vesselov
Marcel Amirault
Winnie Hellmann
Casey Burnett
Brett Walker
Mark Chao