From 0d35861e32f14ea2ad0abfa622acb0dcb9c6c9dd Mon Sep 17 00:00:00 2001 From: stack72 Date: Wed, 18 Dec 2024 23:16:49 +0000 Subject: [PATCH] fix(docs): Fixing more broken docs links --- app/docs/src/how-tos/aws-macos.md | 12 +++--- .../src/tutorials/actions-and-resources.md | 4 +- app/docs/src/tutorials/creating-components.md | 32 ++++++++-------- .../editing-components-and-contributing.md | 24 ++++++------ app/docs/src/tutorials/getting-started.md | 8 ++-- .../src/tutorials/working-with-components.md | 38 +++++++++---------- 6 files changed, 60 insertions(+), 58 deletions(-) diff --git a/app/docs/src/how-tos/aws-macos.md b/app/docs/src/how-tos/aws-macos.md index 17ef326b92..47240cff7d 100644 --- a/app/docs/src/how-tos/aws-macos.md +++ b/app/docs/src/how-tos/aws-macos.md @@ -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 @@ -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. @@ -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. @@ -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. @@ -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. @@ -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. diff --git a/app/docs/src/tutorials/actions-and-resources.md b/app/docs/src/tutorials/actions-and-resources.md index 186b18ea97..db79b98c1b 100644 --- a/app/docs/src/tutorials/actions-and-resources.md +++ b/app/docs/src/tutorials/actions-and-resources.md @@ -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. @@ -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. diff --git a/app/docs/src/tutorials/creating-components.md b/app/docs/src/tutorials/creating-components.md index 588b6498e8..0b1cf3e241 100644 --- a/app/docs/src/tutorials/creating-components.md +++ b/app/docs/src/tutorials/creating-components.md @@ -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 @@ -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. @@ -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`. @@ -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. @@ -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. @@ -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. @@ -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. @@ -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`. @@ -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. @@ -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) \ No newline at end of file + +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) diff --git a/app/docs/src/tutorials/editing-components-and-contributing.md b/app/docs/src/tutorials/editing-components-and-contributing.md index 64ca4ee41f..1529dc4922 100644 --- a/app/docs/src/tutorials/editing-components-and-contributing.md +++ b/app/docs/src/tutorials/editing-components-and-contributing.md @@ -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. @@ -30,7 +30,7 @@ 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. @@ -38,13 +38,13 @@ 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. @@ -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`. @@ -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. @@ -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. @@ -114,7 +114,7 @@ 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 @@ -122,7 +122,7 @@ ensure your edits are not persisted by clicking the `Abandon Change Set` button ## 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` @@ -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. @@ -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. diff --git a/app/docs/src/tutorials/getting-started.md b/app/docs/src/tutorials/getting-started.md index 4666a73089..56d76f2eb0 100644 --- a/app/docs/src/tutorials/getting-started.md +++ b/app/docs/src/tutorials/getting-started.md @@ -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 @@ -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 @@ -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. @@ -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. diff --git a/app/docs/src/tutorials/working-with-components.md b/app/docs/src/tutorials/working-with-components.md index 461bb72510..fbebf453ba 100644 --- a/app/docs/src/tutorials/working-with-components.md +++ b/app/docs/src/tutorials/working-with-components.md @@ -10,7 +10,7 @@ To follow along, you should: ## Create a Change Set -![Create a Change Set](./working-with-Components/create-a-change-set.png) +![Create a Change Set](./working-with-components/create-a-change-set.png) Click the create Change Set button. @@ -18,7 +18,7 @@ Name your new Change Set `Exploring Properties`, and click the `Create Change Se ## Add a Docker Image Component and set its properties -![Add a Docker Image Component and set its properties](./working-with-Components/add-a-docker-image-Component-and-set-its-properties.png) +![Add a Docker Image Component and set its properties](./working-with-components/add-a-docker-image-component-and-set-its-properties.png) Click on `Docker Image` from the `Docker` category of the Asset pallete, and drop it inside your workspace. @@ -26,7 +26,7 @@ Name your Docker Image Component `nginx`. ## Observe the Docker Images Qualification -![Observe the Docker Images Qualification](./working-with-Components/observe-the-docker-images-qualification.png) +![Observe the Docker Images Qualification](./working-with-components/observe-the-docker-images-qualification.png) Notice the red hexagon in the lower right of your `nginx` Docker Image Component. This is the [qualification](/reference/vocabulary#qualification) icon - it is warning you that your Docker Image Component is misconfigured. @@ -36,7 +36,7 @@ You can also see a Components qualification status in the Diagram Outline, the C ## Investigate the Docker Images Failing Qualification -![Investigate the Docker Image](./working-with-Components/investigate-the-docker-images-failing-qualification.png) +![Investigate the Docker Image](./working-with-components/investigate-the-docker-images-failing-qualification.png) Click the red hexagon on you `nginx` Docker Image Component. The properties panel will change to the `Qualifications` sub-panel. @@ -44,7 +44,7 @@ You will see that your Docker Image is failing the `Docker Image Exists` qualifi ## Fixing the failing Qualification -![Fixing the Failing Qualification](./working-with-Components/fixing-the-failing-qualification.png) +![Fixing the Failing Qualification](./working-with-components/fixing-the-failing-qualification.png) Select the `Attributes` sub-panel. @@ -54,7 +54,7 @@ The qualification icon will then turn green, confirming that a Docker Image name ## Add a Butane Component and set its properties -![Add a Butane Component](./working-with-Components/add-a-butane-Component-and-set-its-properties.png) +![Add a Butane Component](./working-with-components/add-a-butane-component-and-set-its-properties.png) [Butane](https://coreos.github.io/butane/) is a configuration file format used by the [Fedora CoreOS](https://fedoraproject.org/coreos/) operating system. @@ -64,13 +64,13 @@ Name your Butane Component `Web Server Config`. ## Observe the systemd/units property of the Butane Component -![Observe the systemd units](./working-with-Components/observe-the-systemd-units-property-of-the-butane-Component.png) +![Observe the systemd units](./working-with-components/observe-the-systemd-units-property-of-the-butane-component.png) The `systemd/units` property of the `Web Server Config` takes an array (as indicated by the `[ ]` symbol in front of it). It is currently empty, and configured to be automatically set via a socket. ## Manually setting the systemd/units property -![Manually setting the systemd units property](./working-with-Components/manually-setting-the-systemd-units-property.png) +![Manually setting the systemd units property](./working-with-components/manually-setting-the-systemd-units-property.png) To manually set a property that would otherwise be configured by a socket, click the `set` dropdown, and select `manually`. @@ -84,13 +84,13 @@ Notice that the `Web Server Config` is now failing its Qualification, as this is ## Deleting the system/units/unit[0] entry -![Deleting the System/units/unit0 entry](./working-with-Components/deleting-the-system-units-unit-0-entry.png) +![Deleting the System/units/unit0 entry](./working-with-components/deleting-the-system-units-unit-0-entry.png) To delete the `unit[0]` entry, click the trash can icon in the header. ## Connect the Docker Image Component to the Butane Component -![Connect the Docker Image to Butane](./working-with-Components/connect-the-docker-image-Component-to-the-butane-Component.png) +![Connect the Docker Image to Butane](./working-with-components/connect-the-docker-image-component-to-the-butane-component.png) Switch the systemd/units property to be set `via socket`. @@ -98,7 +98,7 @@ Connect the `Container Image` Output Socket of your `nginx` Docker Image Compone ## Observe the new system/units/unit[0] entry -![Observe the new system/units entry](./working-with-Components/observe-the-new-system-units-unit-0-entry.png) +![Observe the new system/units entry](./working-with-components/observe-the-new-system-units-unit-0-entry.png) The new `unit[0]` entry is now set via a function, as indicated by the `f(x)` icon. @@ -106,19 +106,19 @@ The `name`, `contents`, and `enabled` properties have their values inferred by t ## Viewing large properties -![Viewing large properties](./working-with-Components/viewing-large-properties.png) +![Viewing large properties](./working-with-components/viewing-large-properties.png) Some properties, such as `contents`, are too long to display in the panel. You can hover over the field and then click the icon to have them pop-out to a modal for easy viewing. ## Viewing generated code -![Viewing generated code](./working-with-Components/viewing-generated-code.png) +![Viewing generated code](./working-with-components/viewing-generated-code.png) Click the `Code` sub-panel to see the JSON code as it would be processed by Butane. ## Apply the Change Set -![Apply the Change Set](./working-with-Components/apply-the-change-set.png) +![Apply the Change Set](./working-with-components/apply-the-change-set.png) Press the Escape key, or click on the background of the canvas, to ensure the workspace itself is selected. @@ -128,7 +128,7 @@ Click the `Apply Changes` button in the modal to accept. ## Create another Change Set -![Create a new Change Set](./working-with-Components/create-another-new-change-set.png) +![Create a new Change Set](./working-with-components/create-another-new-change-set.png) Click the `Create Change Set` button. @@ -136,7 +136,7 @@ Name your new Change Set `Exploring Part 2`, and click the `Create Change Set` b ## Add an exposed port to your Docker Image -![Add an exposed port to your Docker Image](./working-with-Components/add-an-exposed-port-to-your-docker-image.png) +![Add an exposed port to your Docker Image](./working-with-components/add-an-exposed-port-to-your-docker-image.png) Click the `Add array item` button for the `ExposedPorts` property of your `nginx` Docker Image Component. @@ -144,7 +144,7 @@ Set the `[0]` value to `80/tcp`. ## Check the Diff for your Docker Image and Butane Components -![Check the Diff for your Docker Image and Butane Components](./working-with-Components/check-the-diff-for-your-docker-image-and-butane-Components.png) +![Check the Diff for your Docker Image and Butane Components](./working-with-components/check-the-diff-for-your-docker-image-and-butane-components.png) Click the `Diff` sub-panel for your `nginx` Docker Image Component. You'll see the currently set properties for the Component, and a visual diff of the changes made in this Change Set (compared to the values on HEAD). @@ -152,13 +152,13 @@ Click your `Web Server Config` Butane Component, and you'll see that the entire ## View the Debugging information -![View the Debugging information](./working-with-Components/view-the-debugging-information.png) +![View the Debugging information](./working-with-components/view-the-debugging-information.png) Click the `Debug` sub-panel for your `nginx` Docker Image Component. Here you will find detailed debugging information about the selected Components attributes, Input Sockets, and Output Sockets. This information is often useful when customizing or debugging System Initiative. ## Clean Up -![Clean up](./working-with-Components/clean-up.png) +![Clean up](./working-with-components/clean-up.png) Clean up your workspace by highlighting the `nginx` Docker image and the `Web Server Config` Butane Components. Press the `Delete` key on your keyboard.