Commit Graph

46 Commits

Author SHA1 Message Date
Chris Hill-Scott
4df99bd27f Don’t allow paragraphs without class attribute
All paragraphs should have class="govuk-body", or be otherwise
custom-styled. This commit adds some extra checks to our test fixture
that looks for paragraphs that don’t have any styling. Our test coverage
is pretty good, so this should check almost all pages, and prevent
regressions.

I’ve done this in such a way that it can be extended for other elements
(e.g. links) in the future.
2020-05-29 17:11:01 +01:00
Tom Byers
ee9f348ce4 Update all links to use GOVUK Frontend style
Includes:
- turning off :visited styles to match existing
  design
- swapping heading classes used to make links bold
  for the GOVUK Frontend bold override class
- adding visually hidden text to some links to
  make them work when isolated from their context

We may need to revisit whether some links, such as
those for documentation and features, may benefit
from having some indication that their target has
been visited.
2020-02-25 10:47:24 +00:00
Tom Byers
5b306dde4d Revert "Convert all links to govuk frontend" 2020-02-24 11:56:38 +00:00
Tom Byers
cd36182ea6 Update all links to use GOVUK Frontend style
Includes:
- turning off :visited styles to match existing
  design
- swapping heading classes used to make links bold
  for the GOVUK Frontend bold override class
- adding visually hidden text to some links to
  make them work when isolated from their context

We may need to revisit whether some links, such as
those for documentation and features, may benefit
from having some indication that their target has
been visited.
2020-02-20 09:11:26 +00:00
Leo Hemsted
07e7b03bf3 move rest api docs to new url 2019-10-21 16:34:10 +01:00
Rebecca Law
d902ac3b44 Added the url for api docs.
Updated error message when js tests fail
2019-09-25 15:47:35 +01:00
karlchillmaid
7bdcf7414d Add 'link opens in new tab' explanation 2019-09-23 17:05:02 +01:00
karlchillmaid
fce4a36636 Update content 2019-09-23 17:01:59 +01:00
karlchillmaid
4c232a9cab Fix h2 tag so heading displays properly 2019-08-23 14:16:23 +01:00
karlchillmaid
8989f5a93b Update 'client libraries' 2019-08-21 10:17:36 +01:00
karlchillmaid
c05969e230 Update app/templates/views/documentation.html
Co-Authored-By: Chris Hill-Scott <me@quis.cc>
2019-08-21 10:15:27 +01:00
karlchillmaid
ff663ed172 Update app/templates/views/documentation.html
Co-Authored-By: Chris Hill-Scott <me@quis.cc>
2019-08-21 10:15:17 +01:00
karlchillmaid
6c9f6463c3 Update app/templates/views/documentation.html
Co-Authored-By: Chris Hill-Scott <me@quis.cc>
2019-08-21 10:15:10 +01:00
karlchillmaid
af7222de1d Update app/templates/views/documentation.html
Co-Authored-By: Chris Hill-Scott <me@quis.cc>
2019-08-21 10:15:03 +01:00
karlchillmaid
12f0c1e0ff Update timings and direct integration content 2019-08-21 09:56:27 +01:00
karlchillmaid
3dfa6e06cc Update client documentation content 2019-08-20 17:06:01 +01:00
karlchillmaid
73415f7a08 Update Integrating directly with the API content
Move the line about reading client documentation.
2019-08-20 15:07:48 +01:00
karlchillmaid
39461b369d Add details about timings and direct integration
Outline how long it can take to integrate using the client documentation.

Add more detail about how to integrate directly with the API.
2019-08-20 14:51:54 +01:00
karlchillmaid
98f51d8174 Update content 2019-08-20 12:03:42 +01:00
Chris Hill-Scott
399eff7215 Make a reusable ‘content’ template
This is for static content pages and makes sure they always have the
right column widths and sub navigation.
2019-06-04 13:49:39 +01:00
karlchillmaid
4fa33c678f Update introduction
Update introduction to give users more context and clearer instructions
2019-04-11 10:31:17 +01:00
Chris Hill-Scott
b1832a4c43 Remove link to integration testing page
This page has ben deprecated.
2018-11-06 17:25:33 +00:00
Chris Hill-Scott
c1bcfff895 Add link to .NET documentation 2018-11-05 15:17:12 +00:00
Chris Hill-Scott
3993e2cf28 Link to tech docs format for PHP and Node
They’re live 🎉 

One more to go…
2018-11-05 14:49:29 +00:00
Katie Smith
5b7ca676b5 Make the new Ruby docs live
The Ruby docs are now finished, so we can change the documentation link
to point to the new docs.
2018-08-14 10:55:02 +01:00
Chris Hill-Scott
a80938a963 Use new tech docs format for Java client
Because it’s (nearly) ready to go now.
2018-06-07 12:08:30 +01:00
Katie Smith
e93f719396 Link to new Python docs on Documentation page
Changed the Python link on the Documentation page to link to the new
Python docs (docs.notifications.service.gov.uk/python.html) instead of
the Python client GitHub repo.
2018-04-19 09:51:13 +01:00
Chris Hill-Scott
7fdee279c8 Open links to client documentation in a new tab
In research we saw developers having difficulty getting back to Notify once they’d 
navigated to the documentation.

One way we think this might be alleviated is by keeping Notify open in the same tab,
and having the documentation open in a new tab.

It’s polite to tell users that this is going to happen.

`rel=noopener` stops the site we’re redirecting people to (Github) have script 
access to the orginal Notify tab (see https://mathiasbynens.github.io/rel-noopener/ )
original Notify
2018-01-31 13:43:17 +00:00
chrisw
90e18e04ee Updated support views to represent new url structure 2017-11-29 13:58:12 +00:00
chrisw
e67ee2b579 Updated views to represent new content and url structure 2017-11-28 11:58:15 +00:00
Chris Hill-Scott
135ff1ee77 Include service name in page <title>
In pages specific to a service (e.g. dashboard and sub pages) the title
needs to distinguish which service it applies to. This is mainly to give
context to screen reader users who could be managing multiple services.

Implementing this uses template inheritance:

`page_title` includes `per_page_title` includes `service_page_title`

‘GOV.UK Notify’ is inserted into every page title.

Pages that set `service_page_title` get the service name inserted too.
2017-02-14 11:53:53 +00:00
Chris Hill-Scott
f7c15dfbaf 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 12:15:30 +01:00
Chris Hill-Scott
57ad64fae6 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 12:14:51 +01:00
Rebecca Law
1fe5ae0371 This pull request removes the need for the req and pay in the claims JWT.
Use the new version of the notifications-python-client. This version no longer adds the req and pay to the claims of the jwt.

The change is backward compatible so an older client that sends a JWT with the extra claims will pass authentication.
Once all the clients have been updated to not include the extra claims some updates to exclude them from the method signatures will happen as well.

The documentation has been updated to reflect this change.

https://www.pivotaltracker.com/story/show/116971293
2016-04-15 11:04:35 +01:00
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