From 0dc0d0a40915dace1f5829b30bbd7171d226bf34 Mon Sep 17 00:00:00 2001 From: Fernando Ripoll Date: Thu, 25 Apr 2024 12:19:28 +0200 Subject: [PATCH] Getting started sections (#2169) * 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 * Address Andreas comments * Update _template.md.tpl * Fix menu and folder names --------- Co-authored-by: Andreas Sommer --- src/content/getting started/_index.md | 8 ----- src/content/getting-started/_index.md | 8 +++++ src/content/getting-started/_template.md.tpl | 30 +++++++++++++++++++ .../access-to-platform-api/_index.md | 15 ++++++++++ .../getting-started/expose-your-app/_index.md | 26 ++++++++++++++++ .../install-an-application/_index.md | 18 +++++++++++ .../observe-your-clusters-and-apps/_index.md | 15 ++++++++++ .../prepare-your-provider-account/_index.md | 17 +++++++++++ .../aws/_index.md | 12 ++++++++ .../azure/_index.md | 13 ++++++++ .../vmware-cloud-director/_index.md | 13 ++++++++ .../vmware-vsphere/_index.md | 13 ++++++++ .../_index.md | 18 +++++++++++ 13 files changed, 198 insertions(+), 8 deletions(-) delete mode 100644 src/content/getting started/_index.md create mode 100644 src/content/getting-started/_index.md create mode 100644 src/content/getting-started/_template.md.tpl create mode 100644 src/content/getting-started/access-to-platform-api/_index.md create mode 100644 src/content/getting-started/expose-your-app/_index.md create mode 100644 src/content/getting-started/install-an-application/_index.md create mode 100644 src/content/getting-started/observe-your-clusters-and-apps/_index.md create mode 100644 src/content/getting-started/prepare-your-provider-account/_index.md create mode 100644 src/content/getting-started/prepare-your-provider-account/aws/_index.md create mode 100644 src/content/getting-started/prepare-your-provider-account/azure/_index.md create mode 100644 src/content/getting-started/prepare-your-provider-account/vmware-cloud-director/_index.md create mode 100644 src/content/getting-started/prepare-your-provider-account/vmware-vsphere/_index.md create mode 100644 src/content/getting-started/provision-your-first-workload-cluster/_index.md diff --git a/src/content/getting started/_index.md b/src/content/getting started/_index.md deleted file mode 100644 index cd0abb1cd1..0000000000 --- a/src/content/getting started/_index.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Getting started -description: Start building your cloud-native developer platform based on the Giant Swarm platform. -weight: 80 -last_review_date: 2024-03-18 -owner: - - https://github.com/orgs/giantswarm/teams/sig-docs ---- diff --git a/src/content/getting-started/_index.md b/src/content/getting-started/_index.md new file mode 100644 index 0000000000..5c9152698b --- /dev/null +++ b/src/content/getting-started/_index.md @@ -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 +--- diff --git a/src/content/getting-started/_template.md.tpl b/src/content/getting-started/_template.md.tpl new file mode 100644 index 0000000000..a57100e9e7 --- /dev/null +++ b/src/content/getting-started/_template.md.tpl @@ -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 diff --git a/src/content/getting-started/access-to-platform-api/_index.md b/src/content/getting-started/access-to-platform-api/_index.md new file mode 100644 index 0000000000..020214d62c --- /dev/null +++ b/src/content/getting-started/access-to-platform-api/_index.md @@ -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? +--- diff --git a/src/content/getting-started/expose-your-app/_index.md b/src/content/getting-started/expose-your-app/_index.md new file mode 100644 index 0000000000..b724ad6d43 --- /dev/null +++ b/src/content/getting-started/expose-your-app/_index.md @@ -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? +--- + + diff --git a/src/content/getting-started/install-an-application/_index.md b/src/content/getting-started/install-an-application/_index.md new file mode 100644 index 0000000000..1936219fb9 --- /dev/null +++ b/src/content/getting-started/install-an-application/_index.md @@ -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? +--- + + diff --git a/src/content/getting-started/observe-your-clusters-and-apps/_index.md b/src/content/getting-started/observe-your-clusters-and-apps/_index.md new file mode 100644 index 0000000000..28ebb7a98c --- /dev/null +++ b/src/content/getting-started/observe-your-clusters-and-apps/_index.md @@ -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? +--- + + diff --git a/src/content/getting-started/prepare-your-provider-account/_index.md b/src/content/getting-started/prepare-your-provider-account/_index.md new file mode 100644 index 0000000000..bbaabe0e87 --- /dev/null +++ b/src/content/getting-started/prepare-your-provider-account/_index.md @@ -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? +--- + + diff --git a/src/content/getting-started/prepare-your-provider-account/aws/_index.md b/src/content/getting-started/prepare-your-provider-account/aws/_index.md new file mode 100644 index 0000000000..f74f9f6bca --- /dev/null +++ b/src/content/getting-started/prepare-your-provider-account/aws/_index.md @@ -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? +--- + diff --git a/src/content/getting-started/prepare-your-provider-account/azure/_index.md b/src/content/getting-started/prepare-your-provider-account/azure/_index.md new file mode 100644 index 0000000000..859051e70c --- /dev/null +++ b/src/content/getting-started/prepare-your-provider-account/azure/_index.md @@ -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? +--- + diff --git a/src/content/getting-started/prepare-your-provider-account/vmware-cloud-director/_index.md b/src/content/getting-started/prepare-your-provider-account/vmware-cloud-director/_index.md new file mode 100644 index 0000000000..dc3dec6844 --- /dev/null +++ b/src/content/getting-started/prepare-your-provider-account/vmware-cloud-director/_index.md @@ -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? +--- + diff --git a/src/content/getting-started/prepare-your-provider-account/vmware-vsphere/_index.md b/src/content/getting-started/prepare-your-provider-account/vmware-vsphere/_index.md new file mode 100644 index 0000000000..16f85830d6 --- /dev/null +++ b/src/content/getting-started/prepare-your-provider-account/vmware-vsphere/_index.md @@ -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? +--- + diff --git a/src/content/getting-started/provision-your-first-workload-cluster/_index.md b/src/content/getting-started/provision-your-first-workload-cluster/_index.md new file mode 100644 index 0000000000..d6b99f4e90 --- /dev/null +++ b/src/content/getting-started/provision-your-first-workload-cluster/_index.md @@ -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? +--- + +