Skip to content
This repository has been archived by the owner on Sep 2, 2020. It is now read-only.

Tidy up docs #107

Open
SueSmith opened this issue Jun 9, 2014 · 20 comments
Open

Tidy up docs #107

SueSmith opened this issue Jun 9, 2014 · 20 comments
Assignees

Comments

@SueSmith
Copy link
Contributor

SueSmith commented Jun 9, 2014

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

@SueSmith SueSmith self-assigned this Jun 9, 2014
@SueSmith
Copy link
Contributor Author

SueSmith commented Jun 9, 2014

Will update as per issues listed in #91

@SueSmith
Copy link
Contributor Author

SueSmith commented Jun 9, 2014

And include migration guidance as per #97

@SueSmith
Copy link
Contributor Author

SueSmith commented Jun 9, 2014

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

@cmcavoy
Copy link
Contributor

cmcavoy commented Jun 10, 2014

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

@SueSmith
Copy link
Contributor Author

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

@SueSmith
Copy link
Contributor Author

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

@SueSmith
Copy link
Contributor Author

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

@SueSmith
Copy link
Contributor Author

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

@SueSmith
Copy link
Contributor Author

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

@threeqube
Copy link

👍

@SueSmith
Copy link
Contributor Author

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
Copy link
Contributor Author

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
Copy link
Contributor Author

SueSmith commented Jul 4, 2014

Also to add application processed filtering as in #114

@threeqube
Copy link

👍

@SueSmith
Copy link
Contributor Author

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
Copy link

👍

@SueSmith
Copy link
Contributor Author

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
Copy link

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 👍

@SueSmith
Copy link
Contributor Author

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants