app/templates/views/documentation.html

{% extends "withoutnav_template.html" %}

{% block page_title %}
  API documentation – GOV.UK Notify
{% endblock %}

{% block maincolumn_content %}

<div class="grid-row">
  <div class="column-two-thirds documentation">
	{{ body }}
  </div>
</div>

{% endblock %}
-												Move documentation into footer, not behind login

https://www.pivotaltracker.com/story/show/115775183

											
										
										
											2016-03-18 16:25:43 +00:00
+								{% extends "withoutnav_template.html" %}
-												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-19 09:55:13 +00:00
 								{% block page_title %}
-												Move documentation into footer, not behind login

https://www.pivotaltracker.com/story/show/115775183

											
										
										
											2016-03-18 16:25:43 +00:00
+								  API documentation – GOV.UK Notify
-												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-19 09:55:13 +00:00
+								{% endblock %}
 								{% block maincolumn_content %}
-												Add syntax highlighting to code examples in docs

Uses the Pygments[1] package.

1. http://pygments.org/

											
										
										
											2016-02-09 10:28:12 +00:00
+								<div class="grid-row">
-												Add some basic typography, tweak the Markdown

This commit adds some basic type sizes, weights and spacing for HTML
elements scoped inside a `.documentation` container.

It also tweaks some of the Markdown so that it renders the same as it
does on Github.

											
										
										
											2016-04-15 10:56:47 +01:00
+								  <div class="column-two-thirds documentation">
 									{{ body }}
-												Get the docs rendering in the app

This commit replaces the old _API Documentation_ page with the Markdown
version that Catherine has been working on.

I’ve checked that there’s nothing obviously wrong or placeholder-y still
in there, so I think we’re good to go.

											
										
										
											2016-04-15 10:48:31 +01:00
+								  </div>
-												Updated documentation for api keys and for the developer documentation page.

											
										
										
											2016-01-24 21:03:00 +00:00
+								</div>
-												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-19 09:55:13 +00:00
 								{% endblock %}