Skip to content

Commit 9f72f71

Browse files
authored
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
1 parent 0748359 commit 9f72f71

File tree

11 files changed

+28
-28
lines changed

11 files changed

+28
-28
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ A collection of plugins that extend [Backstage](https://backstage.io) to help wi
44

55
- [backstage-plugin-coder](./plugins/backstage-plugin-coder/README.md): A plugin for integrating Coder workspaces with Backstage.
66
- [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).
88

99
Please use [GitHub issues](https://github.com/coder/backstage-plugins/issues) to report any issues or feature requests.
1010

plugins/backstage-plugin-coder/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This assumes you already have a [Coder](https://github.com/coder/coder) deployme
2323
Replace `https://coder.example.com` with your Coder deployment access URL. This also assumes
2424
you have a template that has a parameter for a git repository URL (e.g. `git_repo_url`) that auto-clones
2525
the repository or uses [envbuilder](https://coder.com/docs/v2/latest/templates/devcontainers) to build
26-
the devcontainer.
26+
the Dev Container.
2727

2828
1. If you have a standalone Backstage app (you didn't clone this repo), then do
2929

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# @coder/backstage-plugin-devcontainers-backend
22

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!
44

55
## Screenshots
66

@@ -17,7 +17,7 @@ _Note: While this plugin can be used standalone, it has been designed to be a ba
1717

1818
### When combined with the frontend plugin
1919

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
2121

2222
## Setup
2323

@@ -81,7 +81,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
8181
}
8282
```
8383

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))
8585

8686
Full example:
8787

@@ -125,9 +125,9 @@ export default async function createPlugin(
125125

126126
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.
127127

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).
129129

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.
131131

132132
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!
133133

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Reference – backstage-plugin-devcontainers-backend
22

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

55
## Documentation directory
66

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Plugin API reference - classes
22

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`:
44

55
## Class list
66

@@ -82,7 +82,7 @@ export default async function createPlugin(
8282
- If the value of `tagName` is not specified for `fromConfig`, the class will default to the value `devcontainers`
8383
- The appending/removal process for tags works as follows:
8484
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.
8686
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
8787
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.
8888
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.

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ _Note: While this plugin can be used standalone, it has been designed to be a fr
1414

1515
### Standalone features
1616

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
1818

1919
### When combined with the backend plugin
2020

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
2222

2323
## Setup
2424

@@ -29,7 +29,7 @@ This section will walk you through adding the plugin to your Backstage deploymen
2929
Ensure that you have the following ready to go:
3030

3131
- 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)
3333
- [Docker](https://docs.docker.com/get-docker/) installed and running locally on your machine
3434

3535
_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
6666

6767
<Grid item md={6} xs={12}>
6868
<DevcontainersProvider config={devcontainersConfig}>
69-
{/* Content that uses Devcontainers goes here */}
69+
{/* Content that uses Dev Containers goes here */}
7070
</DevcontainersProvider>
7171
</Grid>
7272

@@ -77,7 +77,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
7777
);
7878
```
7979

80-
4. If you are trying out the devcontainers functionality, we provide a pre-made `ExampleDevcontainersComponent`. You can include it like so:
80+
4. If you are trying out the Dev Containers functionality, we provide a pre-made `ExampleDevcontainersComponent`. You can include it like so:
8181

8282
```tsx
8383
// Update imports
@@ -108,11 +108,11 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
108108
return (
109109
{state.hasUrl ? (
110110
<>
111-
<p>Your entity supports devcontainers!</p>
111+
<p>Your entity supports Dev Containers!</p>
112112
<a href={state.vsCodeUrl}>Click here to launch VS Code</a>
113113
</>
114114
) : (
115-
<p>No devcontainers plugin tag detected</p>
115+
<p>No Dev Containers plugin tag detected</p>
116116
)}
117117
);
118118
};
@@ -123,7 +123,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
123123
</DevcontainersProvider>;
124124
```
125125

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.
127127

128128
Have an idea for what kinds of components you would like to see? Feel free to open an issue and make a feature request!
129129

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# API Reference – backstage-plugin-devcontainers-react
22

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

55
## Documentation directory
66

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ This component is designed as a lightweight demonstration of the main [`useDevco
1212

1313
Its main functionality is:
1414

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.
1717

1818
It does not have support for extensibility.
1919

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This is the main documentation page for the frontend Devcontainer plugin's React
88

99
## `useDevcontainers`
1010

11-
This hook gives you access to a set of properties that describe whether the currently-viewed entity has devcontainers data.
11+
This hook gives you access to a set of properties that describe whether the currently-viewed entity has Dev Containers data.
1212

1313
### Type signature
1414

@@ -31,11 +31,11 @@ const YourComponent = () => {
3131
return (
3232
{state.hasUrl ? (
3333
<>
34-
<p>Your entity supports devcontainers!</p>
34+
<p>Your entity supports Dev Containers!</p>
3535
<a href={state.vsCodeUrl}>Click here to launch VS Code</a>
3636
</>
3737
) : (
38-
<p>No devcontainers plugin tag detected</p>
38+
<p>No Dev Containers plugin tag detected</p>
3939
)}
4040
);
4141
};

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

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

33
## General notes
44

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:
66

77
```tsx
88
// Type intersection
@@ -22,7 +22,7 @@
2222

2323
## `DevcontainersConfig`
2424

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.
2626

2727
### Type definition
2828

plugins/backstage-plugin-devcontainers-react/src/components/ExampleDevcontainersComponent/ExampleDevcontainersComponent.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,14 +29,14 @@ export const ExampleDevcontainersComponent = () => {
2929

3030
{state.hasUrl ? (
3131
<>
32-
<p>Your entity supports devcontainers!</p>
32+
<p>Your entity supports Dev Containers!</p>
3333
<a href={state.vsCodeUrl} className={styles.link}>
3434
Click here to launch VSCode
3535
<VisuallyHidden> (link opens in new tab)</VisuallyHidden>
3636
</a>
3737
</>
3838
) : (
39-
<p>No devcontainers plugin tag detected</p>
39+
<p>No Dev Containers plugin tag detected</p>
4040
)}
4141
</InfoCard>
4242
);

0 commit comments

Comments
 (0)