Skip to content

Commit

Permalink
Docs: Fix warnings about nested link tags in build logs (#1436)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackw authored Jan 8, 2025
1 parent ed6b87d commit 25d9605
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
14 changes: 7 additions & 7 deletions docusaurus/docs/shared/create-plugin-backend.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
The Grafana [create-plugin tool](https://www.npmjs.com/package/@grafana/create-plugin) is a CLI application that simplifies Grafana plugin development, so that you can focus on code. The tool scaffolds a starter plugin, all the required configuration, and a development environment using [Docker Compose](https://docs.docker.com/compose/) for you.

1. <span>In a new directory, create a plugin from a template using the create-plugin tool. When prompted for the kind of plugin, select {props.pluginType}</span> and answer yes to "Do you want a backend part of your plugin?":
1. In a new directory, create a plugin from a template using the create-plugin tool. When prompted for the kind of plugin, select {props.pluginType} and answer yes to "Do you want a backend part of your plugin?":

```shell
npx @grafana/create-plugin@latest
```

1. Go to the directory of your newly created plugin:
2. Go to the directory of your newly created plugin:

```shell
cd <your-plugin>
```

1. Install the dependencies:
3. Install the dependencies:

```shell
npm install
```

1. Build the plugin frontend:
4. Build the plugin frontend:

```shell
npm run dev
```

1. In a new terminal window, build the plugin backend:
5. In a new terminal window, build the plugin backend:

```shell
mage -v build:linux
```

1. Start Grafana:
6. Start Grafana:

```shell
docker compose up
```

1. <span>Open Grafana, by default <a href="http://localhost:3000/">http://localhost:3000/</a>, and then go to <b>Administration</b> > <b>Plugins</b>. Make sure that your {props.pluginType} plugin is there.</span>
7. Open Grafana, by default [http://localhost:3000](http://localhost:3000), and then go to **Administration** > **Plugins**. Make sure that your {props.pluginType} plugin is there.

You can also verify that Grafana has discovered the plugin by checking the logs:

Expand Down
12 changes: 6 additions & 6 deletions docusaurus/docs/shared/create-plugin-frontend.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,36 @@
The Grafana [create-plugin tool](https://www.npmjs.com/package/@grafana/create-plugin) is a CLI application that simplifies Grafana plugin development, so that you can focus on code. The tool scaffolds a starter plugin, all the required configuration, and a development environment using [Docker Compose](https://docs.docker.com/compose/) for you.

1. <span>In a new directory, create a plugin from a template using the create-plugin tool. When prompted for the kind of plugin, select {props.pluginType}</span>:
1. In a new directory, create a plugin from a template using the create-plugin tool. When prompted for the kind of plugin, select {props.pluginType}:

```shell
npx @grafana/create-plugin@latest
```

1. Go to the directory of your newly created plugin:
2. Go to the directory of your newly created plugin:

```shell
cd <your-plugin>
```

1. Install the dependencies:
3. Install the dependencies:

```shell
npm install
```

1. Build the plugin:
4. Build the plugin:

```shell
npm run dev
```

1. Start Grafana:
5. Start Grafana:

```shell
docker compose up
```

1. <span>Open Grafana, by default <a href="http://localhost:3000/">http://localhost:3000/</a>, and then go to <b>Administration</b> > <b>Plugins</b>. Make sure that your {props.pluginType} plugin is there.</span>
6. Open Grafana, by default [http://localhost:3000](http://localhost:3000), and then go to **Administration** > **Plugins**. Make sure that your {props.pluginType} plugin is there.

You can also verify that Grafana has discovered your plugin by checking the logs:

Expand Down

0 comments on commit 25d9605

Please sign in to comment.