Skip to content

remove mentions to legacy tags from official extension docs as legacy versions are deprecated #16066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aalves08 merged 1 commit into from
Dec 9, 2025
Merged

remove mentions to legacy tags from official extension docs as legacy versions are deprecated #16066

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 1 addition & 40 deletions docusaurus/docs/extensions/extensions-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ For an easy follow of this guide, there is two different concepts that a develop
> Note: Extensions development is only currently supported on Mac and Linux. Windows is not currently supported.

- **Node.js Version:**
- For **legacy-v1** or **legacy-v2**, you will need Node.js **version `v16`** (tested with `v16.19.1`).
- For the latest version, you will need Node.js **version `v20`** (tested with `v20.17.0`).
- Yarn package manager installed globally: `npm install -g yarn`.
- Have a Rancher system up and running. See https://ranchermanager.docs.rancher.com/getting-started/installation-and-upgrade
Expand All @@ -26,8 +25,6 @@ Rancher publishes a single npm package, `@rancher/extension`, to help bootstrap

When creating extensions, it is important to match the version of the `@rancher/extension` package with the target Rancher version:

- **For Rancher `v2.7` and `v2.8`:** Use the `legacy-v1` tag.
- **For Rancher `v2.9`:** Use the `legacy-v2` tag.
- **For Rancher `v2.10` or later:** Use the `latest` version of `@rancher/extension`.

> Note: The development app references the Rancher dashboard code via the `@rancher/shell` npm module. Each version is bound to different Rancher versions. You can check the `shell` support matrix **[here](./support-matrix.md)**.
Expand All @@ -51,49 +48,13 @@ npm init @rancher/extension@latest another-extension

> NOTE: the `npm init` command must always use the same tag as the one that generated it. Also check examples below.

### Usage for `legacy` versions

> Note: The documentation for these legacy versions

**For Rancher `v2.7` and `v2.8`**

To target these versions, use the `legacy-v1` tag:

```sh
npm init @rancher/extension@legacy-v1 my-app
cd my-app && yarn install
```

If you want want to add another `extension` inside the same development app, you'll need to be inside the root folder of the development app and just run the init command with the desired name for the other extension:

```sh
npm init @rancher/extension@legacy-v1 another-extension
```

**For Rancher `v2.9`:**

To target this version, use the `legacy-v2` tag:

```sh
npm init @rancher/extension@legacy-v2 my-app
cd my-app && yarn install
```

If you want want to add another `extension` inside the same development app, you'll need to be inside the root folder of the development app and just run the init command with the desired name for the other extension:

```sh
npm init @rancher/extension@legacy-v2 another-extension
```

In both legacy cases, ensure you are using Node.js version `v16` during development and testing.

### _Extension Options_

There are a few options available to be passed as an argument to the `@rancher/extension` script:

| Option | Description |
| :-----------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--update \| -u` | This will update all dependencies within the extension to match the declared version of the `@rancher/shell` library based on the tag. See the [Updating Guide](./updating-extensions.md) for usage. |
| `--update \| -u` | This will update all dependencies within the extension to match the declared version of the `@rancher/shell` library based on the tag. |
| `--app-name \| -a <name>` | Allows specifying a different name for the development app instead of using the extension name. |
| `--skeleton-only \| -s` | Installs only the development app without creating the extension package. |
| `-l` | This will automatically add the [`.gitlab-ci.yml`](https://github.com/rancher/dashboard/blob/master/creators/extension/app/files/.gitlab-ci.yml) pipeline file for integration with GitLab |
Expand Down
81 changes: 0 additions & 81 deletions docusaurus/docs/extensions/updating-extensions.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docusaurus/extensionSidebar.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,6 @@ const sidebars = {
'usecases/node-driver'
]
},
'updating-extensions',
'known-issues',
]
},
Expand Down
2 changes: 1 addition & 1 deletion docusaurus/extensions_versioned_docs/version-v2/extensions-getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ There are a few options available to be passed as an argument to the `@rancher/e

| Option | Description |
| :-----------------------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--update \| -u` | This will update all dependencies within the extension to match the declared version of the `@rancher/shell` library based on the tag. See the [Updating Guide](./updating-extensions.md) for usage. |
| `--update \| -u` | This will update all dependencies within the extension to match the declared version of the `@rancher/shell` library based on the tag. |
| `--app-name \| -a <name>` | Allows specifying a different name for the skeleton application instead of using the extension name. |
| `--skeleton-only \| -s` | Installs only the skeleton application without creating the extension package. |
| `-l` | This will automatically add the [`.gitlab-ci.yml`](https://github.com/rancher/dashboard/blob/master/creators/extension/app/files/.gitlab-ci.yml) pipeline file for integration with GitLab |
Expand Down