You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
fix: Update branding for "dev containers" for all documentation (#31)
* docs: update dev containers branding in documentation files
* fix: update branding usage in main dev containers component
* fix: update casing for docs
* fix: update casing in main component
* fix: more case issues
* docs: fix plural issue
Copy file name to clipboardExpand all lines: README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ A collection of plugins that extend [Backstage](https://backstage.io) to help wi
4
4
5
5
-[backstage-plugin-coder](./plugins/backstage-plugin-coder/README.md): A plugin for integrating Coder workspaces with Backstage.
6
6
-[backstage-plugin-devcontainers-backend](./plugins/backstage-plugin-devcontainers/README.md): A plugin for integrating VS Code Dev Containers extension with Backstage catalog items (no Coder deployment necessary).
7
-
-[backstage-plugin-devcontainers-react](./plugins/backstage-plugin-devcontainers-react/README.md): A plugin for allowing you to detect and work with devcontainers repo data added by `backstage-plugin-devcontainers-backend`, namely letting you open a repo in VS Code with a full devcontainers setup (no Coder deployment necessary).
7
+
-[backstage-plugin-devcontainers-react](./plugins/backstage-plugin-devcontainers-react/README.md): A plugin for allowing you to detect and work with Dev Containers repo data added by `backstage-plugin-devcontainers-backend`, namely letting you open a repo in VS Code with a full Dev Containers setup (no Coder deployment necessary).
8
8
9
9
Please use [GitHub issues](https://github.com/coder/backstage-plugins/issues) to report any issues or feature requests.
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-backend/README.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# @coder/backstage-plugin-devcontainers-backend
2
2
3
-
Automatically detect [development containers (devcontainer) files](https://containers.dev/) in your repositories on GitHub/GitLab/Bitbucket, and have Backstage automatically tag them in the background!
3
+
Automatically detect [development containers (Dev Container) files](https://containers.dev/) in your repositories on GitHub/GitLab/Bitbucket, and have Backstage automatically tag them in the background!
4
4
5
5
## Screenshots
6
6
@@ -17,7 +17,7 @@ _Note: While this plugin can be used standalone, it has been designed to be a ba
17
17
18
18
### When combined with the frontend plugin
19
19
20
-
- Provides an end-to-end solution for automatically adding/removing devcontainers metadata in your Backstage installation, while letting you read them from custom hooks and components
20
+
- Provides an end-to-end solution for automatically adding/removing Dev Containers metadata in your Backstage installation, while letting you read them from custom hooks and components
21
21
22
22
## Setup
23
23
@@ -81,7 +81,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
81
81
}
82
82
```
83
83
84
-
5. As your provider of choice re-validates data and emits more entity information, `DevcontainersProcessor` will automatically intercept the data and append or remove tags, based on whether the current repository has a devcontainers file! (See our API docs for more info on our [appending/removal process](./docs/classes.md#notes))
84
+
5. As your provider of choice re-validates data and emits more entity information, `DevcontainersProcessor` will automatically intercept the data and append or remove tags, based on whether the current repository has a Dev Containers file! (See our API docs for more info on our [appending/removal process](./docs/classes.md#notes))
85
85
86
86
Full example:
87
87
@@ -125,9 +125,9 @@ export default async function createPlugin(
125
125
126
126
This plugin lets the user decide how to bring in repository data. As such, the plugin is limited by (1) what data your Backstage repo provider is able to detect, and (2) what API calls your source control manager supports.
127
127
128
-
Basic devcontainers support has been tested for GitHub, GitLab, and Bitbucket, using their default Backstage data providers. All three are able to detect a devcontainer config file, as long as the file is located in a supported location, as defined by [the official devcontainers specification](https://containers.dev/implementors/spec/#devcontainerjson).
128
+
Basic Dev Containers support has been tested for GitHub, GitLab, and Bitbucket, using their default Backstage data providers. All three are able to detect a Dev Container config file, as long as the file is located in a supported location, as defined by [the official Dev Containers specification](https://containers.dev/implementors/spec/#devcontainerjson).
129
129
130
-
Other providers can be used, but are not guaranteed to work out of the box. In addition, not all source control managers provide an API for searching for deeply-nested files. In some cases, only the first two devcontainer config locations will be detectable.
130
+
Other providers can be used, but are not guaranteed to work out of the box. In addition, not all source control managers provide an API for searching for deeply-nested files. In some cases, only the first two Dev Container config locations will be detectable.
131
131
132
132
We are happy to expand support for other source control managers, though. If you have a specific use case you'd like our help with, feel free to open a new issue!
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-backend/docs/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# API Reference – backstage-plugin-devcontainers-backend
2
2
3
-
For users who need more information about how to extend and modify the Devcontainers plugin. For general setup, please see our main [README](../README.md).
3
+
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).
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-backend/docs/classes.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Plugin API reference - classes
2
2
3
-
This is the main documentation page for the Devcontainer plugin's exported classes.
3
+
This is the main documentation page for the exported classes for `backstage-plugin-devcontainers-backkend`:
4
4
5
5
## Class list
6
6
@@ -82,7 +82,7 @@ export default async function createPlugin(
82
82
- If the value of `tagName` is not specified for `fromConfig`, the class will default to the value `devcontainers`
83
83
- The appending/removal process for tags works as follows:
84
84
1. An entity provider re-validates its data and ingests a new entity
85
-
2. The processor will run a pre-process step to determine if the devcontainers tag (which defaults to `devcontainers`) should be added.
85
+
2. The processor will run a pre-process step to determine if the Dev Containers tag (which defaults to `devcontainers`) should be added.
86
86
3. If the tag is added, this entity will eventually be added if it is brand new, or if there is a matching entity on file, be reconciled with it
87
87
4. During the reconciliation process, the existing entity will have the new tag added if the new version had it. However, if the new entity does not have the tag, the existing entity will lose the tag during reconciliation.
88
88
5. Unless another plugin adds the same tag, the only way to ensure that the tag stays applied to the entities available in the UI is by ensuring that the tag is included at each re-validation step.
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-react/README.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,11 +14,11 @@ _Note: While this plugin can be used standalone, it has been designed to be a fr
14
14
15
15
### Standalone features
16
16
17
-
- Custom hooks for reading your special devcontainer metadata tag inside your repo entities, and providing ready-made links to opening that repo in VS Code
17
+
- Custom hooks for reading your special Dev Container metadata tag inside your repo entities, and providing ready-made links to opening that repo in VS Code
18
18
19
19
### When combined with the backend plugin
20
20
21
-
- Provides an end-to-end solution for automatically adding/removing devcontainers metadata in your Backstage installation, while letting you read them from custom hooks and components
21
+
- Provides an end-to-end solution for automatically adding/removing Dev Containers metadata in your Backstage installation, while letting you read them from custom hooks and components
22
22
23
23
## Setup
24
24
@@ -29,7 +29,7 @@ This section will walk you through adding the plugin to your Backstage deploymen
29
29
Ensure that you have the following ready to go:
30
30
31
31
- A Backstage deployment that you can modify
32
-
- A GitHub/GitLab/Bitbucket repository that contains a `devcontainers.json` file. [VS Code has a quick-start guide for adding devcontainers to a repo](https://code.visualstudio.com/docs/devcontainers/create-dev-container)
32
+
- A GitHub/GitLab/Bitbucket repository that contains a `devcontainers.json` file. [VS Code has a quick-start guide for adding Dev Containers to a repo](https://code.visualstudio.com/docs/devcontainers/create-dev-container)
33
33
-[Docker](https://docs.docker.com/get-docker/) installed and running locally on your machine
34
34
35
35
_Note: While this plugin has been developed and published by Coder, no Coder installations are required._
@@ -66,7 +66,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
@@ -123,7 +123,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
123
123
</DevcontainersProvider>;
124
124
```
125
125
126
-
6. When you click a link to open a devcontainer inside VS Code, you will be prompted to install the official [VS Code Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) if you don't have it already.
126
+
6. When you click a link to open a Dev Container inside VS Code, you will be prompted to install the official [VS Code Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) if you don't have it already.
127
127
128
128
Have an idea for what kinds of components you would like to see? Feel free to open an issue and make a feature request!
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-react/docs/README.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# API Reference – backstage-plugin-devcontainers-react
2
2
3
-
For users who need more information about how to extend and modify the Devcontainers plugin. For general setup, please see our main [README](../README.md).
3
+
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).
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-react/docs/components.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,8 +12,8 @@ This component is designed as a lightweight demonstration of the main [`useDevco
12
12
13
13
Its main functionality is:
14
14
15
-
- Detecting whether the current repo entity being viewed supports has been tagged with the configured devcontainers tag (as defined by the config options in [`DevcontainersConfig`](./types.md#devcontainersconfig))
16
-
- Displaying a link to launch the repo in a devcontainer via VS Code.
15
+
- Detecting whether the current repo entity being viewed supports has been tagged with the configured Dev Containers tag (as defined by the config options in [`DevcontainersConfig`](./types.md#devcontainersconfig))
16
+
- Displaying a link to launch the repo in a Dev Container via VS Code.
Copy file name to clipboardExpand all lines: plugins/backstage-plugin-devcontainers-react/docs/types.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
## General notes
4
4
5
-
- All type definitions for the Devcontainer plugin are defined as type aliases and not interfaces, to prevent the risk of accidental interface merging. If you need to extend from one of our types, you can do it in one of two ways:
5
+
- All type definitions for the Dev Containers plugin are defined as type aliases and not interfaces, to prevent the risk of accidental interface merging. If you need to extend from one of our types, you can do it in one of two ways:
6
6
7
7
```tsx
8
8
// Type intersection
@@ -22,7 +22,7 @@
22
22
23
23
## `DevcontainersConfig`
24
24
25
-
Defines a set of configuration options for setting how the frontend detects whether a repo entity supports the devcontainers spec.
25
+
Defines a set of configuration options for setting how the frontend detects whether a repo entity supports the Dev Containers spec.
0 commit comments