diff --git a/.github/workflows/check-docs-links.yml b/.github/workflows/check-docs-links.yml index 7078aee88..379d8ae04 100644 --- a/.github/workflows/check-docs-links.yml +++ b/.github/workflows/check-docs-links.yml @@ -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 @@ -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 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5e8e305ef..6fd2f30e6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 and that documentation is +Our commands are documented at 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`. diff --git a/docs/content/docs/operations/examine-bundles.md b/docs/content/docs/operations/examine-bundles.md index e025cb730..94e4bf0f8 100644 --- a/docs/content/docs/operations/examine-bundles.md +++ b/docs/content/docs/operations/examine-bundles.md @@ -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. diff --git a/docs/content/wiring.md b/docs/content/wiring.md index e2fc40fff..62f7ac65a 100644 --- a/docs/content/wiring.md +++ b/docs/content/wiring.md @@ -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) @@ -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/