From ff2623a52e7f99b2eedcf91f6644c82196033ce7 Mon Sep 17 00:00:00 2001 From: Parkreiner Date: Thu, 4 Apr 2024 19:32:03 +0000 Subject: [PATCH] docs: update documentation to reflect current releases (and add disclaimers) --- plugins/backstage-plugin-coder/docs/README.md | 2 ++ plugins/backstage-plugin-devcontainers-backend/README.md | 2 -- plugins/backstage-plugin-devcontainers-backend/docs/README.md | 2 ++ plugins/backstage-plugin-devcontainers-backend/docs/classes.md | 2 -- plugins/backstage-plugin-devcontainers-react/docs/README.md | 2 ++ 5 files changed, 6 insertions(+), 4 deletions(-) diff --git a/plugins/backstage-plugin-coder/docs/README.md b/plugins/backstage-plugin-coder/docs/README.md index 7ca73a4e..1aac4a05 100644 --- a/plugins/backstage-plugin-coder/docs/README.md +++ b/plugins/backstage-plugin-coder/docs/README.md @@ -2,6 +2,8 @@ For users who need more information about how to extend and modify the Coder plugin. For general setup, please see our main [README](../README.md). +All documentation reflects version `v0.2.0` of the plugin. Note that breaking API changes may continue to happen for minor versions until the plugin reaches version `v1.0.0`. + ## Documentation directory - [Components](./components.md) diff --git a/plugins/backstage-plugin-devcontainers-backend/README.md b/plugins/backstage-plugin-devcontainers-backend/README.md index ac423323..e404c42a 100644 --- a/plugins/backstage-plugin-devcontainers-backend/README.md +++ b/plugins/backstage-plugin-devcontainers-backend/README.md @@ -76,7 +76,6 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins DevcontainersProcessor.fromConfig(env.config, { tagName: 'example', // Defaults to devcontainers logger: env.logger, - eraseTags: false, }), ); @@ -115,7 +114,6 @@ export default async function createPlugin( builder.addProcessor( DevcontainersProcessor.fromConfig(env.config, { logger: env.logger, - eraseTags: false, }), ); diff --git a/plugins/backstage-plugin-devcontainers-backend/docs/README.md b/plugins/backstage-plugin-devcontainers-backend/docs/README.md index 30fa1c61..a85226e2 100644 --- a/plugins/backstage-plugin-devcontainers-backend/docs/README.md +++ b/plugins/backstage-plugin-devcontainers-backend/docs/README.md @@ -2,6 +2,8 @@ For users who need more information about how to extend and modify the Dev Containers plugin. For general setup, please see our main [README](../README.md). +All documentation reflects version `v0.1.0` of the plugin. Note that breaking API changes may continue to happen for minor versions until the plugin reaches version `v1.0.0`. + ## Documentation directory - [Classes](./classes.md) diff --git a/plugins/backstage-plugin-devcontainers-backend/docs/classes.md b/plugins/backstage-plugin-devcontainers-backend/docs/classes.md index fa1573f5..22051715 100644 --- a/plugins/backstage-plugin-devcontainers-backend/docs/classes.md +++ b/plugins/backstage-plugin-devcontainers-backend/docs/classes.md @@ -15,7 +15,6 @@ This class provides a custom [catalog processor](https://backstage.io/docs/featu ```tsx type ProcessorOptions = Readonly<{ tagName: string; - eraseTags: boolean; logger: Logger; }>; @@ -62,7 +61,6 @@ export default async function createPlugin( builder.addProcessor( DevcontainersProcessor.fromConfig(env.config, { logger: env.logger, - eraseTags: false, }), ); diff --git a/plugins/backstage-plugin-devcontainers-react/docs/README.md b/plugins/backstage-plugin-devcontainers-react/docs/README.md index 9c09102d..1080b2dc 100644 --- a/plugins/backstage-plugin-devcontainers-react/docs/README.md +++ b/plugins/backstage-plugin-devcontainers-react/docs/README.md @@ -2,6 +2,8 @@ For users who need more information about how to extend and modify the Dev Containers plugin. For general setup, please see our main [README](../README.md). +All documentation reflects version `v0.1.0` of the plugin. Note that breaking API changes may continue to happen for minor versions until the plugin reaches version `v1.0.0`. + ## Documentation directory - [Components](./components.md)