Skip to content

Commit

Permalink
Merge pull request #4236 from systeminit/keeb/add-qualification-infor…
Browse files Browse the repository at this point in the history
…mation

Add qualification information to the docs
  • Loading branch information
keeb authored Jul 26, 2024
2 parents 491230a + 1409b78 commit 8d3e37c
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
7 changes: 7 additions & 0 deletions app/docs/src/reference/vocabulary.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,3 +67,10 @@ A resource is the data about the real-world thing represented by a component.

Secrets are encrypted data stored for a given type of credential. They are
defined by a credential component.

## Qualification

Qualifications are functions that are executed to ensure that the component can
be applied successfully to the workspace. An example is the qualification
function that checks if the Secret you have passed into your AWS Credential
component are valid.
10 changes: 10 additions & 0 deletions app/docs/src/tutorials/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ Fill in your AWS accounts `Access Key Id` and `Secret Access Key`.
Click `Store Secret` to securely encrypt and save your
[secret](../reference/vocabulary#secret).

:::warning

A side note about [qualifications](/reference/vocabulary#qualification)

If you see a red hexagon in the lower corner of your AWS credential frame at
this point, it means that the credentials are invalid and need to be re-entered.
In some cases, you may need to also add your AWS Session Key.

:::

## Add an AWS Region component and set its properties

Click on the `Region` from the AWS category of the asset pallete, and drop it
Expand Down

0 comments on commit 8d3e37c

Please sign in to comment.