8000 docs: update documentation to reflect current releases (and add discl… · coder/backstage-plugins@51e5279 · GitHub
[go: up one dir, main page]

Skip to content

Commit 51e5279

Browse files
authored
docs: update documentation to reflect current releases (and add disclaimers) (#106)
1 parent ece362a commit 51e5279

File tree

5 files changed

+6
-4
lines changed

5 files changed

+6
-4
lines changed

plugins/backstage-plugin-coder/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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).
44

5+
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`.
6+
57
## Documentation directory
68

79
- [Components](./components.md)

plugins/backstage-plugin-devcontainers-backend/README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,6 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
7676
DevcontainersProcessor.fromConfig(env.config, {
7777
tagName: 'example', // Defaults to devcontainers
7878
logger: env.logger,
79-
eraseTags: false,
8079
}),
8180
);
8281

@@ -115,7 +114,6 @@ export default async function createPlugin(
115114
builder.addProcessor(
116115
DevcontainersProcessor.fromConfig(env.config, {
117116
logger: env.logger,
118-
eraseTags: false,
119117
}),
120118
);
121119

plugins/backstage-plugin-devcontainers-backend/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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).
44

5+
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`.
6+
57
## Documentation directory
68

79
- [Classes](./classes.md)

plugins/backstage-plugin-devcontainers-backend/docs/classes.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,6 @@ This class provides a custom [catalog processor](https://backstage.io/docs/featu
1515
```tsx
1616
type ProcessorOptions = Readonly<{
1717
tagName: string;
18-
eraseTags: boolean;
1918
logger: Logger;
2019
}>;
2120

@@ -62,7 +61,6 @@ export default async function createPlugin(
6261
builder.addProcessor(
6362
DevcontainersProcessor.fromConfig(env.config, {
6463
logger: env.logger,
65-
eraseTags: false,
6664
}),
6765
);
6866

plugins/backstage-plugin-devcontainers-react/docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
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).
44

5+
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`.
6+
57
## Documentation directory
68

79
- [Components](./components.md)

0 commit comments

Comments
 (0)
0