-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Getting started sections * Add all the sections * Extend template * Fix linting errors * Address some coments * Apply suggestions from code review * Apply suggestions from code review Co-authored-by: Andreas Sommer <[email protected]> * Address Andreas comments * Update _template.md.tpl * Fix menu and folder names --------- Co-authored-by: Andreas Sommer <[email protected]>
- Loading branch information
Showing
13 changed files
with
198 additions
and
8 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
--- | ||
title: Getting started | ||
description: Step-by-step customer journey to build your cloud-native developer platform. | ||
weight: 80 | ||
last_review_date: 2024-04-05 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
--- |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
title: Short title for this page, it is shown as title in upper section and menu | ||
description: At least 70 characters that describe the purpose of this page. | ||
weight: from 10 to 100. Lower is higher in the menu. | ||
last_review_date: 2024-03-19 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/${OWNER} | ||
user_questions: | ||
- List of questions that users might ask about this topic. | ||
--- | ||
|
||
Today, `getting started` pages are about guiding a new user, or platform engineer, to build their platform with Giant Swarm. The articles are ordered to be followed one after the other to show all features we offer from the suffice. Dont go to deep into the topics, we have tutorials or reference pages for that purpose, here is just an introduction. | ||
|
||
Recommended sections can help you to start with the article: | ||
|
||
## Introduction | ||
|
||
General definition of the area/topic you are going to develop. Since this is a step across the getting started section it has a previous and after page entry, so be aware it has continuity. | ||
|
||
## Prerequisites | ||
|
||
Indicate if the user needs to have installed any specific tool or should have read or prepared their local environment before. | ||
|
||
## Steps | ||
|
||
List of sequence steps that users will follow to accomplish the goal described in the introduction. | ||
|
||
## Conclusion | ||
|
||
Wrap-up of what has been done. Comment what it is next, so the user can continue the journey |
15 changes: 15 additions & 0 deletions
15
src/content/getting-started/access-to-platform-api/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Access to the platform API | ||
description: How engineers can access the platform API to provision new workload clusters or deploy applications. | ||
weight: 30 | ||
last_review_date: 2024-04-25 | ||
menu: | ||
principal: | ||
parent: getting-started | ||
identifier: getting-started-access | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How can I access the platform API? | ||
- What do I need to do to access the platform API? | ||
--- |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
title: Expose your app to the internet | ||
description: Make your application accessible from the outside using an ingress controller. | ||
weight: 60 | ||
last_review_date: 2024-04-25 | ||
menu: | ||
principal: | ||
parent: getting-started | ||
identifier: getting-started-expose-app | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How does basic connectivity work in the platform? | ||
- What are the options for service connectivity in the platform? | ||
--- | ||
|
||
<!-- | ||
Explain how basic connectivity works (private vs public) through an example | ||
Topics | ||
- Private connectivity | ||
- Public connectivity | ||
- Default network policies | ||
- Ingress and egress | ||
Maybe example of an application with helo world example https://github.com/giantswarm/hello-world-app/ | ||
--> |
18 changes: 18 additions & 0 deletions
18
src/content/getting-started/install-an-application/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Install an application using the app platform | ||
linkTitle: Install an application | ||
description: Add capabilities to your platform by deploying applications from our catalog. | ||
weight: 50 | ||
last_review_date: 2024-04-25 | ||
menu: | ||
principal: | ||
parent: getting-started | ||
identifier: getting-started-install-app | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I configure the app platform to build my capabilities? | ||
- What do I need to do to configure the app platform to build my capabilities? | ||
--- | ||
|
||
<!-- Choice of apps from catalog (e.g. via happa), configuration with values (often defaults are recommended), installation with kubectl-gs templating and apply (we should use a very commonly used example such as nginx-ingress or ESO) --> |
15 changes: 15 additions & 0 deletions
15
src/content/getting-started/observe-your-clusters-and-apps/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
title: Observe your clusters and apps | ||
description: Check cluster and app metrics and logs with the observability tools provided with the Giant Swarm platform. | ||
weight: 70 | ||
last_review_date: 2024-04-05 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I observe the platform metrics and logs for my application? | ||
- What do I need to do to observe the platform metrics and logs for my application? | ||
--- | ||
|
||
<!-- | ||
Show how to access Grafana and basic dashboard and logs | ||
--> |
17 changes: 17 additions & 0 deletions
17
src/content/getting-started/prepare-your-provider-account/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
title: Prepare your provider account | ||
description: Set up your infrastructure provider (e.g. AWS account) in order to run a Giant Swarm management cluster and workload clusters, all remaining under your ownership. | ||
weight: 10 | ||
last_review_date: 2024-04-25 | ||
menu: | ||
principal: | ||
parent: getting-started | ||
identifier: getting-started-prepare-provider-account | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I prepare my provider account for the cloud-native developer platform? | ||
- What do I need to do to prepare my provider account for the cloud-native developer platform? | ||
--- | ||
|
||
<!-- Mention in the end of article that next step is provisioning a management cluster and it is done by Giant Swarm. Until it is done, the platform API is not accessible. --> |
12 changes: 12 additions & 0 deletions
12
src/content/getting-started/prepare-your-provider-account/aws/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
--- | ||
title: Prepare your AWS account | ||
description: Prepare your AWS account to start building your cloud-native developer platform with Giant Swarm. | ||
weight: 10 | ||
last_review_date: 2024-04-05 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I prepare my AWS account for the cloud-native developer platform? | ||
- What do I need to do to prepare my AWS account for the cloud-native developer platform? | ||
--- | ||
|
13 changes: 13 additions & 0 deletions
13
src/content/getting-started/prepare-your-provider-account/azure/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Prepare your provider account for Azure | ||
linkTitle: Prepare your Azure account | ||
description: Prepare your Azure account to start building your cloud-native developer platform with Giant Swarm. | ||
weight: 20 | ||
last_review_date: 2024-04-05 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I prepare my Azure account for the cloud-native developer platform? | ||
- What do I need to do to prepare my Azure account for the cloud-native developer platform? | ||
--- | ||
|
13 changes: 13 additions & 0 deletions
13
...t/getting-started/prepare-your-provider-account/vmware-cloud-director/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Prepare your provider account for VMware Cloud Director | ||
linkTitle: Prepare your VCD account | ||
description: Prepare your VMware Cloud Director setup to start building your cloud-native developer platform with Giant Swarm. | ||
weight: 10 | ||
last_review_date: 2024-04-05 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I prepare my VMware Cloud Director account for the cloud-native developer platform? | ||
- What do I need to do to prepare my VCD account for the cloud-native developer platform? | ||
--- | ||
|
13 changes: 13 additions & 0 deletions
13
src/content/getting-started/prepare-your-provider-account/vmware-vsphere/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
--- | ||
title: Prepare your provider account for VMware vSphere | ||
linkTitle: Prepare your vSphere account | ||
description: Prepare your VMware vSphere setup to start building your cloud-native developer platform with Giant Swarm. | ||
weight: 10 | ||
last_review_date: 2024-04-01 | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I prepare my VMware vSphere account for the cloud-native developer platform? | ||
- What do I need to do to prepare my VMware vSphere account for the cloud-native developer platform? | ||
--- | ||
|
18 changes: 18 additions & 0 deletions
18
src/content/getting-started/provision-your-first-workload-cluster/_index.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
--- | ||
title: Create a workload cluster and install applications | ||
linkTitle: Provision your first workload cluster | ||
description: Experience the steps to configure and provision your first workload cluster using the platform API. | ||
weight: 40 | ||
last_review_date: 2024-04-25 | ||
menu: | ||
principal: | ||
parent: getting-started | ||
identifier: getting-started-provision-cluster | ||
owner: | ||
- https://github.com/orgs/giantswarm/teams/sig-docs | ||
user_questions: | ||
- How do I configure and provision my first workload cluster? | ||
- What do I need to do to configure and provision my first workload cluster? | ||
--- | ||
|
||
<!-- Easy happy path to create the first WC (probably tabs per provider), showing storage and scaling bits --> |