From 4a5e5b025d80693be718151ed07c3f6c12bb000e Mon Sep 17 00:00:00 2001 From: Kashish Mittal Date: Wed, 23 Oct 2024 13:53:30 -0400 Subject: [PATCH] update docs Signed-off-by: Kashish Mittal --- CONTRIBUTING.md | 6 +++--- README.md | 2 +- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1e8a9ae17..1630a2c99 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -220,10 +220,10 @@ cp -r ../existing-plugins/plugins/plugin-name plugins/ yarn rhdh-cli janus-plugin migrate --monorepo-path ../backstage-plugins --workspace-name workspace-name --branch deprecate-workspace-name --maintainers @maintainer1,@maintainer2,@maintainer3 ``` -3. > [!Important] - > This script updates metadata commonly found across all plugins. Please review your migrated plugins to ensure that all references to "janus" have been updated to point to "rhdh-plugins." +3. The script will generate changesets in both repositories. Be sure to commit these changes and open pull requests. - The script will generate changesets in both repositories. Be sure to commit these changes and open pull requests. +> [!IMPORTANT] +> This script updates metadata commonly found across all plugins. Please review your migrated plugins to ensure that all references to "janus" have been updated to point to "rhdh-plugins." 4. If you run into CI issues take a look at [this github gist](https://gist.github.com/Fortune-Ndlovu/1562789f3905b4fe818b9079a3032982) which outlines the process taken to migrate argocd plugins in great detail. diff --git a/README.md b/README.md index 5adbc6d7b..ad0ad8a97 100644 --- a/README.md +++ b/README.md @@ -15,4 +15,4 @@ Contributions are welcome! To contribute a plugin, please follow the guidelines ## Plugins Workflow -The rhdh-plugins repository is organized into multiple workspaces, with each workspace containing a plugin or a set of related plugins. Each workspace operates independently, with its own release cycle and dependencies managed via npm. When a new changeset is added (each workspace has its own .changesets directory), a "Version packages ($workspace_name)" PR is automatically generated. Merging this PR triggers the release of all plugins in the workspace and updates the corresponding CHANGELOG files. +The `rhdh-plugins` repository is organized into multiple workspaces, with each workspace containing a plugin or a set of related plugins. Each workspace operates independently, with its own release cycle and dependencies managed via npm. When a new changeset is added (each workspace has its own `.changesets` directory), a "Version packages ($workspace_name)" PR is automatically generated. Merging this PR triggers the release of all plugins in the workspace and updates the corresponding `CHANGELOG` files.