Skip to content
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

Intro page overview #2160

Merged
merged 33 commits into from
Apr 29, 2024
Merged

Intro page overview #2160

merged 33 commits into from
Apr 29, 2024

Conversation

pipo02mix
Copy link
Contributor

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.

@pipo02mix pipo02mix requested a review from a team as a code owner March 8, 2024 10:10
@pipo02mix pipo02mix self-assigned this Mar 8, 2024
@pipo02mix pipo02mix requested a review from a team March 8, 2024 10:11
@pipo02mix pipo02mix marked this pull request as draft March 8, 2024 10:11
@teemow
Copy link
Member

teemow commented Mar 8, 2024

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.

Co-authored-by: Timo Derstappen <timo@giantswarm.io>
Copy link
Member

@puja108 puja108 left a comment

Choose a reason for hiding this comment

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

I think it's already pretty good now. Some minor comments only.

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?

@pipo02mix pipo02mix marked this pull request as ready for review March 12, 2024 15:04
@pipo02mix pipo02mix requested a review from puja108 March 12, 2024 15:04
@pipo02mix
Copy link
Contributor Author

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
Copy link
Member

puja108 commented Apr 16, 2024

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
Copy link
Contributor Author

PTAL

auto-merge was automatically disabled April 19, 2024 13:51

Merge queue setting changed

src/content/overview/architecture.md Outdated Show resolved Hide resolved
src/content/overview/architecture.md Outdated Show resolved Hide resolved
@pipo02mix pipo02mix requested a review from AndiDog April 26, 2024 09:54
src/content/overview/introduction/_index.md Outdated Show resolved Hide resolved
src/content/overview/introduction/_index.md Outdated Show resolved Hide resolved
src/content/overview/introduction/_index.md Outdated Show resolved Hide resolved
src/content/overview/introduction/_index.md Outdated Show resolved Hide resolved

Most of the developers want to deploy an app into production without having to worry too much about security or compliance, but still have good monitoring and deployment options. Our goal is to help the engineers who build and maintain the platform meet developers' expectations without compromising their organizations' security posture.

Giant Swarm addresses this challenge by providing a flexible base platform. The platform enables technology departments to ensure governance and control over development processes and operations, while providing developers a smooth development cycle. Check out the documentation to learn how we make this possible.
Copy link
Member

Choose a reason for hiding this comment

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

The last sentence feels a bit weird when I'm already inside the documentation. Do you want to point the reader to continue reading this docs page or generally more docs to learn...?

Copy link
Member

@puja108 puja108 left a comment

Choose a reason for hiding this comment

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

other than minor language edits lgtm

pipo02mix and others added 3 commits April 29, 2024 15:06
Co-authored-by: Puja <puja108@gmail.com>
Co-authored-by: Cedric Kaufmann <60580186+ced0ps@users.noreply.github.com>
@pipo02mix pipo02mix enabled auto-merge (squash) April 29, 2024 13:25
@pipo02mix pipo02mix merged commit 2d45dc9 into main Apr 29, 2024
4 of 6 checks passed
@pipo02mix pipo02mix deleted the intro-page-overview branch April 29, 2024 13:27
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.

None yet

5 participants