WIP - Documentation clean-up (api)
Relevant MR gitlab-org/gitlab-ce!635
All docs should:
- Use tables for attributes
- Use one curl example with each method call
- Make sure every method call has a response body (in json format)
GitLab
-
README.md -
branches.md -
commits.md -
deploy_key_multiple_projects.md -
deploy_keys.md -
groups.md -
issues.md -
keys.md -
labels.md -
merge_requests.md -
milestones.md -
namespaces.md -
notes.md -
oauth2.md -
project_snippets.md -
projects.md -
repositories.md -
repository_files.md -
services.md -
session.md -
settings.md -
system_hooks.md -
tags.md -
users.md (!2089 (merged) and https://dev.gitlab.org/gitlab/gitlabhq/issues/1244#note_64122)
GitLab CI
-
README.md -
builds.md -
commits.md -
projects.md -
runners.md
Notes
-
Document that groups can only created by users which are allowed to create groups, see https://gitlab.com/gitlab-org/gitlab-ce/issues/4259#note_3031554 -
Inconsistency between doc and API for user update https://gitlab.com/gitlab-org/gitlab-ce/issues/1042
Sorted by word count
89 milestones.md
102 oauth2.md
110 repository_files.md
118 project_snippets.md
150 tags.md
178 repositories.md
249 README.md
261 notes.md
474 merge_requests.md
575 users.md
696 services.md
818 projects.md\cc @DouweM @rspeicher @sytses