Skip to content

Commit

Permalink
Other small fixes
Browse files Browse the repository at this point in the history
Signed-off-by: Kim Christensen <kimworking@gmail.com>
  • Loading branch information
kichristensen committed May 24, 2024
1 parent bd42689 commit 5866772
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 18 deletions.
18 changes: 4 additions & 14 deletions .github/workflows/check-docs-links.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@ jobs:
group: ${{ github.workflow }}-${{ github.ref }}
steps:
- name: Check out repository
uses: actions/checkout@v3
with:
submodules: recursive # Fetch Hugo themes
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod

- uses: actions/checkout@v4
uses: actions/checkout@v4
with:
submodules: true # Fetch Hugo themes (true OR recursive)
fetch-depth: 0 # Fetch all history for .GitInfo and .Lastmod
Expand All @@ -31,16 +26,11 @@ jobs:
hugo-version: '0.117.0'
extended: true

- name: Build Hugo
run: hugo -s docs -d $GITHUB_WORKSPACE/dist
- name: Build website
run: go run mage.go -v Docs

- name: Run htmltest
uses: wjdp/htmltest-action@master
with:
path: dist
path: docs/public
config: docs/.htmltest.yml

- uses: actions/upload-artifact@v4
with:
name: htmltest-output
path: dist
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -526,7 +526,7 @@ If you are using GoLand, use the **Go Remote** debug configuration and make sure

### Command Documentation

Our commands are documented at <https://porter.sh/docs/references/cli/> and that documentation is
Our commands are documented at <https://porter.sh/docs/references/> and that documentation is
generated by our CLI. You should regenerate that documentation when you change
any files in **cmd/porter** by running `mage DocsGen` which is run every time
you run `mage build`.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/docs/operations/examine-bundles.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ The `porter explain` command will show what credentials and parameters are requi

`porter explain` can be used with a published bundle, as show above, or with a local bundle. The command even works with bundles that were not built with Porter, through the use of the `--cnab-file` flag. For all the options, run the command `porter explain --help`.

If you would like to see the invocation images and/or the images the bundle will use, see the [inspect](/cli/inspect-bundles/) command.
If you would like to see the invocation images and/or the images the bundle will use, see the [inspect](/cli/inspect_bundles/) command.
3 changes: 1 addition & 2 deletions docs/content/wiring.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Parameters, Credentials, Outputs, and Images in Porter
description: How to wire parameters, credentials and outputs into steps
---

In the Porter manifest, you can declare both parameters and credentials. In addition to providing a mechanism for declaring parameters and credentials at the bundle level, Porter provides a way to declare how each of these are provided to [mixins][mixin-architecture]. This mechanism is also applicable to declaring how output from one mixin can be passed to another, as well as how to consume parameters, credentials and outputs from bundle dependencies. Finally, you can also use this technique to reference images defined in the `images` section of the manifest.
In the Porter manifest, you can declare both parameters and credentials. In addition to providing a mechanism for declaring parameters and credentials at the bundle level, Porter provides a way to declare how each of these are provided to mixins. This mechanism is also applicable to declaring how output from one mixin can be passed to another, as well as how to consume parameters, credentials and outputs from bundle dependencies. Finally, you can also use this technique to reference images defined in the `images` section of the manifest.

* [Wiring Installation Metadata](#wiring-installation-metadata)
* [Parameters](#parameters)
Expand Down Expand Up @@ -438,6 +438,5 @@ install:
jdbc_url: "jdbc:mysql://${ bundle.outputs.mysql_host }:${ bundle.outputs.mysql_port }/${ bundle.parameters.database_name }
```

[mixin-architecture]: /mixin-dev-guide/architecture/
[credentials]: /docs/introduction/concepts-and-components/intro-credentials/
[parameters]: /docs/introduction/concepts-and-components/intro-parameters/

0 comments on commit 5866772

Please sign in to comment.