Skip to content

Commit

Permalink
[#20] Replace the Alert syntax as it has not been supported for Wiki …
Browse files Browse the repository at this point in the history
  • Loading branch information
longnd committed Aug 30, 2023
1 parent 32de8b6 commit 9bef64b
Show file tree
Hide file tree
Showing 5 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/wiki/Add-new-addon-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion .github/wiki/Architecture-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions .github/wiki/Getting-Started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
> **Note**!\
> This template can be used for reference to add an addon/module to an existing Terraform project
2 changes: 1 addition & 1 deletion .github/wiki/Using-the-template-as-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
1 change: 1 addition & 0 deletions .github/workflows/publish-wiki.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ on:
- .github/wiki/**
branches:
- develop
- feature/20-create-project-wiki
workflow_dispatch:

jobs:
Expand Down

0 comments on commit 9bef64b

Please sign in to comment.