Add prerequisites, adjust quick start installation & add architecture diagram #38
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
Schnitzel
requested changes
Nov 18, 2024
Comment on lines
+1
to
+12
| ## 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.
can you provide the source of this? so we can update it whenever needed?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.