Add prerequisites, adjust quick start installation & add architecture diagram #38
Conversation
jlnhnng
commented
Nov 14, 2024
•
jlnhnng
commented
- Added new site with installation requirements
- Moved requirements from Quick Start Installation to new site
- Added architecture diagrams for dark and light theme
- Added css for switch between dark and light image
- Added glightbox feature for image zoom-in
jlnhnng
changed the title
| ## Requirements | ||
|
|
||
| Project 2A requires a Kubernetes cluster. It can be of any type and will serve as the 2A _management cluster_. | ||
|
|
||
| If you don't yet have a Kubernetes cluster, consider using [k0s](https://docs.k0sproject.io/stable/install/). | ||
|
|
||
| The following instructions assume: | ||
|
|
||
| - Your `kubeconfig` points to the correct Kubernetes cluster. | ||
| - You have [Helm](https://helm.sh/docs/intro/install/) installed. | ||
| - You have [kubectl](https://kubernetes.io/docs/tasks/tools/#kubectl) installed. | ||
|
|
There was a problem hiding this comment.
I'm not sure I'm a big fan of moving the requirements away from the Quickstart, this will require a first time user to go through 3 pages of documentation to have a cluster up and running (PreRequisites, General Quickstart and Infra specific Quickstart).
Could we leave the Requirements in the General Quickstart page, and reference to the additional prerequisites page?
There was a problem hiding this comment.
Yes, sure. I can pull the latest and work your feedback in.
There was a problem hiding this comment.
can you provide the source of this? so we can update it whenever needed?
There was a problem hiding this comment.
In which format would you like the diagram? I can export it EPS or SVG. I've created it via Sketch. So, can be a sketch document as well.
Where is there best place to save the source?
There was a problem hiding this comment.
In which format would you like the diagram? I can export it EPS or SVG. I've created it via Sketch. So, can be a sketch document as well.
yea let's upload the sketch file, so we have something that can be actually edited if needed by other people.
Where is there best place to save the source?
I would say also in the assets folder were the PNG lies
There was a problem hiding this comment.
In which format would you like the diagram? Only PNG?
