From 0513536be85e4bdb3f99e4e77fe710ce2704195f Mon Sep 17 00:00:00 2001 From: Himanshu Mishra Date: Wed, 6 Jan 2021 14:10:51 +0100 Subject: [PATCH] docs(TechDocs): Update publisher milestones about AWS and Azure storage --- docs/features/techdocs/README.md | 12 ++++++------ docs/features/techdocs/configuration.md | 16 ++++------------ 2 files changed, 10 insertions(+), 18 deletions(-) diff --git a/docs/features/techdocs/README.md b/docs/features/techdocs/README.md index cf94efda5e..82db4e15ff 100644 --- a/docs/features/techdocs/README.md +++ b/docs/features/techdocs/README.md @@ -108,12 +108,12 @@ providers are used. | GitLab | Yes ✅ | | GitLab Enterprise | Yes ✅ | -| File Storage Provider | Support Status | -| --------------------------------- | -------------- | -| Local Filesystem of Backstage app | Yes ✅ | -| Google Cloud Storage (GCS) | Yes ✅ | -| Amazon Web Services (AWS) S3 | Yes ✅ | -| Azure Storage | No ❌ | +| File Storage Provider | Support Status | +| --------------------------------- | ----------------------------------------------------------------- | +| Local Filesystem of Backstage app | Yes ✅ | +| Google Cloud Storage (GCS) | Yes ✅ | +| Amazon Web Services (AWS) S3 | Yes ✅ | +| Azure Storage | No ❌ [#3938](https://github.com/backstage/backstage/issues/3938) | [Reach out to us](#feedback) if you want to request more platforms. diff --git a/docs/features/techdocs/configuration.md b/docs/features/techdocs/configuration.md index 1190c219a8..7a0a4dbbbf 100644 --- a/docs/features/techdocs/configuration.md +++ b/docs/features/techdocs/configuration.md @@ -13,18 +13,15 @@ configuration options for TechDocs. # File: app-config.yaml techdocs: - # TechDocs makes API calls to techdocs-backend using this URL. e.g. get docs of an entity, get metadata, etc. requestUrl: http://localhost:7000/api/techdocs - # Just another route in techdocs-backend where TechDocs requests the static files from. This URL uses an HTTP middleware # to serve files from either a local directory or an External storage provider. storageUrl: http://localhost:7000/api/techdocs/static/docs - # generators.techdocs can have two values: 'docker' or 'local'. This is to determine how to run the generator - whether to # spin up the techdocs-container docker image or to run mkdocs locally (assuming all the dependencies are taken care of). # You want to change this to 'local' if you are running Backstage using your own custom Docker setup and want to avoid running @@ -34,7 +31,6 @@ techdocs: generators: techdocs: 'docker' - # techdocs.builder can be either 'local' or 'external. # If builder is set to 'local' and you open a TechDocs page, techdocs-backend will try to generate the docs, publish to storage # and show the generated docs afterwords. This is the "Basic" setup of the TechDocs Architecture. @@ -44,32 +40,29 @@ techdocs: builder: 'local' - # techdocs.publisher is used to configure the Storage option, whether you want to use the local filesystem to store generated docs # or you want to use External storage providers like Google Cloud Storage, AWS S3, etc. publisher: - - # techdocs.publisher.type can be - 'local' or 'googleGcs' (awsS3, azureStorage, etc. to be available as well). + # techdocs.publisher.type can be - 'local' or 'googleGcs' or 'awsS3' (azureStorage to be available in future). # When set to 'local', techdocs-backend will create a 'static' directory at its root to store generated documentation files. # When set to 'googleGcs', techdocs-backend will use a Google Cloud Storage Bucket to store generated documentation files. # When set to 'awsS3', techdocs-backend will use an Amazon Web Service (AWS) S3 bucket to store generated documentation files. type: 'local' - # Required when techdocs.publisher.type is set to 'googleGcs'. Skip otherwise. googleGcs: # An API key is required to write to a storage bucket. credentials: - $file: '/path/to/google_application_credentials.json', + $file: '/path/to/google_application_credentials.json' # Your GCP Project ID where the Cloud Storage Bucket is hosted. projectId: 'gcp-project-id' # Cloud Storage Bucket Name - bucketName: 'techdocs-storage', + bucketName: 'techdocs-storage' # Required when techdocs.publisher.type is set to 'awsS3'. Skip otherwise. @@ -84,6 +77,5 @@ techdocs: $env: AWSS3_REGION # AWS S3 Bucket Name - bucketName: 'techdocs-storage', - + bucketName: 'techdocs-storage' ```