Intro page overview - Githubissues

giantswarm / docs

The Giant Swarm documentation site

http://docs.giantswarm.io

Apache License 2.0

4 stars 8 forks source link

Intro page overview #2160

Closed pipo02mix closed 6 months ago

pipo02mix commented 8 months ago

What this PR does / why we need it

Towards https://github.com/giantswarm/giantswarm/issues/30179

Things to check/remember before submitting

If you made content changes
- Run make dev to render and proofread content changes locally.
- Bump last_review_date in the front matter header if you reviewed the entire page.

teemow commented 8 months ago

I've worked on the english a bit but imo there is more to it than fixing each paragraph. @JosephSalisbury @puja108 please take a look as well and add your ideas how we can create a good intro here.

pipo02mix commented 8 months ago

I was thinking if a graphic or diagram might help visualize this. Either copy the one from CNCF white paper or something from our tech deck. WDYT?

For the platform diagram, I thought it would fit better in the next section "Architecture". WDYT?

puja108 commented 6 months ago

For the platform diagram, I thought it would fit better in the next section "Architecture". WDYT?

Fine with having it in architecture. I was thinking we could have an abstract one like from the white paper in here and then the architecture one goes deeper into how our real architecture looks like, but not emotional on this, fine to have it just in architecture.

pipo02mix commented 6 months ago

PTAL