Thanks to visit codestin.com
Credit goes to github.com

Skip to content

docs: update documentation to better reflect current releases #106

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 4, 2024
+6 −4
Merged

docs: update documentation to better reflect current releases #106

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions plugins/backstage-plugin-coder/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 0 additions & 2 deletions plugins/backstage-plugin-devcontainers-backend/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
}),
);

Expand Down Expand Up @@ -115,7 +114,6 @@ export default async function createPlugin(
builder.addProcessor(
DevcontainersProcessor.fromConfig(env.config, {
logger: env.logger,
eraseTags: false,
}),
);

Expand Down
2 changes: 2 additions & 0 deletions plugins/backstage-plugin-devcontainers-backend/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 0 additions & 2 deletions plugins/backstage-plugin-devcontainers-backend/docs/classes.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
}>;

Expand Down Expand Up @@ -62,7 +61,6 @@ export default async function createPlugin(
builder.addProcessor(
DevcontainersProcessor.fromConfig(env.config, {
logger: env.logger,
eraseTags: false,
}),
);

Expand Down
2 changes: 2 additions & 0 deletions plugins/backstage-plugin-devcontainers-react/docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down