-
Notifications
You must be signed in to change notification settings - Fork 31
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
♻️ [Concept] Refactor index page to include user-guide and runbook sections #4967
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this 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.
|
||
## Introduction |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there a reason for removing the intro section about Kubernetes? I think it was be quite informative, especially for less experienced devs. We have apprentices and juniors who would benefit from reading up on the technology before jumping into the user guide.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Indeed, it's helpful information, but it's not that helpful on the index page. Kubernetes scares people off at the best times, but throwing it into an introduction is unnecessary and distracts people away from what's important. I prefer to explain the abstraction (platform level) here, the what and why, and leave the technology choices to those who want to know about them. Technology choices (in my opinion) are far better placed in the "How the platform works" section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps we could have a section in the "How the platform works" section explaining our technology decision-making.
source/kubernetes/get-started/tutorials/app-update-deploy-monitor-logs/index.html.md
Show resolved
Hide resolved
source/kubernetes/index.html.md
Outdated
|
||
### Getting Started | ||
|
||
- [Gain access to a platform EKS Cluster](../../kubernetes/get-started/access-eks-cluster/index.html) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Non-blocking or that important – I believe we don’t need to use absolute paths (which would save us some characters) but double check 🙈
- [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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Absolutely, that's spot on. I have to use it for the local deployment to work, but I'll change it when it's moved to "Ready for Review".
0063019
to
5dacb16
Compare
👀 Purpose
♻️ What's changed
-- 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