Skip to content

Commit

Permalink
fix: Update branding for "dev containers" for all documentation (#31)
Browse files Browse the repository at this point in the history
* 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
  • Loading branch information
Parkreiner authored Mar 14, 2024
1 parent 0748359 commit 9f72f71
Show file tree
Hide file tree
Showing 11 changed files with 28 additions and 28 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ A collection of plugins that extend [Backstage](https://backstage.io) to help wi

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

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

Expand Down
2 changes: 1 addition & 1 deletion plugins/backstage-plugin-coder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This assumes you already have a [Coder](https://github.com/coder/coder) deployme
Replace `https://coder.example.com` with your Coder deployment access URL. This also assumes
you have a template that has a parameter for a git repository URL (e.g. `git_repo_url`) that auto-clones
the repository or uses [envbuilder](https://coder.com/docs/v2/latest/templates/devcontainers) to build
the devcontainer.
the Dev Container.

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

Expand Down
10 changes: 5 additions & 5 deletions plugins/backstage-plugin-devcontainers-backend/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# @coder/backstage-plugin-devcontainers-backend

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

## Screenshots

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

### When combined with the frontend plugin

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

## Setup

Expand Down Expand Up @@ -81,7 +81,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
}
```

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

Full example:

Expand Down Expand Up @@ -125,9 +125,9 @@ export default async function createPlugin(

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.

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

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

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!

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Reference – backstage-plugin-devcontainers-backend

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

## Documentation directory

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Plugin API reference - classes

This is the main documentation page for the Devcontainer plugin's exported classes.
This is the main documentation page for the exported classes for `backstage-plugin-devcontainers-backkend`:

## Class list

Expand Down Expand Up @@ -82,7 +82,7 @@ export default async function createPlugin(
- If the value of `tagName` is not specified for `fromConfig`, the class will default to the value `devcontainers`
- The appending/removal process for tags works as follows:
1. An entity provider re-validates its data and ingests a new entity
2. The processor will run a pre-process step to determine if the devcontainers tag (which defaults to `devcontainers`) should be added.
2. The processor will run a pre-process step to determine if the Dev Containers tag (which defaults to `devcontainers`) should be added.
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
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.
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.
16 changes: 8 additions & 8 deletions plugins/backstage-plugin-devcontainers-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,11 @@ _Note: While this plugin can be used standalone, it has been designed to be a fr

### Standalone features

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

### When combined with the backend plugin

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

## Setup

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

- A Backstage deployment that you can modify
- 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)
- 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)
- [Docker](https://docs.docker.com/get-docker/) installed and running locally on your machine

_Note: While this plugin has been developed and published by Coder, no Coder installations are required._
Expand Down Expand Up @@ -66,7 +66,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins

<Grid item md={6} xs={12}>
<DevcontainersProvider config={devcontainersConfig}>
{/* Content that uses Devcontainers goes here */}
{/* Content that uses Dev Containers goes here */}
</DevcontainersProvider>
</Grid>

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

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

```tsx
// Update imports
Expand Down Expand Up @@ -108,11 +108,11 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
return (
{state.hasUrl ? (
<>
<p>Your entity supports devcontainers!</p>
<p>Your entity supports Dev Containers!</p>
<a href={state.vsCodeUrl}>Click here to launch VS Code</a>
</>
) : (
<p>No devcontainers plugin tag detected</p>
<p>No Dev Containers plugin tag detected</p>
)}
);
};
Expand All @@ -123,7 +123,7 @@ _Note: While this plugin has been developed and published by Coder, no Coder ins
</DevcontainersProvider>;
```

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# API Reference – backstage-plugin-devcontainers-react

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

## Documentation directory

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ This component is designed as a lightweight demonstration of the main [`useDevco

Its main functionality is:

- 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))
- Displaying a link to launch the repo in a devcontainer via VS Code.
- 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))
- Displaying a link to launch the repo in a Dev Container via VS Code.

It does not have support for extensibility.

Expand Down
6 changes: 3 additions & 3 deletions plugins/backstage-plugin-devcontainers-react/docs/hooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This is the main documentation page for the frontend Devcontainer plugin's React

## `useDevcontainers`

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

### Type signature

Expand All @@ -31,11 +31,11 @@ const YourComponent = () => {
return (
{state.hasUrl ? (
<>
<p>Your entity supports devcontainers!</p>
<p>Your entity supports Dev Containers!</p>
<a href={state.vsCodeUrl}>Click here to launch VS Code</a>
</>
) : (
<p>No devcontainers plugin tag detected</p>
<p>No Dev Containers plugin tag detected</p>
)}
);
};
Expand Down
4 changes: 2 additions & 2 deletions plugins/backstage-plugin-devcontainers-react/docs/types.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## General notes

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

```tsx
// Type intersection
Expand All @@ -22,7 +22,7 @@

## `DevcontainersConfig`

Defines a set of configuration options for setting how the frontend detects whether a repo entity supports the devcontainers spec.
Defines a set of configuration options for setting how the frontend detects whether a repo entity supports the Dev Containers spec.

### Type definition

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,14 @@ export const ExampleDevcontainersComponent = () => {

{state.hasUrl ? (
<>
<p>Your entity supports devcontainers!</p>
<p>Your entity supports Dev Containers!</p>
<a href={state.vsCodeUrl} className={styles.link}>
Click here to launch VSCode
<VisuallyHidden> (link opens in new tab)</VisuallyHidden>
</a>
</>
) : (
<p>No devcontainers plugin tag detected</p>
<p>No Dev Containers plugin tag detected</p>
)}
</InfoCard>
);
Expand Down

0 comments on commit 9f72f71

Please sign in to comment.