Skip to content

Commit ae3521b

Browse files
committed
fixed doc links
1 parent 21a7e06 commit ae3521b

File tree

10 files changed

+21
-18
lines changed

10 files changed

+21
-18
lines changed

.github/workflows/prod-web-deploy.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ jobs:
1818

1919
- uses: actions/setup-node@v4
2020
with:
21-
node-version: 18
21+
node-version: 20
2222
cache: yarn
2323
cache-dependency-path: website/yarn.lock
2424

website/docs/getting-started.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ resources:
8686
8787
</File>
8888
89-
The `stackql_manifest.yml` file is detailed [__here__](/docs/manifest-file).
89+
The `stackql_manifest.yml` file is detailed [__here__](/manifest-file).
9090

9191
### Resource Query Files
9292

@@ -138,7 +138,7 @@ WHERE resourceGroupName = '{{ resource_group_name }}' AND subscriptionId = '{{ s
138138

139139
</File>
140140

141-
Resource queries are detailed [__here__](/docs/resource-query-files).
141+
Resource queries are detailed [__here__](/resource-query-files).
142142

143143
### `stackql-deploy` commands
144144

@@ -165,7 +165,7 @@ stackql-deploy teardown my-azure-stack dev \
165165
-e AZURE_SUBSCRIPTION_ID=00000000-0000-0000-0000-000000000000
166166
```
167167

168-
For more detailed information see [`cli-reference/build`](/docs/cli-reference/build), [`cli-reference/test`](/docs/cli-reference/test), [`cli-reference/teardown`](/docs/cli-reference/teardown), or other commands available.
168+
For more detailed information see [`cli-reference/build`](/cli-reference/build), [`cli-reference/test`](/cli-reference/test), [`cli-reference/teardown`](/cli-reference/teardown), or other commands available.
169169

170170

171171
### `stackql-deploy` deployment flow
@@ -178,8 +178,8 @@ For more detailed information see [`cli-reference/build`](/docs/cli-reference/bu
178178

179179
To get up and running quickly, `stackql-deploy` provides a set of quick start templates for common cloud providers. These templates include predefined configurations and resource queries tailored to AWS, Azure, and Google Cloud, among others.
180180

181-
- [**AWS Quick Start Template**](/docs/template-library/aws/vpc-and-ec2-instance): A basic setup for deploying a VPC, including subnets and routing configurations.
182-
- [**Azure Quick Start Template**](/docs/template-library/azure/simple-vnet-and-vm): A setup for creating a Resource Group with associated resources.
183-
- [**Google Cloud Quick Start Template**](/docs/template-library/google/k8s-the-hard-way): A configuration for deploying a VPC with network and firewall rules.
181+
- [**AWS Quick Start Template**](/template-library/aws/vpc-and-ec2-instance): A basic setup for deploying a VPC, including subnets and routing configurations.
182+
- [**Azure Quick Start Template**](/template-library/azure/simple-vnet-and-vm): A setup for creating a Resource Group with associated resources.
183+
- [**Google Cloud Quick Start Template**](/template-library/google/k8s-the-hard-way): A configuration for deploying a VPC with network and firewall rules.
184184

185185
These templates are designed to help you kickstart your infrastructure deployment with minimal effort, providing a solid foundation that you can customize to meet your specific needs.

website/docs/manifest-file.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -167,7 +167,7 @@ the fields within the __`stackql_manifest.yml`__ file are described in further d
167167

168168
## Example manifest file
169169

170-
Here is a complete example of a `stackql_manifest.yml` file for a Google stack, for other examples see the [Template Library](/docs/template-library).
170+
Here is a complete example of a `stackql_manifest.yml` file for a Google stack, for other examples see the [Template Library](/template-library).
171171

172172
<File name='stackql_manifest.yml'>
173173

website/docs/manifest_fields/name.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import LeftAlignedTable from '@site/src/components/LeftAlignedTable';
33

44
<LeftAlignedTable type="string" required={true} />
55

6-
The name of the stack, by default this is derived by the [__`init`__](/docs/cli-reference/init) command from the stack directory name (replacing `_` with `-` for resource and property name compliance). This name can be overridden, the value for `name` is exposed as a global variable called `stack_name` which is often used with resource or property values so ensure that this string conforms to any naming restrictions.
6+
The name of the stack, by default this is derived by the [__`init`__](/cli-reference/init) command from the stack directory name (replacing `_` with `-` for resource and property name compliance). This name can be overridden, the value for `name` is exposed as a global variable called `stack_name` which is often used with resource or property values so ensure that this string conforms to any naming restrictions.
77

88
<File name='stackql_manifest.yml'>
99

website/docs/resource-query-files.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ AND JSON_EXTRACT(routingConfig, '$.routingMode') = 'REGIONAL'
157157

158158
:::tip
159159

160-
Useful functions for testing the desired state of a resource include [`JSON_EQUAL`](https://stackql.io/docs/language-spec/functions/json/json_equal), [`JSON_EXTRACT`](https://stackql.io/docs/language-spec/functions/json/json_extract) and [`JSON_EACH`](https://stackql.io/docs/language-spec/functions/json/json_equal).
160+
Useful functions for testing the desired state of a resource include [`JSON_EQUAL`](https://stackql.io/docs/language-spec/functions/json/json_equal), [`AWS_POLICY_EQUAL`](https://stackql.io/docs/language-spec/functions/json/aws_policy_equal), [`JSON_EXTRACT`](https://stackql.io/docs/language-spec/functions/json/json_extract) and [`JSON_EACH`](https://stackql.io/docs/language-spec/functions/json/json_equal).
161161

162162
:::
163163

website/docs/template-library/aws/vpc-and-ec2-instance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ The EC2 instance is bootstrapped with a web server that serves a simple page usi
2121

2222
## Deploying the Stack
2323

24-
> install `stackql-deploy` using `pip install stackql-deploy` (see [__Installing stackql-deploy__](/docs/getting-started#installing-stackql-deploy)), set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables, that's it!
24+
> install `stackql-deploy` using `pip install stackql-deploy` (see [__Installing stackql-deploy__](/getting-started#installing-stackql-deploy)), set the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY` environment variables, that's it!
2525
2626
Once you have setup your project directory (your "stack"), you can use the `stackql-deploy` cli application to deploy, test or teardown the stack in any given environment. To deploy the stack to an environment labeled `sit`, run the following:
2727

website/docs/template-library/azure/simple-vnet-and-vm.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ The Virtual Machine is bootstrapped with a web server that serves a simple page
2222

2323
## Deploying the Stack
2424

25-
> Install `stackql-deploy` using `pip install stackql` (see [__Installing stackql-deploy__](/docs/getting-started#installing-stackql-deploy)), set the `AZURE_SUBSCRIPTION_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, and `AZURE_TENANT_ID` environment variables, and you're ready to go!
25+
> Install `stackql-deploy` using `pip install stackql` (see [__Installing stackql-deploy__](/getting-started#installing-stackql-deploy)), set the `AZURE_SUBSCRIPTION_ID`, `AZURE_CLIENT_ID`, `AZURE_CLIENT_SECRET`, and `AZURE_TENANT_ID` environment variables, and you're ready to go!
2626
2727
Once you have set up your project directory (your "stack"), you can use the `stackql-deploy` CLI application to deploy, test, or teardown the stack in any given environment. To deploy the stack to an environment labeled `sit`, run the following:
2828

website/docs/template-library/google/k8s-the-hard-way.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ To install `stackql-deploy`, use the following command:
3030
```bash
3131
pip install stackql-deploy
3232
```
33-
for more information on installing `stackql-deploy` see [__Installing stackql-deploy__](/docs/getting-started#installing-stackql-deploy).
33+
for more information on installing `stackql-deploy` see [__Installing stackql-deploy__](/getting-started#installing-stackql-deploy).
3434

3535
## Deploying Using `stackql-deploy`
3636

website/src/css/custom.css

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -73,12 +73,15 @@
7373
/*
7474
* github
7575
*/
76-
.header-github-link:before {
76+
.header-github-link:before {
7777
content: '';
7878
width: 140px;
7979
height: 28px;
80-
display: flex;
81-
background: url("https://img.shields.io/github/stars/stackql/stackql?logo=github&style=social") no-repeat center/contain;
80+
display: flex;
81+
background-image: url("https://img.shields.io/github/stars/stackql/stackql?logo=github&style=social");
82+
background-repeat: no-repeat;
83+
background-position: center;
84+
background-size: contain;
8285
}
8386

8487
.header-github-link:hover {

website/src/theme/DocCard/index.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ import type {
1919
import styles from './styles.module.css';
2020

2121
const descriptionMap = {
22-
'/docs/template-library/aws/simple-vpc': 'Simple VPC configuration in AWS',
23-
'/docs/template-library/azure/simple-vnet': 'Basic Virtual Network setup in Azure',
22+
'/template-library/aws/simple-vpc': 'Simple VPC configuration in AWS',
23+
'/template-library/azure/simple-vnet': 'Basic Virtual Network setup in Azure',
2424
};
2525

2626

0 commit comments

Comments
 (0)