gds-way/source/index.html.md.erb at main · alphagov/gds-way · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
---
layout: core
title: The GDS Way
---

<% content_for :sidebar do %>
<ul>
    <li><a href='#the-gds-way'>The GDS Way</a>
        <ul>
            <li><a href='#about-the-gds-way'>About the GDS way</a></li>
            <li><a href='#how-to-add-new-guidance'>How to add new guidance</a></li>
            <li><a href='#the-gds-way-forum'>The GDS Way Forum</a></li>
        </ul>
    </li>
    <li><a href="#software-development">Software development</a>
        <%= partial 'partials/nav-software-development' %>
    </li>
    <li><a href="#version-control-and-deployments">Version control and deployments</a>
        <%= partial 'partials/nav-version-control-deployments' %>
    </li>
    <li><a href="#hosting-and-infrastructure">Hosting and infrastructure</a>
        <%= partial 'partials/nav-hosting-infrastructure' %>
    </li>
    <li><a href="#logging-monitoring-and-alerting">Logging, monitoring and alerting</a>
        <%= partial 'partials/nav-logging-monitoring-alerting' %>
    </li>
    <li><a href="#operating-a-service">Operating a service</a>
        <%= partial 'partials/nav-operating-a-service' %>
    </li>
</ul>
<% end %>

<%= partial 'partials/site-banner' %>

# <%= current_page.data.title %>

The GDS Way guides teams to build and operate brilliant, cost-effective digital services.

It documents policy, standards and guidance for the specific technology, tools and processes used by Product Group teams within the Government Digital Service (GDS).

GDS staff can find more detailed instructions for the use of GDS tooling and infrastructure on the
[GDS Engineering Hub](https://engineering-enablement.gds-reliability.engineering/),
which complements this site.

It's not intended as guidance for anyone working outside the GDS Product Group: you'll find that in the [Service Manual](https://www.gov.uk/service-manual).

## About The GDS Way

The GDS Way shares agreed ways of working so service teams benefit from:

* using similar tools
* central procurement
* costs savings as new teams will be cheaper to spin up

The GDS Way makes it easier for projects to get started while still giving teams flexibility to do something different if their project needs it.

The GDS Way includes consistent:

* terminology
* ways of working
* technology and tools
* measures

All decisions are made in alignment with [Service Manual](https://www.gov.uk/service-manual), which covers service design more broadly, and the [Technology Code of Practice](https://www.gov.uk/guidance/the-technology-code-of-practice).

Products at GDS in discovery or alpha development phases must follow [agile delivery principles](https://www.gov.uk/service-manual/agile-delivery) and also have the option to follow the standards in this repository.

Products in beta and live phases must follow both the instructions set out in the Service Manual and the standards in this repository.
They must be [secure by design](https://www.security.gov.uk/guidance/secure-by-design/).

## How to add new guidance

Contribute to this repository by making a pull request in [GitHub](https://github.com/alphagov/gds-way) for discussion at the GDS Way Forum.

You can also read the service manual to find out about
[learning about and writing user needs](https://www.gov.uk/service-manual/user-research/start-by-learning-user-needs).

Thank you for your contributions as we develop this repository.

### Submission template

When you create a new Markdown file follow this pattern and then make a pull request:

```markdown
---
title: Thing you're writing a standard about
last_reviewed_on: yyyy-mm-dd
review_in: 6 months
---

# <%%= current_page.data.title %>

Introduction of a couple of paragraphs to explain why the thing you're
writing a standard about is important.

## User needs

Why do we do this thing? Who is it helping?

## Principles

What broad approaches do we follow when we do this thing?

## Tools

What specific bits of software (commercial or open source) do
we use to help us do this thing?
```

## The GDS Way Forum

This site documents some of the decisions agreed at the GDS Way Forum about the products we operate.

The GDS Forum meets once a month. The Forum is lead developers and technical architects representing GDS programmes who are responsible for communicating and implementing the GDS Way.

The Forum reviews:

* all GDS Way open and closed PRs
* expired guidance and if it should be continued
* possible subject areas and ownership of new content

### Contact The GDS Way Forum

Contact the GDS Way Forum using the [#gds-way Slack channel](https://gds.slack.com/messages/gds-way/) or by email at <a href="mailto:the-gds-way@digital.cabinet-office.gov.uk?subject=feedback">the-gds-way@digital.cabinet-office.gov.uk</a>.

## Software development

<%= partial 'partials/nav-software-development' %>

## Version control and deployments

<%= partial 'partials/nav-version-control-deployments' %>

## Hosting and infrastructure

<%= partial 'partials/nav-hosting-infrastructure' %>

## Logging, monitoring and alerting

<%= partial 'partials/nav-logging-monitoring-alerting' %>

## Operating a service

<%= partial 'partials/nav-operating-a-service' %>

## How to remove guidance

There comes a time where tools, techniques, technology or guidance changes, or we no longer feel the need to document a specific approach.

These documents will always be in our git history and available in search, so you will know if the GDS Way previously had an article on a topic.

Withdrawing a page consists of:

 - Adding the `layout: withdrawn` field to the page's frontmatter in this repository.
 - Changing the `last_reviewed_date` to one year from the current date.
 - Deleting the page from the repository if a year has passed since it was withdrawn.

## Withdrawn guidance

<ul>
    <% sitemap.resources.each do |resource| %>
        <% if resource.options[:layout].eql? "withdrawn" %>
            <li>
                <a href="<%= resource.url =%>"><%= resource.data.title =%></a>
            </li>
        <% end %>
    <% end %>
</ul>