Tidy up docs - Githubissues

mozilla / badgekit-api

NO LONGER MAINTAINED

https://api.badgekit.org

Mozilla Public License 2.0

41 stars 46 forks source link

Tidy up docs #107

Open SueSmith opened 10 years ago

SueSmith commented 10 years ago

Doing any outstanding doc tidying here https://github.com/mozilla/badgekit-api/tree/doc-tidy/docs

SueSmith commented 10 years ago

Will update as per issues listed in #91

SueSmith commented 10 years ago

And include migration guidance as per #97

SueSmith commented 10 years ago

NB Have added links to the updated docs in the API repo wiki guides.

cmcavoy commented 10 years ago

Also need to add migration info to the README.md, it still refers to the schema.sql.

SueSmith commented 10 years ago

@cmcavoy - Will do, readme could probably use an update generally..

SueSmith commented 10 years ago

Migration info added to:

readme https://github.com/mozilla/badgekit-api/blob/doc-tidy/README.md
self-hosting guide https://github.com/mozilla/openbadges-badgekit/wiki/BadgeKit-Self-Hosting-Guide#set-up-badgekit-api
wiki home https://github.com/mozilla/badgekit-api/wiki

SueSmith commented 10 years ago

Also todo: add instance delete webhook as in #111 (to docs and wiki pages)

SueSmith commented 10 years ago

p.s. just realised @christensenep has already added main revoke stuff to webhooks doc, so just needs added to other relevant bits..

SueSmith commented 10 years ago

Revoke info added to relevant wiki pages (haven't gone into much detail, mainly pointed to in-app docs).

SueSmith commented 10 years ago

Added pagination info to docs re. #113 Also added to retrieving badges guide: https://github.com/mozilla/badgekit-api/wiki/Retrieving-Badges#pagination

threeqube commented 10 years ago

:+1:

SueSmith commented 10 years ago

New routes added for milestones (adding/ removing a badge): https://github.com/mozilla/badgekit-api/blob/doc-tidy/docs/milestones.md

As per #88

SueSmith commented 10 years ago

I've changed the badges doc to reflect the auto-generated badge slugs: https://github.com/mozilla/badgekit-api/blob/doc-tidy/docs/badges.md

Removed slug from create and update endpoints - also removed the duplicate entry errors from those endpoints. Hope that sounds right!

SueSmith commented 10 years ago

Also to add application processed filtering as in #114

threeqube commented 10 years ago

:+1:

SueSmith commented 10 years ago

NB also added a wee bit to the wiki on bulk issuing https://github.com/mozilla/badgekit-api/wiki/Awarding-Badges#issuing-multiple-badges

threeqube commented 10 years ago

:+1:

SueSmith commented 10 years ago

Added a short section to the wiki reinforcing what issuers still need to do once they have BadgeKit set up: https://github.com/mozilla/badgekit-api/wiki#next-steps

threeqube commented 10 years ago

Added a short section to the wiki reinforcing what issuers still need to do once they have BadgeKit set up: https://github.com/mozilla/badgekit-api/wiki#next-steps

Great call. This is the part that folks always seem to need reinforcement on :+1:

SueSmith commented 10 years ago

I've extended the "Next Steps" content to give a bit more guidance on what issuers need to do depending on whether they're using the API + Web app + assessment etc. Not quite a decision tree but should hopefully streamline things a bit.. https://github.com/mozilla/badgekit-api/wiki#next-steps