-
Notifications
You must be signed in to change notification settings - Fork 10
Azure Developer Platform Guide #1112
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
base: develop
Are you sure you want to change the base?
Conversation
This pull request is automatically being deployed by Amplify Hosting (learn more). |
|
||
## Introduction | ||
|
||
Welcome to the **Azure Developer Platform Guide**! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is all true and I would add why someone would build this in the first place from company perspective. "Develop Applications Faster" or "Developer Enablement" those would be examples for value driven or to address issues like "Long ramp up times", "Drowning in Tickets" more pain driven examples
- You have integrated Azure as a platform in meshStack. | ||
- *If you don’t, we recommend running through the [Platform Setup guide](./meshstack.how-to.integrate-meshplatform.md) where you are guided to create an Azure platform in meshStack* | ||
|
||
## What Will We Do in This Guide? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
## What Will We Do in This Guide? | |
## Step by Step Guide | |
`` |
|
||
Shortly put, we will set up the following in this guide: | ||
|
||
- A building block definition that allows application teams to provision new GitHub repositories. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You could use this part to provide structure to the things below by having corresponding numbering
|
||
1. [**Register a GitHub App**](https://docs.github.com/en/apps/creating-github-apps/registering-a-github-app/registering-a-github-app) | ||
1. Make sure you give it sufficient permissions. When creating the app you’ll see a section “Repository permissions”. Under here make sure that you set the following: | ||
1. “Administration” is set to “read & write”. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Numbering is strange here. How about ether use 1. and 1.1, 1.2, 2. etc or dashes for the second hierarchy level
|
||
We will create resources within meshStack. This means we need an API Key to interact with meshStack in our Terraform code. | ||
|
||
- 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here there is no numbering but dashed. I think consistency would help here for orientation
- “Admin: Create and update Tenants in any Workspace as well as import existing platform tenants” | ||
- “Admin: List Tenants in any Workspace” | ||
|
||
### Creating the Building Block Definition |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as there are quite a lot definitions here I think giving this one a name as well will help setting the puzzle pieces together
} | ||
``` | ||
|
||
- Create a new building block definition in meshStack. Make sure you set the following: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Somehow this also is shown to me as a "code snippet"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some comment here and there to improve readability
@Jelledb i see no change to sidebars.json so I'm pretty sure this docs page won't turn up in the menu |
@Jelledb this seems to be similar to https://github.com/likvid-bank/likvid-cloudfoundation/blob/main/kit/foundation/meshstack/guides/guide_starterkits.md which would then need to be cleaned up to reference this guide |
This PR has seen no activity in the last 7 days and has been marked as stale. |
No description provided.