Skip to content

Commit

Permalink
Change all "developer" references to "engineer"
Browse files Browse the repository at this point in the history
  • Loading branch information
ahosgood committed Oct 30, 2023
1 parent d6a1f21 commit 751f968
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<img src="./docs/assets/tna-square-logo.svg" alt="The National Archives logo" title="The National Archives" width="100" />

# Developer Handbook
# Engineering Handbook

> ⚠️ This handbook is still in development but is intended to supercede [front-end-development-guide](https://github.com/nationalarchives/front-end-development-guide).
Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Getting started

Welcome to The National Archives. This guide will hopefully help you as a new developer get started.
Welcome to The National Archives. This guide will hopefully help you, as a new engineer, get started.

This guide assumes you have an Apple Mac device.
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@
## Introduction

The National Archives Developer Handbook aims to be a one-stop guide for all development questions.
The National Archives Engineering Handbook aims to be a one-stop guide for all development questions.

This guide has been produced to help developers at The National Archives:
This guide has been produced to help engineers at The National Archives:

- deliver **high quality**, **inclusive** and **maintainable** digital services
- ensure their work is **compliant with the standards and regulations** that apply to public sector websites
Expand All @@ -16,7 +16,7 @@ It covers all aspects of modern front end development and is regularly reviewed

You can also read about our [ways of working](./ways-of-working/service-standard/) in order to help you build good services that meet these standards.

This handbook is intended to supercede the existing [front-end-development-guide](https://github.com/nationalarchives/front-end-development-guide) and expand the advice and resources to all developers, both frontend and backend as well as both internal staff and external partners.
This handbook is intended to supercede the existing [front-end-development-guide](https://github.com/nationalarchives/front-end-development-guide) and expand the advice and resources to developers, both frontend and backend, technical architects as well as both internal staff and external partners.

## Key things to keep in mind

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/index.md

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions docs/technology/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,12 @@ New National Archive applications SHOULD use the following approved languages an
- [Terraform](./terraform/) - to provision and manage infrastructure in the cloud
- [Nginx](./nginx/) - to provide a reverse proxy in front of Docker containers

In addition to this, developers COULD also use:
In addition to this, engineers COULD also use:

- [TypeScript](./javascript/#typescript) - which must be compiled down to [JavaScript](./javascript/)
- [SCSS](./css/#sassscss) - allows us to more easily write CSS

Any other technologies MUST be proposed to and agreed by the [Technical Architects Group](../organisation/technical-architects-group/) through the process of [requesting changes](https://nationalarchives.github.io/developer-handbook/ways-of-working/documentation/#requesting-changes).
Any other technologies MUST be proposed to and agreed by the [Technical Architects Group](../organisation/technical-architects-group/) through the process of [requesting changes](https://nationalarchives.github.io/engineering-handbook/ways-of-working/documentation/#requesting-changes).

These decisions have been guided by [The GDS Way - Programming languages](https://gds-way.cloudapps.digital/standards/programming-languages.html).

Expand Down
4 changes: 2 additions & 2 deletions docs/ways-of-working/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

## Standards

TNA standards are documented in this handbook, available on [GitHub](https://github.com/nationalarchives/developer-handbook). These standards apply to all TNA projects.
TNA standards are documented in this handbook, available on [GitHub](https://github.com/nationalarchives/engineering-handbook). These standards apply to all TNA projects.

### Requesting changes

Anyone in TNA is able to open an issue or pull request to this handbook.

Suggestions for new technologies or standards can be done with a RFC process.

1. [Open an issue using the proposal template](https://github.com/nationalarchives/developer-handbook/issues/new?template=proposal.md&title=RFC%3A+New+proposal)
1. [Open an issue using the proposal template](https://github.com/nationalarchives/engineering-handbook/issues/new?template=proposal.md&title=RFC%3A+New+proposal)
1. The TGB will review the proposal and ask questions in the open, taking unresolved queries to the TAG
1. A pull request can then be opened to change the standards

Expand Down
2 changes: 1 addition & 1 deletion docs/ways-of-working/progressive-enhancement.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In acknowledgement of the web's inherent variability this development guide desc
- If the user's browser also supports CSS the application looks better
- If it can run JavaScript (and/or supports newer technologies colloquially known as HTML5 and ESNext) the experience will be enhanced by those capabilities

The important points for developers to recognise are that:
The important points for engineers to recognise are that:

- only the core HTML is required to meet users' basic needs, and;
- CSS, JavaScript and HTML5 APIs should be applied in such a way that they do not 'break' the experience for those clients that cannot support them
Expand Down
6 changes: 3 additions & 3 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
site_name: Developer Handbook - The National Archives
site_url: https://nationalarchives.github.io/developer-handbook/
repo_url: https://github.com/nationalarchives/developer-handbook
site_name: Engineering Handbook - The National Archives
site_url: https://nationalarchives.github.io/engineering-handbook/
repo_url: https://github.com/nationalarchives/engineering-handbook
dev_addr: 127.0.0.1:8888
strict: true
use_directory_urls: true
Expand Down

0 comments on commit 751f968

Please sign in to comment.