Skip to content

Commit 200ee00

Browse files
authored
remove match from docs (#1591)
1 parent 66ae207 commit 200ee00

File tree

1 file changed

+4
-10
lines changed

1 file changed

+4
-10
lines changed

docs/app/docs/guides/creating_plugins.md

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Before contributing, please consult our [Contributing Guide](https://github.com/
1414

1515
## Creating a Plugin
1616

17-
We recommend organizing your plugin with the following directory structure, where the top-level folder matches the name of your plugin:
17+
We recommend organizing your plugin with the following directory structure, where the top-level folder matches the name of your plugin:
1818

1919
```
2020
my-plugin/
@@ -98,12 +98,6 @@ The name of your plugin. This is used to identify your plugin when a user runs `
9898

9999
The version of your plugin. You should start your version at 0.0.1 and bump it whenever you merge an update to the plugin.
100100

101-
#### `match` *string*
102-
103-
A regex expression that is used to identify when the plugin will be activated. Devbox will activate your plugin when a package installed with `devbox add` matches this regular expression.
104-
105-
The regex you provide should match a package name to automatically update. You can look up packages at `nixhub.io`
106-
107101
#### `readme` *string*
108102

109103
Special usage instructions or notes to display when your plugin activates or when a user runs `devbox info`. You do not need to document variables, helper files, or services, since these are automatically printed when a user runs `devbox info`.
@@ -128,7 +122,7 @@ You should use this to copy starter config files or templates needed to run the
128122

129123
#### `shell.init_hook` *string | string[]*
130124

131-
A single `bash` command or list of `bash` commands that should run before the user's shell is initialized.
125+
A single `bash` command or list of `bash` commands that should run before the user's shell is initialized.
132126

133127
This will run every time a shell is started, so you should avoid any resource heavy or long running processes in this step.
134128

@@ -145,15 +139,15 @@ See the process compose [docs](https://github.com/F1bonacc1/process-compose) for
145139
Testing plugins can be done using an example Devbox project. Follow the steps below to create a new test project
146140

147141
1. Create a new `devbox.json` in an empty directory using `devbox init`.
148-
2. Add your plugin to the `include` section of the `devbox.json` file.
142+
2. Add your plugin to the `include` section of the `devbox.json` file.
149143
2. Add any expected packages using `devbox add <pkg>`.
150144
3. Check that your plugin creates the correct files and environment variables when running `devbox shell`
151145
4. If you are looking for sample projects to test your plugin with, check out our [examples](https://github.com/jetpack-io/devbox/tree/main/examples).
152146

153147

154148
## Example: MongoDB
155149

156-
The plugin.json below sets the environment variables and config needed to run MongoDB in Devbox. You can view the full example at
150+
The plugin.json below sets the environment variables and config needed to run MongoDB in Devbox. You can view the full example at
157151

158152
```json
159153
{

0 commit comments

Comments
 (0)