Skip to content

Commit 5dacb16

Browse files
committed
♻️ Align documentation with GOV.UK style guide for clarity and consistency
1 parent 8c682b3 commit 5dacb16

File tree

1 file changed

+17
-19
lines changed

1 file changed

+17
-19
lines changed

source/kubernetes/index.html.md

Lines changed: 17 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,59 +8,57 @@ layout: multipage_layout
88

99
The GOV.UK Internal Developer Platform is a centralised platform where teams can build, deploy, and manage applications in a reliable and secure environment.
1010

11-
This documentation is designed for both platform users and internal team members, providing guides, tools, and best practices to onboard, manage, and troubleshoot your applications effectively.
11+
This documentation is for both platform users and internal team members. It provides guides, tools, and best practices to help onboard, manage, and troubleshoot applications efficiently.
1212

13-
## Who is this for?
13+
## Who this guide is for
1414

1515
This documentation is for:
1616

17-
- Developers, engineers, and stakeholders deploying and managing applications on the platform.
18-
19-
- Platform engineers and administrators responsible for maintaining and extending the platform.
17+
- **Developers and engineers**: Deploying and managing applications on the platform.
18+
- **Platform engineers and administrators**: Maintaining and extending the platform.
2019

2120
## User Guide
2221

23-
This section is specifically for application developers using the platform. The platform is designed to reduce cognitive load for developers by abstracting away infrastructure complexity and providing tools, guides, and automated workflows.
22+
This section is for application developers using the platform. The platform reduces cognitive load by abstracting infrastructure complexity and providing tools, guides, and automated workflows.
2423

25-
If there’s something missing, please either let us know and we’ll add a new article, or if youre comfortable writing one yourself, PRs will be gratefully received.
24+
If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome.
2625

2726
### Getting Started
2827

29-
- [Gain access to a platform EKS Cluster](../../kubernetes/get-started/access-eks-cluster/index.html)
28+
- [Gain access to a platform EKS cluster](../../kubernetes/get-started/access-eks-cluster/index.html)
3029
- [Set up the recommended tools](../../kubernetes/get-started/set-up-tools/index.html)
3130
- [Understand how the platform works](../../kubernetes/how-platform-works/index.html)
3231

3332
### Tutorials
3433

3534
- [Create a new application](../../kubernetes/create-app/index.html)
36-
- [Update an application's environment in our Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html)
35+
- [Update an application's environment in Helm charts](../../kubernetes/get-started/tutorials/app-config-deploy-helm-chart/index.html)
3736
- [Update, deploy, and monitor an application](../../kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html)
38-
- [Set or change an environment variable in your application](../../kubernetes/manage-app/set-env-var/index.html)
37+
- [Set or change an environment variable](../../kubernetes/manage-app/set-env-var/index.html)
3938
- [Add secrets to your application](../../kubernetes/manage-app/manage-secrets/index.html)
4039
- [Horizontally and vertically scale your application](../../kubernetes/manage-app/scale-app/index.html)
41-
- [Rolling Back Applications](../../kubernetes/manage-app/roll-back-app/index.html)
42-
- [Fix your application when something's gone wrong](../../kubernetes/fix-app/index.html)
43-
- [View your application and inspect Kubernetes via the command-line](../../kubernetes/manage-app/get-app-info/index.html)
44-
- [Troubleshoot your failed deployment](../../kubernetes/manage-app/manage-state/index.html)
40+
- [Roll back applications](../../kubernetes/manage-app/roll-back-app/index.html)
41+
- [Fix your application when something goes wrong](../../kubernetes/fix-app/index.html)
42+
- [View your application and inspect Kubernetes using the command line](../../kubernetes/manage-app/get-app-info/index.html)
43+
- [Troubleshoot failed deployments](../../kubernetes/manage-app/manage-state/index.html)
4544

4645
### Concepts
4746

4847
- [How we release a new version of your app](../../kubernetes/manage-app/release-new-version/index.html)
49-
- [How is your application deployed](../../kubernetes/manage-app/access-ci-cd/index.html)
48+
- [How applications are deployed](../../kubernetes/manage-app/access-ci-cd/index.html)
5049

5150
## Runbooks
5251

53-
This section is specifically for platform engineers and administrators and should act as a place for knowledge capture and ways of working practices.
52+
This section is for **platform engineers and administrators**. It serves as a central place for capturing knowledge and documenting ways of working.
5453

5554
### Common tasks
5655

57-
- [Create New Environments](../../kubernetes/manage-app/create-new-env/index.html)
56+
- [Create new environments](../../kubernetes/manage-app/create-new-env/index.html)
5857

5958
## Cheatsheet
6059

61-
Quickly reference common commands and workflows in the [Cheatsheet](../../kubernetes/cheatsheet.html).
60+
Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html).
6261

6362
## Contact the Platform Engineering Team
6463

6564
Need help? Visit [Contact the Platform Engineering Team](../../kubernetes/contact-platform-engineering-team.html) for support options.
66-

0 commit comments

Comments
 (0)