diff --git a/source/index.html.md b/source/index.html.md index dda7aefd4..1773bbdd0 100644 --- a/source/index.html.md +++ b/source/index.html.md @@ -20,3 +20,18 @@ All of the APIs and data sources published in the catalogue have their own licen **Note**: An API appearing on this catalogue does not mean it will be publicly accessible, nor is it a requirement. This is a public-facing site to allow us to document and discover APIs that are available and in use. The API Catalogue is a central part of the [Data Standards Authority's](https://www.gov.uk/government/groups/data-standards-authority) API programme, which aims to improve how APIs are produced, managed and used across government. + +## Raise an issue or report a problem + +If you want to raise an issue, report a problem, or suggest an improvement, [open a new issue on GitHub](https://github.com/co-cddo/api-catalogue/issues/new/choose). + +On the new issue page, choose the template that best matches what you want to do: + +* **Bug report for the API Catalogue** — for problems with this website itself, such as broken links, pages that will not load, incorrect or out-of-date information, or something not behaving as expected. Include the page you were on, what you expected to happen, what actually happened and, where possible, steps to reproduce the issue. +* **New catalogue entry request** — to request that a new API is added to the catalogue. Provide the name of the API, the organisation that owns it, a short description of what it does and links to any documentation so we can review and add it. +* **Problem with an API** — for issues with one of the APIs already listed in the catalogue, for example incorrect details, out-of-date documentation or an endpoint that no longer works. Tell us which API is affected and what needs to change. This template is for reporting catalogue accuracy — for support using an API, contact the API's owning organisation directly. +* **Report a security vulnerability** — to responsibly disclose a security concern with this website or its content. Do not include sensitive details, exploit code or personal data in a public issue; provide enough information for us to make contact and investigate privately. +* **Blank issue** — for anything that does not fit the templates above, such as a general question, a suggestion for improvement or feedback about the catalogue. + +Select **Get started** next to the relevant template, fill in as much detail as you can, then submit the issue. +