Skip to content

Commit

Permalink
♻️ Align documentation with GOV.UK style guide for clarity and consis…
Browse files Browse the repository at this point in the history
…tency
  • Loading branch information
jasonBirchall committed Jan 29, 2025
1 parent 8c682b3 commit 5dacb16
Showing 1 changed file with 17 additions and 19 deletions.
36 changes: 17 additions & 19 deletions source/kubernetes/index.html.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,59 +8,57 @@ layout: multipage_layout

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

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.
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.

## Who is this for?
## Who this guide is for

This documentation is for:

- Developers, engineers, and stakeholders deploying and managing applications on the platform.

- Platform engineers and administrators responsible for maintaining and extending the platform.
- **Developers and engineers**: Deploying and managing applications on the platform.
- **Platform engineers and administrators**: Maintaining and extending the platform.

## User Guide

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.
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.

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.
If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome.

### Getting Started

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

### Tutorials

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

### Concepts

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

## Runbooks

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

### Common tasks

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

## Cheatsheet

Quickly reference common commands and workflows in the [Cheatsheet](../../kubernetes/cheatsheet.html).
Quickly reference common commands and workflows in the [cheatsheet](../../kubernetes/cheatsheet.html).

## Contact the Platform Engineering Team

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

0 comments on commit 5dacb16

Please sign in to comment.