WIP: Initial docs for Projects service #243
Conversation
breaking: Removed projectId from System Hooks API since it wasn't required breaking: Removed dependency on FS. Now the Projects API takes in two arguments `projectId` and `content` as well as an option fileName argument breaking: Changing everything to named exports for simplicity breaking: Switching required initialization argument from 'url' to 'host' breaking: Updated Approvals API support to match https://docs.gitlab.com/ee/api/merge_request_approvals.html breaking: MergeRequest Pipelines require the mergeRequestId breaking: NotificationSettings API edit function now takes one parameter, `options` breaking: Changing the access level enum property from master to maintainer as per https://gitlab.com/gitlab-org/gitlab-ce/issues/42751 breaking: Notes now require a body argument instead of checking the options argument for a body parameter fix: jdalrymple#227 (jdalrymple#227) Fixing array syntax thanks to Lukas Eipert (https://github.com/leipert) (f9bc34d (jdalrymple@f9bc34d)) fix: Fixing Todos support. If todoId was not passed, an undefined value would be introduced into the url (cbeef18 (jdalrymple@cbeef18)) fix: ResourceAwardEmojis API wasn't properly filtering based on awardId (70f4315 (jdalrymple@70f4315)) fix: Removed xhr library in favour of ky, and switched request for got for a smaller package size and retry functionality feat: Adding the ability to add sudo to specific requests (780244f (jdalrymple@780244f)) chore: Adding editorconfig file chore: Removing some overrides from the tslint chore: Removing unused dependencies chore: Adding prettier as a dev dependency docs: Removing xml request docs docs: Updating imports to be named imports
chore: Updating rollup from version ^0.66.6 to ^0.67.1 chore: Updating rollup-plugin-typescript2 from version ^0.17.1 to ^0.18.0 chore: Updating got from version ^9.2.2 to ^9.3.2 chore: Updating @semantic-release/npm from version ^5.0.5 to ^5.1.1 chore: Updating @types/jest from version ^23.3.5 to ^23.3.9 chore: Updating prettier from version ^1.14.3 to ^1.15.2 chore: Updating semantic-release from version ^15.10.3 to ^15.11.0 chore: Updating typescript from version ^3.1.3 to ^3.1.6 chore: Updating @types/jest from version ^23.3.5 to ^23.3.9
|
Ok, I'll take this as confirmation to proceed. I will prioritise the documentation first as that provides the best value-add for users. |
|
Update: finished We need a nicer |
|
There is a hell of a lot more to document than I initially thought. I will keep going bit-by-bit every weeknight but it will take a long time. I would like it if we can merge in what I've got before 5.0 goes live so we at least have some API documentation. |
|
I can merge this PR rn in the meantime? |
|
https://itnext.io/publish-a-vuepress-site-on-github-pages-with-travis-82036243bf36 This would be cool! On release it published the docs to a github page? |
|
I'll clean up the conflict and look at the publishing tonight so you can merge |
|
I can help rebase this at the end of the week |
|
Real life has got in the way so I won't realistically be able to finish this work. Do with what I've done as you want. Good luck! |
|
Thank you for the work! |
|
Going to try and rebase this at some point this week |
jdalrymple
force-pushed
the
next
branch
6 times, most recently
from
5a76f86
to
0659370
Compare
This is a test to add docs to the repository. Taken on the suggestion of Vuepress, running
npm run docs:devwill start a server which serves the formatted docs.I do not have any opinion on how the docs get published or how they look, I merely want to get the content into markdown files so it can happen.