Update documentation (#34)

* refactor changelog

* update actions

* update pr number

CHANGELOG.md

@@ -1,8 +1,8 @@
-# viash-actions v6.0.1
+# viash-actions v6.1.0
 
 ## New functionality
 
-* `sync-and-cache`: Added an action for syncing and caching test resources (PR #31).
+* `project/sync-and-cache`: Added an action for syncing and caching test resources (PR #31).
 
 ## Minor changes
 
@@ -12,10 +12,13 @@
 
 * `project/detect-changed-components`: Output the `full_name` and `main_script_type` of each component (PR #33).
 
+* Update documentation for various components (PR #34).
+
 ## Bug fixes
 
 * `check-concurrent-pr`: Added input parameter `github_token` for checking concurrent PRs (PR #31).
 
+
 # viash-actions v6.0.0
 
 ## Breaking changes

README.md

@@ -27,11 +27,11 @@ Finally, there are some [Viash
 Pro](https://www.data-intuitive.com/services/viashpro.html) actions:
 
 1.  [`pro/build-nextflow-params`](pro/build-nextflow-params) - Build
-    parameter yaml
+    parameter yaml examples for Viash components
 2.  [`pro/build-nextflow-schemas`](pro/build-nextflow-schemas) - Build
-    nf-tower schemas
+    nf-tower schemas for Viash components
 3.  [`pro/generate-documentation-qmd`](pro/generate-documentation-qmd) -
-    Build and publish qmd
+    Build quarto markdown documentation files for Viash components
 
 We recommend using `v6` for your actions.
 

pro/build-nextflow-params/README.md

@@ -9,9 +9,6 @@ This README was generated by running `make`
 
 This action will build nextflow parameter file templates (see nextflow’s
 -params-file option) for Viash workflows and components in a repository.
-For workflows, will save the build parameter files next to the Viash
-config. For components, will output to the target directory (see viash
-ns build).
 
 ### Inputs available
 
@@ -42,7 +39,7 @@ jobs:
     - name: Check out repository
       uses: actions/checkout@v3
 
-    - name: Build parameter yaml
+    - name: Build parameter yaml examples for Viash components
       uses: viash-io/viash-actions/pro/build-nextflow-params@v6
       with:
         target: target/

pro/build-nextflow-params/action.yml

@@ -1,10 +1,8 @@
-name: 'Build parameter yaml'
+name: 'Build parameter yaml examples for Viash components'
 author: Data Intuitive
 description: >
   This action will build nextflow parameter file templates
   (see nextflow's -params-file option) for Viash workflows and components in a repository.
-  For workflows, will save the build parameter files next to the Viash config.
-  For components, will output to the target directory (see viash ns build).
 inputs:
   target_dir:
     required: false

pro/build-nextflow-schemas/README.md

@@ -8,9 +8,7 @@ This README was generated by running `make`
 -->
 
 This action will build nextflow schemas for Viash workflows and
-components in a repository. For workflows, will save the build schemas
-next to the Viash config. For components, will output to the target
-directory (see viash ns build).
+components in a repository.
 
 ### Inputs available
 
@@ -43,7 +41,7 @@ jobs:
     - name: Check out repository
       uses: actions/checkout@v3
 
-    - name: Build nf-tower schemas
+    - name: Build nf-tower schemas for Viash components
       uses: viash-io/viash-actions/pro/build-nextflow-schemas@v6
       with:
         target: target/

pro/build-nextflow-schemas/action.yml

@@ -1,9 +1,7 @@
-name: 'Build nf-tower schemas'
+name: 'Build nf-tower schemas for Viash components'
 author: Data Intuitive
 description: >
   This action will build nextflow schemas for Viash workflows and components in a repository.
-  For workflows, will save the build schemas next to the Viash config.
-  For components, will output to the target directory (see viash ns build).
 inputs:
   target_dir:
     required: false

pro/generate-documentation-qmd/README.md

@@ -7,12 +7,12 @@ DO NOT EDIT THIS FILE MANUALLY!
 This README was generated by running `make`
 -->
 
-Create quarto markdown files for viash components or workflows, based on
+Create quarto markdown files for Viash components or workflows, based on
 a jinja template.
 
-This action will look for viash configs for workflows and components in
+This action will look for Viash configs for workflows and components in
 a directory, and will apply information for each of these configs to a
-jinja template to generate qmd files. This component required Viash to
+jinja template to generate qmd files. This component requires Viash to
 be installed and available in `$PATH`.
 
 We recommend to use
@@ -71,7 +71,7 @@ jobs:
       with:
         path: project
 
-    - name: Build and publish qmd
+    - name: Build quarto markdown documentation files for Viash components
       uses: viash-io/viash-actions/generate-documentation-qmd@v6
       with:
         project_dir: project

pro/generate-documentation-qmd/action.yml

@@ -1,11 +1,11 @@
-name: 'Build and publish qmd'
+name: 'Build quarto markdown documentation files for Viash components'
 author: 'Dries Schaumont'
 description: |
-  Create quarto markdown files for viash components or workflows, based on a jinja template.
+  Create quarto markdown files for Viash components or workflows, based on a jinja template.
 
-  This action will look for viash configs for workflows and components in a directory, 
+  This action will look for Viash configs for workflows and components in a directory, 
   and will apply information for each of these configs to a jinja template to generate qmd files.
-  This component required Viash to be installed and available in `$PATH`.
+  This component requires Viash to be installed and available in `$PATH`.
   
   We recommend to use [viash-actions/setup](https://github.com/viash-io/viash-actions/tree/main/setup) before you run `generate_documentation_qmd`.
 inputs: