Commit Graph

12 Commits

Author SHA1 Message Date
Adam Shimali
92e0fc8269 Fix docs to line up with api 2016-03-24 14:40:20 +00:00
Chris Hill-Scott
a32fd36b1b Use real API endpoints in documentation
There is no need to make the API endpoints environment-specific. But it
is still useful to know what the endpoint is.

Also fixes a broken link on the integration page.
2016-03-21 16:36:15 +00:00
Chris Hill-Scott
2c3c802d5c Move documentation into footer, not behind login
https://www.pivotaltracker.com/story/show/115775183
2016-03-21 10:39:57 +00:00
Chris Hill-Scott
8e7b0edc4d Add page explaining how to send template using API
Would like to test something like this and see how well it works.

Intention of having this page is so:
- template IDs are discoverable (https://www.pivotaltracker.com/story/show/115404593)
- it’s obvious there’s an ‘automated’ way to send messages, as well as the CSV
  way (we’ve seen people oblivious to this in research)
2016-03-15 07:11:01 +00:00
Chris Hill-Scott
865ea3ca4f Use correct API endpoint in docs
This has confused people, should change it before the site visits next week.
2016-02-26 15:00:32 +00:00
Chris Hill-Scott
7e8046be47 Add syntax highlighting to code examples in docs
Uses the Pygments[1] package.

1. http://pygments.org/
2016-02-09 10:33:49 +00:00
Chris Hill-Scott
382cfa2907 Make page titles consistent
This commit modifies the HTML `<title>` tags for all the pages. It makes two
main changes:
- make the title tag match the `<h1>` of the page, for better or worse
- put the service name after the page title, seperated by an en dash, as per
  GOV.UK
2016-02-08 09:23:51 +00:00
Chris Hill-Scott
28f700366c Fix spacing of first page headers
This commit customises the margins of the first header on each page so that it
lines up with the navigation.
2016-02-04 10:59:18 +00:00
Henry Hadlow
c4023bf0fb Make headings .heading-large instead of .heading-xlarge 2016-02-02 14:06:07 +00:00
Martyn Inglis
6e95e4dd3b Updated the link to the API code 2016-01-24 21:04:24 +00:00
Martyn Inglis
f040d85a94 Updated documentation for api keys and for the developer documentation page. 2016-01-24 21:03:00 +00:00
Chris Hill-Scott
9784a9936c Add pages for create/view/revoke API keys
Copying what they’ve done on GOV.UK Pay, we should let users:
- generate as many keys as they want
- only see the key at time of creation
- give keys a name
- revoke any key at any time (this should be a one way operation)

And based on discussions with @minglis and @servingUpAces, the keys should be
used in conjunction with some kind of service ID, which gets encrypted with the
key. In other words the secret itself never gets sent over the wire.

This commit adds the UI (but not the underlying API integration) for doing the
above.
2016-01-20 16:22:23 +00:00