diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index 682c6a8f8f..6b2e4383b8 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -176,29 +176,28 @@ Usage: techdocs-cli publish [options] Publish generated TechDocs site to an external storage AWS S3, Google GCS, etc. Options: - --publisher-type (Required always) awsS3 | googleGcs | azureBlobStorage - - same as techdocs.publisher.type in Backstage - app-config.yaml - --storage-name (Required always) In case of AWS/GCS, use the bucket - name. In case of Azure, use container name. Same as - techdocs.publisher.[TYPE].bucketName - --entity (Required always) Entity uid separated by / in - namespace/kind/name order (case-sensitive). Example: - default/Component/myEntity - --legacyUseCaseSensitiveTripletPaths Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). - Only use if your TechDocs backend is configured the same way - --azureAccountName (Required for Azure) specify when --publisher-type - azureBlobStorage - --azureAccountKey Azure Storage Account key to use for authentication. - If not specified, you must set AZURE_TENANT_ID, - AZURE_CLIENT_ID & AZURE_CLIENT_SECRET as environment - variables. - --awsRoleArn Optional AWS ARN of role to be assumed. - --awsEndpoint Optional AWS endpoint to send requests to. - --awsS3ForcePathStyle Optional AWS S3 option to force path style. - --directory Path of the directory containing generated files to - publish (default: "./site/") - -h, --help display help for command + --publisher-type (Required always) awsS3 | googleGcs | azureBlobStorage | openStackSwift - same as techdocs.publisher.type in Backstage app-config.yaml + --storage-name (Required always) In case of AWS/GCS, use the bucket name. In case of Azure, use container name. Same as + techdocs.publisher.[TYPE].bucketName + --entity (Required always) Entity uid separated by / in namespace/kind/name order (case-sensitive). Example: default/Component/myEntity + --legacyUseCaseSensitiveTripletPaths Publishes objects with cased entity triplet prefix when set (e.g. namespace/Kind/name). Only use if your TechDocs backend is configured + the same way. (default: false) + --azureAccountName (Required for Azure) specify when --publisher-type azureBlobStorage + --azureAccountKey Azure Storage Account key to use for authentication. If not specified, you must set AZURE_TENANT_ID, AZURE_CLIENT_ID & + AZURE_CLIENT_SECRET as environment variables. + --awsRoleArn Optional AWS ARN of role to be assumed. + --awsEndpoint Optional AWS endpoint to send requests to. + --awsProxy Optional Proxy to use for AWS requests. + --awsS3sse Optional AWS S3 Server Side Encryption. + --awsS3ForcePathStyle Optional AWS S3 option to force path style. + --awsBucketRootPath Optional sub-directory to store files in Amazon S3 + --osCredentialId (Required for OpenStack) specify when --publisher-type openStackSwift + --osSecret (Required for OpenStack) specify when --publisher-type openStackSwift + --osAuthUrl (Required for OpenStack) specify when --publisher-type openStackSwift + --osSwiftUrl (Required for OpenStack) specify when --publisher-type openStackSwift + --gcsBucketRootPath Optional sub-directory to store files in Google cloud storage + --directory Path of the directory containing generated files to publish (default: "./site/") + -h, --help display help for command ``` ### Migrate content for case-insensitive access