Skip to content
This repository was archived by the owner on Dec 29, 2025. It is now read-only.

Commit 1ad45b9

Browse files
committed
chore: Review comments developer platform docs
1 parent 9b348ab commit 1ad45b9

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

docs/meshstack.aks-developer-platform-quickstart-guide.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,30 @@ title: AKS Developer Platform Guide
55

66
## Introduction
77

8-
Welcome to the **First Developer Platform guide**! This guide provides step-by-step instructions to help you set up your first developer platform experience incorporating AKS, GitHub & GitHub Actions to deliver an easy-to-use starter kit to your application teams.
8+
Welcome to the **First Developer Platform Guide**! This guide provides step-by-step instructions to help you set up your first developer platform experience incorporating AKS, GitHub & GitHub Actions to deliver an easy-to-use starter kit to your application teams.
99

1010
## Goals
1111

1212
By the end of this guide, you will have built a complete starter kit for your users that will provide:
1313

1414
- A new GitHub repository
1515
- A “dev” project with:
16-
- an AKS namespace
17-
- a GitHub actions workflow with credentials to the AKS namespace
16+
- an AKS namespace
17+
- a GitHub actions workflow with credentials to the AKS namespace
1818
- A “prod” project with:
19-
- an AKS namespace
20-
- a GitHub actions workflow with credentials to the AKS namespace
19+
- an AKS namespace
20+
- a GitHub actions workflow with credentials to the AKS namespace
2121

2222
## Prerequisites
2323

2424
Before starting, ensure you have the following:
2525

2626
- You have a basic understanding of building blocks in meshStack.
27-
- *If you don’t, we recommend running through the [AWS S3 guide](./meshstack.building-aws-quickstart-guide.md) to learn how building blocks work.*
27+
- *If you don’t, we recommend running through the [AWS S3 guide](./meshstack.building-aws-quickstart-guide.md) to learn how building blocks work.*
2828
- You have integrated an AKS cluster into meshStack.
29-
- *If you don’t, we recommend running through the [First Platform guide for AKS](./meshstack.aks-platform-quickstart-guide.md) where you are guided to integrate an AKS cluster as a platform in meshStack*
29+
- *If you don’t, we recommend running through the [First Platform guide for AKS](./meshstack.aks-platform-quickstart-guide.md) where you are guided to integrate an AKS cluster as a platform in meshStack*
3030

31-
## What will we do in this guide?
31+
## What Will We Do in This Guide?
3232

3333
Shortly put, we will set up the following in this guide:
3434

@@ -38,7 +38,7 @@ Shortly put, we will set up the following in this guide:
3838

3939
## 1. GitHub Repository
4040

41-
### Preparation
41+
### Preparing GitHub Repository
4242

4343
The GitHub Repository building block definition needs access to your GitHub organization.
4444
Follow the following steps to create a GitHub App that will be used to manage the repositories.
@@ -56,25 +56,25 @@ Follow the following steps to create a GitHub App that will be used to manage th
5656
3. [**Create a GitHub App Private Key**](https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/managing-private-keys-for-github-apps)
5757
1. Save this file somewhere convenient as we will also need it later.
5858

59-
### Creating the Building Block Definition
59+
### Creating the Repository Building Block Definition
6060

6161
To make things easy, we will use the [meshStack Hub](https://hub.meshcloud.io) to create the new building block definition.
6262

63-
1. Open the Github Repository Creation Definition in the hub [here](https://hub.meshcloud.io/definitions/github-repository).
63+
1. Open the Github Repository Creation Definition in the meshStack hub [here](https://hub.meshcloud.io/definitions/github-repository).
6464
2. Click on “Add to meshStack” and enter your meshStack URL (if not given already).
6565
3. Continue the flow in meshStack.
6666
1. Right away you will be asked for a “Type”. Pick “Workspace Building Block” here.
6767
2. Continue until you reach the “Inputs” page. On this page you will be forced to fill in the following:
6868
1. `GITHUB_APP_ID` - This is the value saved under “Preparation” step 1b.
6969
2. `GITHUB_APP_INSTALLATION_ID` - This is the value saved under “Preparation” step 2b.
70-
3. `GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a.
70+
3. `GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a. Take the entire content of the file and paste it in here.
7171
4. Finish the flow and create the building block definition.
7272

7373
🎉 The GitHub Repository Building Block Definition is ready!
7474

7575
## 2. GitHub Actions Connector
7676

77-
### Preparation
77+
### Preparing the GitHub Actions Connector
7878

7979
This building block definition will interact with both GitHub & AKS, so we need authorization for both.
8080

@@ -84,11 +84,11 @@ For AKS, you will need to run the Terraform code in the backplane that will set
8484

8585
Make sure you save the `config_tf` output and save it as a file called `config.tf`. We will use it later.
8686

87-
### Creating the Building Block Definition
87+
### Creating the GitHub Actions Connector Building Block Definition
8888

8989
We will again use the [meshStack Hub](https://hub.meshcloud.io) to create the new building block definition.
9090

91-
1. Open the Github Actions Integration with AKS definition in the hub [here](https://hub.meshcloud.io/definitions/aks-github-connector).
91+
1. Open the Github Actions Integration with AKS definition in the meshStack hub [here](https://hub.meshcloud.io/definitions/aks-github-connector).
9292
2. Click on “Add to meshStack” and enter your meshStack URL (if not given already).
9393
3. Continue the flow in meshStack.
9494
1. Right away you will be asked for a “Type”. Pick “Tenant Building Block” here and select “AKS” as the supported platform.
@@ -98,8 +98,8 @@ We will again use the [meshStack Hub](https://hub.meshcloud.io) to create the ne
9898
2. `github_repo` - This refers to the GitHub repository to connect to. Open this up and set the “Source” to “Parent Building Block Output” and set the corresponding output to “repo_name”.
9999
3. `GITHUB_APP_ID` - This is the value saved under “Preparation” step 1b from the previous building block definition
100100
4. `GITHUB_APP_INSTALLATION_ID` - This is the value saved under “Preparation” step 2b from the previous building block definition
101-
5. `GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a from the previous building block definition
102-
6. Create a new input called [`config.tf`](http://config.tf) and set the Source to “Static” and the Type to “File”. Mark the input as encrypted and upload the config.tf file from the preparation step.
101+
5. `GITHUB_APP_PEM_FILE` - This is the value saved under “Preparation” step 3a from the previous building block definition. Take the entire content of the file and paste it in here.
102+
6. Create a new input called `config.tf` and set the Source to “Static” and the Type to “File”. Mark the input as encrypted and upload the config.tf file from the preparation step.
103103
4. Finish the flow and create the building block definition.
104104

105105
🎉 The GitHub Actions Connector Building Block Definition is ready!
@@ -114,12 +114,12 @@ We will create resources within meshStack. This means we need an API Key to inte
114114

115115
- Create a new API Key in meshStack in the Admin Area. Make sure you save the **API key ID** & **API key secret** somewhere, as you’ll need it later.
116116
- Give it the following permissions:
117-
- “Admin: Create and Update Building Blocks in any Workspace”
118-
- “Admin: List Building Blocks in any Workspace”
119-
- “Admin: Create and Update Projects in any Workspace”
120-
- “Admin: List Projects in any Workspace”
121-
- “Admin: Create and update Tenants in any Workspace as well as import existing platform tenants”
122-
- “Admin: List Tenants in any Workspace”
117+
- “Admin: Create and Update Building Blocks in any Workspace”
118+
- “Admin: List Building Blocks in any Workspace”
119+
- “Admin: Create and Update Projects in any Workspace”
120+
- “Admin: List Projects in any Workspace”
121+
- “Admin: Create and update Tenants in any Workspace as well as import existing platform tenants”
122+
- “Admin: List Tenants in any Workspace”
123123

124124
### Creating the Building Block Definition
125125

@@ -290,10 +290,10 @@ You can also change the behavior if you want in this starter kit. In its current
290290
```
291291
292292
- Create a new building block definition in meshStack. Make sure you set the following:
293-
- Type = Workspace Building Block
294-
- Implementation Type = Terraform
295-
- For the inputs you will have to enter an API key ID & API key secret for the meshStack API user you created before.
293+
- Type = Workspace Building Block
294+
- Implementation Type = Terraform
295+
- For the inputs you will have to enter an API key ID & API key secret for the meshStack API user you created before.
296296
297-
## What’s next?
297+
## What’s Next?
298298
299299
- [Publish all building blocks](./marketplace.service-management-area.md#publishing) so anyone in the organization can use it and provision namespaces in self-service.

0 commit comments

Comments
 (0)