Skip to content

Commit

Permalink
Remove expiration dates
Browse files Browse the repository at this point in the history
We currently don't have a clear process to keep all pages up-to-date. It
was agreed to remove the warnings and update on a ad-hoc basis for now.
  • Loading branch information
saliceti committed Aug 29, 2023
1 parent 5f40ad8 commit 0019b61
Show file tree
Hide file tree
Showing 37 changed files with 12 additions and 91 deletions.
2 changes: 0 additions & 2 deletions source/accessibility.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Accessibility statement for the DfE Technical Guidance
last_reviewed_on: 2022-10-07
review_in: 6 months
hide_in_navigation: true
---

Expand Down
4 changes: 0 additions & 4 deletions source/guides/adding-new-guidance/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Adding a new guidance
weight: 10
last_reviewed_on: 2022-10-07
review_in: 12 months
---

# <%= current_page.data.title %>
Expand Down Expand Up @@ -40,8 +38,6 @@ Inside the new directory, create an `index.html.md.erb` file following this patt
```markdown
---
title: The Title of Your Page
last_reviewed_on: 2020-08-05
review_in: 3 months
---

# <%%= current_page.data.title %>
Expand Down
8 changes: 3 additions & 5 deletions source/guides/api-guidance/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: "API Guidance: Developing a DfE API"
last_reviewed_on: 2022-01-27
review_in: 3 months
weight: 30
old_paths:
- /documentation/guides/api-guidance.html
Expand Down Expand Up @@ -88,15 +86,15 @@ Make sure that your API is secure. GDS provides specific guidelines in [API tech

##JSON Security

GDS API standards recommend that
GDS API standards recommend that

* [JSON is used](https://www.gov.uk/guidance/gds-api-technical-and-data-standards#use-json)
* APIs need to be designed so that JSON Objects are submitted rather than individual elements or arrays
* JSON data needs to be parsed securely

We recommend
* JSON must be well-formed as defined by [RFC 4627](http://www.ietf.org/rfc/rfc4627.txt)

* JSON must be well-formed as defined by [RFC 4627](http://www.ietf.org/rfc/rfc4627.txt)
* Ensure that JSON document structure is valid and matches that expected, for example using a JSONSchema, an OpenAPI specification or deserialising to a Data Transfer Object.
* Use language standard JSON parsers that are well supported
* Ensure that JSON data elements are valid strong types where possible such as int or [date](https://www.gov.uk/government/publications/open-standards-for-government/date-times-and-time-stamps-standard) and use specific version of these if possible such as [ISO 8601:2004](https://www.iso.org/standard/40874.html) or unsigned 32 bit intergers
Expand Down
2 changes: 0 additions & 2 deletions source/guides/continuous-delivery/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Continuous delivery
weight: 40
last_reviewed_on: 2021-09-07
review_in: 1 year
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/guides/default-technology-stack/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: The DfE Technology Stack
last_reviewed_on: 2022-09-13
review_in: 6 months
weight: 20
old_paths:
- /documentation/guides/default-technology-stack.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Adding C4 Diagrams to Technical Documentation
last_reviewed_on: 2022-01-27
review_in: 3 months
weight: 50
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Azure devops
last_reviewed_on: 2022-09-01
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Github actions
last_reviewed_on: 2022-09-02
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
5 changes: 0 additions & 5 deletions source/infrastructure/dev-tools/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Developer tools
last_reviewed_on: 2022-09-02
review_in: 12 months
weight: 10
---

Expand Down Expand Up @@ -138,6 +136,3 @@ These is an extension that will allow for better integration with wsl, search in
### Working with GIT

For git, you will need to set the 'git config --global credential.helper', see [here](https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-git) for detailed instructions. You may need to search the the credential helper, as opposed to the ones listed in the docs.



2 changes: 0 additions & 2 deletions source/infrastructure/disaster-recovery/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Disaster recovery
weight: 40
last_reviewed_on: 2022-09-12
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/hosting/azure-cip/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Azure CIP
last_reviewed_on: 2023-07-14
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/hosting/dns/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: DNS
last_reviewed_on: 2022-03-22
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/hosting/govuk-paas/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ title: GOV.UK Platform-as-a-Service
old_paths:
- /documentation/guides/govuk-paas.html
- /guides/govuk-paas/index.html
last_reviewed_on: 2022-09-01
review_in: 12 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Gov UK PaaS Customer Journey Map
last_reviewed_on: 2022-09-01
review_in: 12 months
hide_in_navigation: true
---
[Back to GOV.UK PaaS overview](/infrastructure/hosting/govuk-paas/overview/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: PaaS Suitability Matrix vs Azure CIP
last_reviewed_on: 2022-09-01
review_in: 12 months
hide_in_navigation: true
---
[Back to GOV.UK PaaS overview](/infrastructure/hosting/govuk-paas/overview/)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Overview
last_reviewed_on: 2022-09-01
review_in: 12 months
weight: 10
old_paths:
- /guides/govuk-paas/overview/index.html
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Production
weight: 30
last_reviewed_on: 2022-09-01
review_in: 12 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Tooling
weight: 20
last_reviewed_on: 2022-09-5
review_in: 12 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Grafana dynamic variables
weight: 10
last_reviewed_on: 2022-04-22
review_in: 6 months
hide_in_navigation: true
link_in_toc: true
summary:
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/monitoring/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Monitoring
weight: 50
last_reviewed_on: 2022-09-9
review_in: 12 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/monitoring/logit/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Logit.io
hide_in_navigation: true
link_in_toc: true
last_reviewed_on: 2022-09-02
review_in: 6 months
---
[Back to Monitoring](/infrastructure/monitoring/)

Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/monitoring/prometheus/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Prometheus
hide_in_navigation: true
link_in_toc: true
last_reviewed_on: 2022-04-22
review_in: 6 months
---
[Back to Monitoring](/infrastructure/monitoring/)

Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/monitoring/sentry/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: Sentry
hide_in_navigation: true
link_in_toc: true
last_reviewed_on: 2022-09-9
review_in: 12 months
---
[Back to Monitoring](/infrastructure/monitoring/)

Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/monitoring/statuscake/index.html.md.erb
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@
title: StatusCake
hide_in_navigation: true
link_in_toc: true
last_reviewed_on: 2022-09-6
review_in: 12 months
---
[Back to Monitoring](/infrastructure/monitoring/)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Managing secrets
last_reviewed_on: 2022-09-9
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Service accounts
last_reviewed_on: 2022-09-09
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: SSL certificates
weight: 50
last_reviewed_on: 2022-10-24
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/infrastructure/support/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
---
title: Support
weight: 100
last_reviewed_on: 2022-09-09
review_in: 6 months
---

# <%= current_page.data.title %>
Expand Down
2 changes: 0 additions & 2 deletions source/principles/architecture/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Technical Architecture Principles
last_reviewed_on: 2022-01-27
review_in: 6 months
weight: 10
---

Expand Down
2 changes: 0 additions & 2 deletions source/principles/coding-principles/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Coding Principles
last_reviewed_on: 2022-01-27
review_in: 3 months
weight: 20
old_paths:
- /documentation/principles/coding-principles.html
Expand Down
2 changes: 0 additions & 2 deletions source/principles/data/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Data Principles
last_reviewed_on: 2022-01-24
review_in: 6 months
weight: 10
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Frontend Development Principles
last_reviewed_on: 2022-01-27
review_in: 6 months
weight: 30
old_paths:
- /documentation/principles/frontend-development-principles.html
Expand Down
20 changes: 9 additions & 11 deletions source/principles/general/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
---
last_reviewed_on: 2022-01-07
review_in: 3 months
weight: 5
---

Expand All @@ -10,24 +8,24 @@ These pages lay out principles for architecture, coding, and developing frontend
out more generic principles for technical folk at the department.

## Make things open, it makes things better
All of the code that we produce is classified at OFFICIAL and is paid for by the taxpayer. We have a duty to make that
code open, to encourage reuse, and in doing so reduce waste. That's why we use GitHub to store our code, unless there's
All of the code that we produce is classified at OFFICIAL and is paid for by the taxpayer. We have a duty to make that
code open, to encourage reuse, and in doing so reduce waste. That's why we use GitHub to store our code, unless there's
a security or policy reason to keep our work secret. Even the spooky folks at the Government Communications Headquarters
(GCHQ) have published a number of [open-source repos](https://github.com/gchq).
[We've written guidance on how to use our preferred tool, GitHub] (/standards/storing-source-code)

## Continuous integration
We believe code is made better when it's frequently integrated into the work of the rest of our teams. This manifests
in continuous integration: all developers should be committing into the main branch at least once a day. Feature branches
are short-lived and we use feature flags to prevent unexpected behaviour. Before merging, all code should be thoroughly
We believe code is made better when it's frequently integrated into the work of the rest of our teams. This manifests
in continuous integration: all developers should be committing into the main branch at least once a day. Feature branches
are short-lived and we use feature flags to prevent unexpected behaviour. Before merging, all code should be thoroughly
tested. Unit and integration tests should pass before any code is merged into the main branch. Read [the guide to continuous delivery](/guides/continuous-delivery) for more information.

## Continuous deployment
Closely linked to the idea of continuous integration is continuous deployment. Continuous deployment means deploying
code into production as frequently as possible. From this flows the idea that test coverage should be high, that smoke
tests should run frequently to assert that the state of the system is as expected, and that we monitor the system for
Closely linked to the idea of continuous integration is continuous deployment. Continuous deployment means deploying
code into production as frequently as possible. From this flows the idea that test coverage should be high, that smoke
tests should run frequently to assert that the state of the system is as expected, and that we monitor the system for
deviations from its expected state.
The continuous deployment pipeline should move an immutable artefact through different deployment stages. For example,
The continuous deployment pipeline should move an immutable artefact through different deployment stages. For example,
when using Docker:

- the image should be built once
Expand Down
2 changes: 0 additions & 2 deletions source/standards/licencing-software-or-code/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Licensing software or code
last_reviewed_on: 2022-01-12
review_in: 6 months
old_paths:
- /documentation/standards/licencing-software-or-code.html
---
Expand Down
2 changes: 0 additions & 2 deletions source/standards/naming-things/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Naming things
last_reviewed_on: 2022-09-07
review_in: 3 months
old_paths:
- /documentation/standards/naming-things.html
---
Expand Down
2 changes: 0 additions & 2 deletions source/standards/storing-source-code/index.html.md.erb
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Storing source code
last_reviewed_on: 2022-01-27
review_in: 3 months
old_paths:
- /documentation/standards/storing-source-code.html
---
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,5 @@
---
title: Using 3rd-party open source products
last_reviewed_on: 2022-01-27
review_in: 3 months
old_paths:
- /documentation/standards/using-3rd-party-open-source-products.html
---
Expand Down

0 comments on commit 0019b61

Please sign in to comment.