Skip to content

Commit

Permalink
fix(docs): Fixing more broken docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
stack72 committed Dec 18, 2024
1 parent 48ea059 commit 0d35861
Show file tree
Hide file tree
Showing 6 changed files with 60 additions and 58 deletions.
12 changes: 6 additions & 6 deletions app/docs/src/how-tos/aws-macos.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Create a Change Set named `MacOS How-to`.

Add a `AWS Credential` to your Change Set and configure your AWS credentials as
per the
[getting started guide](../tutorials/getting-started#add-an-aws-credential-Component)
[getting started guide](../tutorials/getting-started#add-an-aws-credential-component)

### Select an AWS Region

Expand Down Expand Up @@ -75,7 +75,7 @@ Resize the frame to allow space for a child Component to be inside it.

### Select an EC2 Instance Component

![Select an EC2 Instance](./aws-macos/create-ec2-instance-Component.png)
![Select an EC2 Instance](./aws-macos/create-ec2-instance-component.png)

Add an `EC2 Instance` Component to the `macOS dedicated host` frame.

Expand All @@ -85,7 +85,7 @@ Set the `InstanceType` to be `mac2-m2pro.metal`

### Create an AMI Component

![Select an AMI](./aws-macos/create-ami-Component.png)
![Select an AMI](./aws-macos/create-ami-component.png)

Add an `AMI` Component to the `us-east-1` frame.

Expand All @@ -98,7 +98,7 @@ Connect the `Image ID` Output Socket to the `Image ID` Input Socket of the

### Create a Security Group Component

![Select a Security Group](./aws-macos/create-security-group-Component.png)
![Select a Security Group](./aws-macos/create-security-group-component.png)

Add a `Security Group` Component to the `us-east-1` frame.

Expand All @@ -114,7 +114,7 @@ socket of the `macos-1` Component.

### Create a Security Group Ingress Rule Component

![Select a Security Group Rule Ingress](./aws-macos/create-security-group-ingress-Component.png)
![Select a Security Group Rule Ingress](./aws-macos/create-security-group-ingress-component.png)

Add a `Security Group Rule (Ingress)` Component to the `us-east-1` frame.

Expand All @@ -134,7 +134,7 @@ Connect the `Security Group ID` Output Socket of `macos-sg` Component to the

### Create a KeyPair Component

![Select a Key Pair](./aws-macos/create-key-pair-Component.png)
![Select a Key Pair](./aws-macos/create-key-pair-component.png)

Add a `Key Pair` Component to the `us-east-1` frame.

Expand Down
4 changes: 2 additions & 2 deletions app/docs/src/tutorials/actions-and-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ Click `Store Secret` to securely encrypt and save your Secret.

## Add an AWS Region Component and set its properties

![Add an AWS Region Component and set its properties](./actions-and-resources/add-an-aws-region-Component-and-set-its-properties.png)
![Add an AWS Region Component and set its properties](./actions-and-resources/add-an-aws-region-component-and-set-its-properties.png)

Click `Region` from the AWS category of the Asset pallete, and drop it on the
Diagram canvas.
Expand All @@ -63,7 +63,7 @@ Set the `region` property to `us-east-1`.

## Add a VPC Component and set its properties

![Add a VPC Component and set its properties](./actions-and-resources/add-a-vpc-Component-and-set-its-properties.png)
![Add a VPC Component and set its properties](./actions-and-resources/add-a-vpc-component-and-set-its-properties.png)

Click `VPC` from the AWS EC2 category of the Asset pallete, and drop it on the
Diagram canvas.
Expand Down
32 changes: 17 additions & 15 deletions app/docs/src/tutorials/creating-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ To follow along, you should:

2. You should have your System Initiative workspace open in another window.

This tutorial shows you how to create Components and add functions to them.
It's focus is on introducing you to the user interface and various high level
concepts. For deeper details on writing specific function types, [see the
reference guides](../reference/index.md).
This tutorial shows you how to create Components and add functions to them. It's
focus is on introducing you to the user interface and various high level
concepts. For deeper details on writing specific function types,
[see the reference guides](../reference/index.md).

:::tip

Expand All @@ -38,7 +38,7 @@ Click the `Beaker` icon to switch to the customize screen.

## Create a new Hello World Component

![Create a new Hello World Component](./creating-Components/create-a-new-hello-world-Component.png)
![Create a new Hello World Component](./creating-components/create-a-new-hello-world-component.png)

Click the `New Asset` button (represented by a `+` icon) in the Assets pallete
in the left side panel.
Expand All @@ -59,7 +59,7 @@ synonymous with Components.

## Set the Hello World meta-data

![Set the Hello World meta-data](./creating-Components/set-the-hello-world-meta-data.png)
![Set the Hello World meta-data](./creating-components/set-the-hello-world-meta-data.png)

Set the `Category` to `Tutorial`.

Expand All @@ -71,7 +71,7 @@ Set the `color` to `#6cdcf8`.

## Add properties to the Hello World Schema

![Add properties](./creating-Components/add-properties.png)
![Add properties](./creating-components/add-properties.png)

In the center of the screen is a text editor showing the empty Schema of your
`Hello World` Component.
Expand Down Expand Up @@ -188,7 +188,7 @@ asset definition with `return asset.build()`.

## Regenerate the asset

![Regenerate Asset](./creating-Components/regenerate-asset.png)
![Regenerate Asset](./creating-components/regenerate-asset.png)

Click the `Regenerate Asset` button in the right-side panel.

Expand All @@ -197,7 +197,7 @@ with the new Schema.

## Check your new Component

![Check your Component](./creating-Components/check-your-Component.png)
![Check your Component](./creating-components/check-your-component.png)

Click the `Graph` icon to switch to the modeling screen.

Expand All @@ -213,7 +213,7 @@ You will see that you have the following properties:

## Add a Qualification function

![Add Qualification function](./creating-Components/add-qualification-function.png)
![Add Qualification function](./creating-components/add-qualification-function.png)

Click the `Beaker` icon to switch back to the customize screen. Ensure you
`Hello World` Asset is selected.
Expand All @@ -228,13 +228,13 @@ Name your Qualification `helloWorldTags`.

## Set the qualifications meta-data

![Qualification Metadata](./creating-Components/qualification-metadata.png)
![Qualification Metadata](./creating-components/qualification-metadata.png)

Set the `Display Name` to `Hello World Tags`

## Write the qualification function

![Write Qualification](./creating-Components/write-qualification.png)
![Write Qualification](./creating-components/write-qualification.png)

Ensure that any `Hello World` Components have a tag with the key `Super` and
value is `Duper`.
Expand Down Expand Up @@ -280,7 +280,7 @@ Finally, return the `result` and `message`.

## Check your new Qualification function

![Check Qualification](./creating-Components/check-qualification.png)
![Check Qualification](./creating-components/check-qualification.png)

Click the `Graph` icon to switch to the modeling screen.

Expand Down Expand Up @@ -315,5 +315,7 @@ To learn more, explore the reference documentation:
on how to write functions

## Vocabulary
In this tutorial bits of System Initiative Vocabulary will be shown with a capital letter.
All definitions for these can be found here: [System Initative - Vocabulary](https://docs.systeminit.com/reference/vocabulary)

In this tutorial bits of System Initiative Vocabulary will be shown with a
capital letter. All definitions for these can be found here:
[System Initative - Vocabulary](https://docs.systeminit.com/reference/vocabulary)
24 changes: 12 additions & 12 deletions app/docs/src/tutorials/editing-components-and-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ specific function types, [see the reference guides](../reference/index.md).

## Create a Change Set

![Create a Change Set](./editing-Components-and-contributing/create-change-set.png)
![Create a Change Set](./editing-components-and-contributing/create-change-set.png)

Click the create Change Set button.

Expand All @@ -30,21 +30,21 @@ Click the `Create Change Set` button.

## Create a Generic Frame

![Create a Generic Frame](./editing-Components-and-contributing/create-a-generic-frame.png)
![Create a Generic Frame](./editing-components-and-contributing/create-a-generic-frame.png)

Click the `Generic Frame` from the Asset panel, then place it on the Diagram canvas.

Name it `Editing Frame`.

## Switch to the Customize Screen

![Switch to the Customize Screen](./editing-Components-and-contributing/switch-to-customize-screen.png)
![Switch to the Customize Screen](./editing-components-and-contributing/switch-to-customize-screen.png)

Click the `Beaker` icon to switch to the customize screen.

## Edit the Generic Frame Schema

![Edit the Generic Frame Schema](./editing-Components-and-contributing/edit-the-generic-frame-schema.png)
![Edit the Generic Frame Schema](./editing-components-and-contributing/edit-the-generic-frame-schema.png)

Select the `Generic Frame` Asset from the Assets panel in the left of the customize screen.

Expand All @@ -54,7 +54,7 @@ This will create a new `Editing` version of the Generic Frame.

## Add a new property to the Generic Frame

![Edit the Generic Frame Schema](./editing-Components-and-contributing/add-a-new-property-to-the-generic-frame.png)
![Edit the Generic Frame Schema](./editing-components-and-contributing/add-a-new-property-to-the-generic-frame.png)

Add a new `Awesome` boolean property to the `Generic Frame`.

Expand All @@ -78,7 +78,7 @@ Click `Regenerate Asset` when you are done.

## Upgrade to your new Generic Frame

![Upgrade to your new Generic Frame](./editing-Components-and-contributing/upgrade-to-your-new-generic-frame.png)
![Upgrade to your new Generic Frame](./editing-components-and-contributing/upgrade-to-your-new-generic-frame.png)

Click the `Graph` icon to switch to the modeling screen.

Expand All @@ -91,13 +91,13 @@ this Component can be upgraded to.

Click the `Upgrade` icon in the attribute panel to upgrade your `Editing Frame`.

![Now with more awesome](./editing-Components-and-contributing/now-with-more-awesome.png)
![Now with more awesome](./editing-components-and-contributing/now-with-more-awesome.png)

It will now have a property named `Awesome` with a true/false check-box!

## Edit a function

![Edit a function](./editing-Components-and-contributing/edit-a-function.png)
![Edit a function](./editing-components-and-contributing/edit-a-function.png)

Click the `Beaker` icon to switch to the customize screen.

Expand All @@ -114,15 +114,15 @@ version of the Asset.

## Abandon your Change Set

![Edit a function](./editing-Components-and-contributing/abandon-change-set.png)
![Edit a function](./editing-components-and-contributing/abandon-change-set.png)

Since both of these are useful working assets, abandon your Change Set to
ensure your edits are not persisted by clicking the `Abandon Change Set` button
(the trash can icon next to the Change Set selector.)

## Updating Assets from System Initiative

![Updating Assets from System Initiative](./editing-Components-and-contributing/updating-assets-from-system-initiative.png)
![Updating Assets from System Initiative](./editing-components-and-contributing/updating-assets-from-system-initiative.png)

You can update assets as new versions are published from System Initiative from
the customize screen. If an Asset can be updated, you will see an `Update All`
Expand All @@ -132,7 +132,7 @@ they have an update available.

## Install New Assets from System Initiative

![Install New Assets from System Initiative](./editing-Components-and-contributing/install-new-assets-from-system-initiative.png)
![Install New Assets from System Initiative](./editing-components-and-contributing/install-new-assets-from-system-initiative.png)

New assets published by System Initiative can be installed by clicking the
`New Assets` sub-panel of the Assets tab on the customize screen.
Expand All @@ -143,7 +143,7 @@ Install the Asset by clicking the `Install Module` button.

## Contributing Assets to System Initiative

![Contributing Assets to System Initiative](./editing-Components-and-contributing/contributing-assets-to-system-initiative.png)
![Contributing Assets to System Initiative](./editing-components-and-contributing/contributing-assets-to-system-initiative.png)

If you have created or edited an Asset that you want to contribute to the community,
you can do so once you've applied it to your workspace.
Expand Down
8 changes: 4 additions & 4 deletions app/docs/src/tutorials/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ button.

## Add an AWS Credential Component

![Adding an AWS Credential Component](./getting-started/add-an-aws-credential-Component.png)
![Adding an AWS Credential Component](./getting-started/add-an-aws-credential-component.png)

Click `AWS Credential` from the AWS category of the Asset pallete, and drop it
on the Diagram canvas. This creates a new
Expand All @@ -43,7 +43,7 @@ lower right corner of the frame.

## Name your Component

![Name your Component](./getting-started/name-your-Component.png)
![Name your Component](./getting-started/name-your-component.png)

Click on the `AWS Credential` you just added to the canvas. The panel on the
right side of your screen will show its properties. It will have a default
Expand Down Expand Up @@ -76,7 +76,7 @@ In some cases, you may need to also add your AWS Session Key.

## Add an AWS Region Component and set its properties

![Add an AWS Region Component](./getting-started/add-an-aws-region-Component-and-set-its-properties.png)
![Add an AWS Region Component](./getting-started/add-an-aws-region-component-and-set-its-properties.png)

Click on the `Region` from the AWS category of the Asset pallete, and drop it
inside your `Tutorial` Credential frame.
Expand Down Expand Up @@ -119,7 +119,7 @@ the line between them.

## Add an AWS EC2 AMI Component and set its properties

![Add an AWS EC2 AMI Component and set its properties](./getting-started/add-an-aws-ec2-ami-Component-and-set-its-properties.png)
![Add an AWS EC2 AMI Component and set its properties](./getting-started/add-an-aws-ec2-ami-component-and-set-its-properties.png)

Click on the `AMI` from the AWS EC2 category of the Asset pallete, and drop it
inside your `Northern Virginia` region frame.
Expand Down
Loading

0 comments on commit 0d35861

Please sign in to comment.