gocardless/Publish TechDocs
Generate and publish TechDocs
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| publisher | awsS3 | googleGcs | azureBlobStorage | yes | — |
| credentials | Credentials required to authenticate with your publisher through the techdocs-cli For GCS, provide the JSON service account key file, as a base64-encoded string in GOOGLE_APPLICATION_CREDENTIALS For AWS, provide AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_REGION, delimited by a space For Azure, provide AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET delimited by a space | yes | — |
| bucket | In case of AWS or GCS this is the bucket name. In case of Azure, the container name | yes | — |
| entity | Entity uid separated by / in namespace/kind/name order (case-sensitive). For example default/Component/myEntity | yes | — |
| sourceDir | Source directory for repositories containing nested documentation | — | . |
| azureAccountName | Azure account name, required if publisher is Azure | — | — |
| azureAccountKey | Azure Storage Account key. Use as an alternative authentication method to the credentials input | — | — |
| awsRoleArn | Optional AWS ARN of role to be assumed | — | — |
| awsEndpoint | Optional AWS endpoint to send requests to | — | — |
Outputs
no outputs