Move built-in actions docs to the scaffolder itself

Signed-off-by: Johan Haals <johan.haals@gmail.com>
2021-03-09 13:43:19 +01:00
parent 53a111d238
commit f9aeab88a0
1 changed files with 8 additions and 105 deletions
@@ -6,110 +6,13 @@ description: Documentation describing the built-in template actions.

 # Built-in Actions

-This is the list of built-in template actions
+The scaffolder comes with several built-in actions for fetching content,
+registering in the catalog and of course actions for creating and publishing a
+git repository.

-## `fetch:plain`
+There are several repository providers supported out of the box such as GitHub,
+Azure, GitLab and Bitbucket.

-Downloads content and places it in the workspacePath or optionally in a
-subdirectory specified by the `targetPath` input option.
-
-input:
-
- `url` (required) Relative path or absolute URL pointing to the directory tree
-  to fetch.
- `targetPath` Target path within the working directory to download the contents
-  to.
-
-output: nothing
-
-## `fetch:cookiecutter`
-
-Downloads template from `url` and templates with cookiecutter
-
-input:
-
- `url` (required) Relative path or absolute URL pointing to the directory tree
-  to fetch.
- `targetPath` Target path within the working directory to download the contents
-  to.
- `values` Values to pass on to cookiecutter for templating.
-
-output: nothing
-
-## `catalog:register`
-
-Registers entity in the software catalog.
-
-input:
-
- `catalogInfoUrl` (required) An absolute URL pointing to the catalog info file
-  location.
-
-output:
-
- `repoContentsUrl` An absolute URL pointing to the root of a repository
-  directory tree.
- `catalogInfoPath` A relative path from the repo root pointing to the catalog
-  info file, defaults to /catalog-info.yaml
-
-## `publish:github`
-
-Initializes a git repository of contents in workspacePath and publishes to
-GitHub.
-
-input:
-
- `repoUrl` (required) Repository location
- `repoVisibility` (optional, default: 'private') Possible values: 'private',
-  'public' or 'internal'.
-
-output:
-
- `remoteUrl` A URL to the repository with the provider
- `repoContentsUrl` A URL to the root of the repository
-
-## `publish:gitlab`
-
-Initializes a git repository of contents in workspacePath and publishes to
-GitLab.
-
-input:
-
- `repoUrl` (required) Repository location
- `repoVisibility` (optional, default: 'private') Possible values: 'private',
-  'public' or 'internal'.
-
-output:
-
- `remoteUrl` A URL to the repository with the provider
- `repoContentsUrl` A URL to the root of the repository
-
-## `publish:bitbucket`
-
-Initializes a git repository of contents in workspacePath and publishes to
-Bitbucket.
-
-input:
-
- `repoUrl` (required) Repository location
- `repoVisibility` (optional, default: 'private') Possible values: 'private',
-  'public'.
-
-output:
-
- `remoteUrl` A URL to the repository with the provider
- `repoContentsUrl` A URL to the root of the repository
-
-## `publish:azure`
-
-Initializes a git repository of contents in workspacePath and publishes to
-Azure.
-
-input:
-
- `repoUrl` (required) Repository location
-
-output:
-
- `remoteUrl` A URL to the repository with the provider
- `repoContentsUrl` A URL to the root of the repository
+A list of all registered actions can be found under `/create/actions`. For local
+development you should be able to reach them at
+`http://localhost:3000/create/actions`.