Skip to content

Conversation

jasonBirchall
Copy link
Contributor

👀 Purpose

  • While working on platform documentation, I realised how awkward linking from the index page is. I believe this is partly because the index page does a fine job of describing the platform to someone who already knows what a platform is, but is terrible at guiding users through using our platform from scratch or even as a refresher.
  • I hope the changes in this PR make linking more manageable and create a framework for good user engagement.
  • I also hope that the team can start to publish some of its practices and ways of working.

♻️ What's changed

  • The index page is heavily refactored and now includes two paths:
    -- A developer path: for a tenant using the platform, which comes under the guise of "user-guide"
    -- A platform engineer path: for the operators and engineers of the platform, intended for internal team use.

📝 Notes

  • You can follow the instructions in the readme for a better look at the refactor, but I'll include screenshots below:
image image Screenshot 2025-01-28 at 15 55 06

Copy link
Contributor

@AgaDufrat AgaDufrat left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sparks joy ✨ so neatly organised 🤩
I left a couple of minor comments.

@jasonBirchall jasonBirchall force-pushed the update-platform-index-page branch from 0063019 to 5dacb16 Compare January 29, 2025 09:31
@jasonBirchall jasonBirchall marked this pull request as ready for review February 11, 2025 16:54
@jasonBirchall jasonBirchall changed the title ♻️ [Concept] Refactor index page to include user-guide and runbook sections ♻️ Refactor platform index page to include user-guide and runbook sections Feb 11, 2025
This excludes a large number of users who might be put off by that term.
Copy link
Contributor

@sihugh sihugh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like a good update, thanks 🚀


Kubernetes is a widely-used, open-source [container orchestration system](https://cloud.google.com/discover/what-is-container-orchestration) for managing containerised workloads such as GOV.UK's.
If something is missing, let us know, and we’ll add an article. If you're comfortable contributing, pull requests (PRs) are welcome.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add an anchor link to the #contact-the-platform-engineering-team section? Or direct to the page? (And possibly in the next paragraph too)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for now, but if this is more "platform" than Kubernetes, we probably want to remap the path to reflect that.

@jasonBirchall jasonBirchall marked this pull request as draft February 18, 2025 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants