-
Notifications
You must be signed in to change notification settings - Fork 42
Tidy up docs #107
Comments
Will update as per issues listed in #91 |
And include migration guidance as per #97 |
NB Have added links to the updated docs in the API repo wiki guides. |
Also need to add migration info to the README.md, it still refers to the schema.sql. |
@cmcavoy - Will do, readme could probably use an update generally.. |
Migration info added to: |
Also todo: add instance delete webhook as in #111 (to docs and wiki pages) |
p.s. just realised @christensenep has already added main revoke stuff to webhooks doc, so just needs added to other relevant bits.. |
Revoke info added to relevant wiki pages (haven't gone into much detail, mainly pointed to in-app docs). |
Added pagination info to docs re. #113 |
👍 |
New routes added for milestones (adding/ removing a badge): https://github.com/mozilla/badgekit-api/blob/doc-tidy/docs/milestones.md As per #88 |
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 |
Also to add application processed filtering as in #114 |
👍 |
NB also added a wee bit to the wiki on bulk issuing https://github.com/mozilla/badgekit-api/wiki/Awarding-Badges#issuing-multiple-badges |
👍 |
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 👍 |
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 |
Doing any outstanding doc tidying here https://github.com/mozilla/badgekit-api/tree/doc-tidy/docs
The text was updated successfully, but these errors were encountered: