From 9bef64b7fb83b3e955cf845e2f913168a5930835 Mon Sep 17 00:00:00 2001 From: Long Nguyen Date: Wed, 30 Aug 2023 13:28:04 +0700 Subject: [PATCH] [#20] Replace the Alert syntax as it has not been supported for Wiki content yet https://github.com/orgs/community/discussions/16925#discussioncomment-6700896 --- .github/wiki/Add-new-addon-module.md | 2 +- .github/wiki/Architecture-overview.md | 2 +- .github/wiki/Getting-Started.md | 6 +++--- .github/wiki/Using-the-template-as-reference.md | 2 +- .github/workflows/publish-wiki.yml | 1 + 5 files changed, 7 insertions(+), 6 deletions(-) diff --git a/.github/wiki/Add-new-addon-module.md b/.github/wiki/Add-new-addon-module.md index e994bd98..f647e027 100644 --- a/.github/wiki/Add-new-addon-module.md +++ b/.github/wiki/Add-new-addon-module.md @@ -10,5 +10,5 @@ To add a new addon or module, follow these steps: 3. Navigate to the `skeleton` folder at the same level as the `src` folder in the project directory. 4. Add the skeleton folders/files for the addon/module that you are adding inside the corresponding folder in the `skeleton` directory. -> [!NOTE]\ +> **Note**!\ > Before adding a new addon/module, it is recommended to check the existing ones for reference. \ No newline at end of file diff --git a/.github/wiki/Architecture-overview.md b/.github/wiki/Architecture-overview.md index c8277d56..04be6935 100644 --- a/.github/wiki/Architecture-overview.md +++ b/.github/wiki/Architecture-overview.md @@ -39,7 +39,7 @@ The project has the following main files and folders: └── index.ts ``` -> [!NOTE]\ +> **Note**!\ > The `skeleton` folder and the `templates` folder are the two main folders that are used to generate the project files - The `skeleton` folder contains the addon's files and folders ready to be directly copy-pasted into the generated project if the related addon has been selected. These files serve as a starting point or "skeleton" for the specific addon. diff --git a/.github/wiki/Getting-Started.md b/.github/wiki/Getting-Started.md index dd612c56..33c0f121 100644 --- a/.github/wiki/Getting-Started.md +++ b/.github/wiki/Getting-Started.md @@ -24,11 +24,11 @@ nimble-infra generate {project-name} nimble-infra install {addon-name} --project {project-name} ``` -> [!NOTE]\ +> **Note**!\ > Terraform Cloud is supported by default. You need to set the `organization` and `workspace` in the `terraform` block of the `main.tf` file to use it. > If you don't want to use Terraform Cloud, you can remove the `cloud` block in the `main.tf` file. ### Reference as a template -> [!NOTE]\ -> This template can be used for reference to add an addon/module to an existing Terraform project \ No newline at end of file +> **Note**!\ +> This template can be used for reference to add an addon/module to an existing Terraform project diff --git a/.github/wiki/Using-the-template-as-reference.md b/.github/wiki/Using-the-template-as-reference.md index 0a8e9302..d0745761 100644 --- a/.github/wiki/Using-the-template-as-reference.md +++ b/.github/wiki/Using-the-template-as-reference.md @@ -9,7 +9,7 @@ Inside each addon or module folder, you will find the necessary files and direct 4. Copy and paste the relevant files from the existing addon or module into your new addon/module folder. -> [!NOTE]\ +> **Note**!\ > Make sure to update any necessary configuration or code inside the copied files to fit your specific requirements. By following this process, you can use the existing templates as a reference to create your own addons or modules based on the provided structure and functionality. \ No newline at end of file diff --git a/.github/workflows/publish-wiki.yml b/.github/workflows/publish-wiki.yml index bb2a59c2..85cafb49 100644 --- a/.github/workflows/publish-wiki.yml +++ b/.github/workflows/publish-wiki.yml @@ -6,6 +6,7 @@ on: - .github/wiki/** branches: - develop + - feature/20-create-project-wiki workflow_dispatch: jobs: