Skip to content

Commit b9fb0ba

Browse files
Replace mdspell, bump deps (#591)
* fix(): replace mdspell with cspell * fix(): linter failings * fix(): typo * fix(): lf at eof
1 parent 05b2091 commit b9fb0ba

File tree

25 files changed

+1498
-1255
lines changed

25 files changed

+1498
-1255
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ yarn-debug.log*
2424
yarn-error.log*
2525
.vscode/*
2626
.vs/*
27-
.env
27+
.env

Dockerfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,4 @@ FROM gcr.io/distroless/nodejs:20
1515
COPY --from=build-env /app /app
1616
WORKDIR /app
1717
EXPOSE 3000
18-
CMD ["node_modules/@docusaurus/core/bin/docusaurus.js", "start", "--host", "0.0.0.0", "--no-open"]
18+
CMD ["node_modules/@docusaurus/core/bin/docusaurus.js", "start", "--host", "0.0.0.0", "--no-open"]

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This repository contains the documentation for the Ensono Stacks platform.
44
The live site is hosted at [https://stacks.ensono.com](https://stacks.ensono.com).
55

66
This microsite is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern static website generator.
7-
You can view their documentation [here](https://v2.docusaurus.io/docs/).
7+
You can [view their documentation](https://v2.docusaurus.io/docs/).
88

99
## Making changes
1010

cspell.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
{
2+
"version": "0.2",
3+
"words": [
4+
"Ensono",
5+
"unwelcomed",
6+
"amidostacks",
7+
"humaning",
8+
"fuzzies"
9+
]
10+
}

docs/getting_started/azure-container-app/ACA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ Con's
167167
We recommend implementing Option 2: Container App Environment deployment via Infrastructure pipeline and Container App deployment via Application pipeline. This approach provides the flexibility to manage infrastructure and application deployments separately while optimizing the deployment process for Azure Container Apps.
168168
This recommendation will result in a more streamlined deployment process, eliminating unnecessary Container App revisions and allowing for tighter integration between application builds and deployments.
169169

170-
However, it's important to note that this approach will require additional effort in managing separate Terraform configurations for each Container App. To mitigate this challenge, we will utilize the existing Azure Container Apps Terraform module developed by Ensono, which is available [here](https://registry.terraform.io/modules/Ensono/aca/azurerm/latest).
170+
However, it's important to note that this approach will require additional effort in managing separate Terraform configurations for each Container App. To mitigate this challenge, we will utilize the existing Azure Container Apps [Terraform module developed by Ensono](https://registry.terraform.io/modules/Ensono/aca/azurerm/latest).
171171

172172
This pre-built module will help reduce duplication and ease maintenance across multiple Container Apps, standardizing our Container App deployments and reducing the overhead of managing individual Terraform configurations.
173173
By leveraging this existing module in our recommended approach, we can achieve a more efficient and manageable deployment strategy for our Azure Container Apps while maintaining the flexibility to evolve both infrastructure and applications independently.

docs/getting_started/logger/winston.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,6 +129,6 @@ For more information on log level severity please refer to the [log levels](http
129129

130130
### Other resources
131131

132-
Documentation for Winston can be found [here](https://github.com/winstonjs/winston).
132+
[Documentation for Winston](https://github.com/winstonjs/winston).
133133

134134
</details>

docs/getting_started/setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ yarn global add nx
4040

4141
#### Node
4242

43-
We recommend using the latest LTS version of Node, you can find the latest LTS version [here](https://nodejs.org/en/).
43+
We recommend using the latest [LTS version of Node](https://nodejs.org/en/).
4444

4545
### Get Started
4646

docs/infrastructure/aws/pipelines/github_actions.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1515

1616
The pipeline will automate provisioning and updating the core infrastructure in AWS. This page assumes you have already completed the steps on the [core infrastructure page](../core_infrastructure.md).
1717

18-
The AWS infrastructure source code can be found [here](https://github.com/Ensono/stacks-infrastructure-eks).
18+
The AWS infrastructure [source code](https://github.com/Ensono/stacks-infrastructure-eks).
1919

2020
## Pipeline Diagram
2121

@@ -31,7 +31,7 @@ The AWS infrastructure source code can be found [here](https://github.com/Ensono
3131

3232
### Environment Secrets
3333

34-
Environment secrets will need creating for storing some sensitive variables to be used by the pipeline. Instructions for creating a environment secrets can be found [here](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#environment-secrets).
34+
Environment secrets will need creating for storing some sensitive variables to be used by the pipeline. Instructions for creating a [environment secrets](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#environment-secrets).
3535

3636
Add the following secrets:
3737

@@ -52,6 +52,6 @@ Where possible, the Stacks CLI will have populated the correct values in the pip
5252

5353
### Create the pipeline
5454

55-
Stacks generates the GitHub Actions workflow file in the directory expected by GitHub Actions, `.github/workflows`. Committing this file to the `main` branch of a GitHub repository will "create" the pipeline. Instructions for viewing the results can be found [here](https://docs.github.com/en/actions/writing-workflows/quickstart#viewing-your-workflow-results)
55+
Stacks generates the GitHub Actions workflow file in the directory expected by GitHub Actions, `.github/workflows`. Committing this file to the `main` branch of a GitHub repository will "create" the pipeline. Instructions for viewing [the results](https://docs.github.com/en/actions/writing-workflows/quickstart#viewing-your-workflow-results)
5656

5757
<HideNavigation next />

docs/infrastructure/azure/pipelines/azure_devops.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
1515

1616
The pipeline will automate provisioning and updating the core infrastructure in Azure. This page assumes you have already completed the steps on the [core infrastructure page](../core_infrastructure.md).
1717

18-
The Azure infrastructure source code can be found [here](https://github.com/Ensono/stacks-infrastructure-aks).
18+
The Azure [infrastructure source code](https://github.com/Ensono/stacks-infrastructure-aks).
1919

2020
## Pipeline Diagram
2121

@@ -31,7 +31,7 @@ The Azure infrastructure source code can be found [here](https://github.com/Enso
3131

3232
### Variable groups
3333

34-
Variable groups will need creating for storing Azure Credentials to be used with the pipeline. Instructions for creating a variable group can be found [here](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=classic#create-a-variable-group).
34+
Variable groups will need creating for storing Azure Credentials to be used with the pipeline. Instructions for creating a [variable group](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/variable-groups?view=azure-devops&tabs=classic#create-a-variable-group).
3535

3636
Create a variable group called `azure-sp-creds`, add a description and make sure the **Allow access to all pipelines** option is checked. Add the following variables using the Service Connection details from [bootstrapping the Azure tenant](../core_infrastructure.md#bootstrap-the-azure-tenant):
3737

docs/infrastructure/introduction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ All Ensono Stacks workloads require initial configuration of the cloud provider
2020

2121
All infrastructure tooling is done with [Terraform](https://www.terraform.io/), as a method for implementing infrastructure as code. Terraform uses workspaces as the main mechanism of segregating states.
2222

23-
All the modules used by Ensono Stacks are documented and maintained [here](https://github.com/Ensono/stacks-terraform)
23+
All the modules used by Ensono Stacks are [documented and maintained](https://github.com/Ensono/stacks-terraform)
2424

2525
<HideNavigation next />
2626
<HideNavigation prev />

0 commit comments

Comments
 (0)