diff --git a/contrib/plugins/README.md b/contrib/plugins/README.md deleted file mode 100644 index 8fa0fecf0a..0000000000 --- a/contrib/plugins/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# Plugin contributions - -Plugins in this directory are for demonstrative purposes, like documentation and tutorials. Refer to the READMEs provided by each plugin for more details. diff --git a/docs/permission/plugin-authors/01-setup.md b/docs/permission/plugin-authors/01-setup.md index 7011f52676..77dc67fd83 100644 --- a/docs/permission/plugin-authors/01-setup.md +++ b/docs/permission/plugin-authors/01-setup.md @@ -14,18 +14,18 @@ We will use a "Todo list" feature, composed of the `todo-list` and `todo-list-ba The source code is available here: -- [todo-list](https://github.com/backstage/backstage/blob/master/contrib/plugins/todo-list) -- [todo-list-backend](https://github.com/backstage/backstage/blob/master/contrib/plugins/todo-list-backend) -- [todo-list-common](https://github.com/backstage/backstage/blob/master/contrib/plugins/todo-list-common) +- [todo-list](https://github.com/backstage/backstage/blob/master/plugins/example-todo-list) +- [todo-list-backend](https://github.com/backstage/backstage/blob/master/plugins/example-todo-list-backend) +- [todo-list-common](https://github.com/backstage/backstage/blob/master/plugins/todo-list-common) 1. Copy-paste the three folders into the plugins folder of your backstage application repository or run the following script from the root of your backstage application: ```bash $ curl https://codeload.github.com/backstage/backstage/zip/refs/heads/master | \ tar -C plugins --strip-components=1 -xv \ - backstage-master/contrib/plugins/todo-list \ - backstage-master/contrib/plugins/todo-list-backend \ - backstage-master/contrib/plugins/todo-list-common + backstage-master/plugins/example-todo-list \ + backstage-master/plugins/example-todo-list-backend \ + backstage-master/plugins/example-todo-list-common ``` The `plugins` directory of your project should now include `todo-list`, `todo-list-backend`, and `todo-list-common`. diff --git a/contrib/plugins/todo-list-backend/.eslintrc.js b/plugins/example-todo-list-backend/.eslintrc.js similarity index 100% rename from contrib/plugins/todo-list-backend/.eslintrc.js rename to plugins/example-todo-list-backend/.eslintrc.js diff --git a/contrib/plugins/todo-list-backend/README.md b/plugins/example-todo-list-backend/README.md similarity index 100% rename from contrib/plugins/todo-list-backend/README.md rename to plugins/example-todo-list-backend/README.md diff --git a/contrib/plugins/todo-list-backend/package.json b/plugins/example-todo-list-backend/package.json similarity index 76% rename from contrib/plugins/todo-list-backend/package.json rename to plugins/example-todo-list-backend/package.json index 614f5520af..17c6d49057 100644 --- a/contrib/plugins/todo-list-backend/package.json +++ b/plugins/example-todo-list-backend/package.json @@ -20,12 +20,12 @@ "clean": "backstage-cli clean" }, "dependencies": { - "@backstage/backend-common": "^0.10.7", - "@backstage/config": "^0.1.13", - "@backstage/errors": "^0.2.0", - "@backstage/plugin-auth-node": "^0.1.0", - "@types/express": "*", - "cross-fetch": "^3.0.6", + "@backstage/backend-common": "^0.13.2-next.1", + "@backstage/config": "^1.0.0", + "@backstage/errors": "^1.0.0", + "@backstage/plugin-auth-node": "^0.2.0-next.0", + "@types/express": "^4.17.6", + "cross-fetch": "^3.1.5", "express": "^4.17.1", "express-promise-router": "^4.1.0", "uuid": "^8.3.2", @@ -33,7 +33,7 @@ "yn": "^4.0.0" }, "devDependencies": { - "@backstage/cli": "^0.13.2", + "@backstage/cli": "^0.17.0-next.1", "@types/supertest": "^2.0.8", "@types/uuid": "^8.0.0", "msw": "^0.35.0", diff --git a/contrib/plugins/todo-list-backend/src/index.ts b/plugins/example-todo-list-backend/src/index.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/index.ts rename to plugins/example-todo-list-backend/src/index.ts diff --git a/contrib/plugins/todo-list-backend/src/run.ts b/plugins/example-todo-list-backend/src/run.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/run.ts rename to plugins/example-todo-list-backend/src/run.ts diff --git a/contrib/plugins/todo-list-backend/src/service/router.test.ts b/plugins/example-todo-list-backend/src/service/router.test.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/service/router.test.ts rename to plugins/example-todo-list-backend/src/service/router.test.ts diff --git a/contrib/plugins/todo-list-backend/src/service/router.ts b/plugins/example-todo-list-backend/src/service/router.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/service/router.ts rename to plugins/example-todo-list-backend/src/service/router.ts diff --git a/contrib/plugins/todo-list-backend/src/service/standaloneServer.ts b/plugins/example-todo-list-backend/src/service/standaloneServer.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/service/standaloneServer.ts rename to plugins/example-todo-list-backend/src/service/standaloneServer.ts diff --git a/contrib/plugins/todo-list-backend/src/service/todos.ts b/plugins/example-todo-list-backend/src/service/todos.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/service/todos.ts rename to plugins/example-todo-list-backend/src/service/todos.ts diff --git a/contrib/plugins/todo-list-backend/src/setupTests.ts b/plugins/example-todo-list-backend/src/setupTests.ts similarity index 100% rename from contrib/plugins/todo-list-backend/src/setupTests.ts rename to plugins/example-todo-list-backend/src/setupTests.ts diff --git a/contrib/plugins/todo-list-common/.eslintrc.js b/plugins/example-todo-list-common/.eslintrc.js similarity index 100% rename from contrib/plugins/todo-list-common/.eslintrc.js rename to plugins/example-todo-list-common/.eslintrc.js diff --git a/contrib/plugins/todo-list-common/README.md b/plugins/example-todo-list-common/README.md similarity index 100% rename from contrib/plugins/todo-list-common/README.md rename to plugins/example-todo-list-common/README.md diff --git a/contrib/plugins/todo-list-common/package.json b/plugins/example-todo-list-common/package.json similarity index 97% rename from contrib/plugins/todo-list-common/package.json rename to plugins/example-todo-list-common/package.json index 6ea0334388..e6220c878b 100644 --- a/contrib/plugins/todo-list-common/package.json +++ b/plugins/example-todo-list-common/package.json @@ -36,7 +36,7 @@ "@backstage/core-app-api": "^1.0.1-next.0", "@backstage/dev-utils": "^1.0.1-next.0", "@backstage/test-utils": "^1.0.1-next.1", - "@types/node": "*", + "@types/node": "^14.14.32", "msw": "^0.35.0", "cross-fetch": "^3.1.5" }, diff --git a/contrib/plugins/todo-list-common/src/index.ts b/plugins/example-todo-list-common/src/index.ts similarity index 100% rename from contrib/plugins/todo-list-common/src/index.ts rename to plugins/example-todo-list-common/src/index.ts diff --git a/contrib/plugins/todo-list-common/src/permissions.ts b/plugins/example-todo-list-common/src/permissions.ts similarity index 100% rename from contrib/plugins/todo-list-common/src/permissions.ts rename to plugins/example-todo-list-common/src/permissions.ts diff --git a/contrib/plugins/todo-list/.eslintrc.js b/plugins/example-todo-list/.eslintrc.js similarity index 100% rename from contrib/plugins/todo-list/.eslintrc.js rename to plugins/example-todo-list/.eslintrc.js diff --git a/contrib/plugins/todo-list/README.md b/plugins/example-todo-list/README.md similarity index 100% rename from contrib/plugins/todo-list/README.md rename to plugins/example-todo-list/README.md diff --git a/contrib/plugins/todo-list/package.json b/plugins/example-todo-list/package.json similarity index 67% rename from contrib/plugins/todo-list/package.json rename to plugins/example-todo-list/package.json index 74fa881803..5cf6959383 100644 --- a/contrib/plugins/todo-list/package.json +++ b/plugins/example-todo-list/package.json @@ -21,9 +21,9 @@ "clean": "backstage-cli clean" }, "dependencies": { - "@backstage/core-components": "^0.8.8", - "@backstage/core-plugin-api": "^0.6.0", - "@backstage/theme": "^0.2.14", + "@backstage/core-components": "^0.9.3-next.0", + "@backstage/core-plugin-api": "^1.0.0", + "@backstage/theme": "^0.2.15", "@material-ui/core": "^4.12.2", "@material-ui/icons": "^4.9.1", "@material-ui/lab": "4.0.0-alpha.57", @@ -33,15 +33,15 @@ "react": "^16.13.1 || ^17.0.0" }, "devDependencies": { - "@backstage/cli": "^0.13.2", - "@backstage/core-app-api": "^0.5.2", - "@backstage/dev-utils": "^0.2.21", - "@backstage/test-utils": "^0.2.4", + "@backstage/cli": "^0.17.0-next.1", + "@backstage/core-app-api": "^1.0.1-next.0", + "@backstage/dev-utils": "^1.0.1-next.0", + "@backstage/test-utils": "^1.0.1-next.1", "@testing-library/jest-dom": "^5.10.1", - "@testing-library/react": "^11.2.5", - "@testing-library/user-event": "^13.1.8", - "@types/jest": "*", - "@types/node": "*", + "@testing-library/react": "^12.1.3", + "@testing-library/user-event": "^14.0.0", + "@types/jest": "^26.0.7", + "@types/node": "^14.14.32", "msw": "^0.35.0" }, "files": [ diff --git a/contrib/plugins/todo-list/src/components/TodoList/TodoList.tsx b/plugins/example-todo-list/src/components/TodoList/TodoList.tsx similarity index 100% rename from contrib/plugins/todo-list/src/components/TodoList/TodoList.tsx rename to plugins/example-todo-list/src/components/TodoList/TodoList.tsx diff --git a/contrib/plugins/todo-list/src/components/TodoList/index.ts b/plugins/example-todo-list/src/components/TodoList/index.ts similarity index 100% rename from contrib/plugins/todo-list/src/components/TodoList/index.ts rename to plugins/example-todo-list/src/components/TodoList/index.ts diff --git a/contrib/plugins/todo-list/src/components/TodoListPage/TodoListPage.tsx b/plugins/example-todo-list/src/components/TodoListPage/TodoListPage.tsx similarity index 100% rename from contrib/plugins/todo-list/src/components/TodoListPage/TodoListPage.tsx rename to plugins/example-todo-list/src/components/TodoListPage/TodoListPage.tsx diff --git a/contrib/plugins/todo-list/src/components/TodoListPage/index.ts b/plugins/example-todo-list/src/components/TodoListPage/index.ts similarity index 100% rename from contrib/plugins/todo-list/src/components/TodoListPage/index.ts rename to plugins/example-todo-list/src/components/TodoListPage/index.ts diff --git a/contrib/plugins/todo-list/src/index.ts b/plugins/example-todo-list/src/index.ts similarity index 100% rename from contrib/plugins/todo-list/src/index.ts rename to plugins/example-todo-list/src/index.ts diff --git a/contrib/plugins/todo-list/src/plugin.test.ts b/plugins/example-todo-list/src/plugin.test.ts similarity index 100% rename from contrib/plugins/todo-list/src/plugin.test.ts rename to plugins/example-todo-list/src/plugin.test.ts diff --git a/contrib/plugins/todo-list/src/plugin.ts b/plugins/example-todo-list/src/plugin.ts similarity index 100% rename from contrib/plugins/todo-list/src/plugin.ts rename to plugins/example-todo-list/src/plugin.ts diff --git a/contrib/plugins/todo-list/src/routes.ts b/plugins/example-todo-list/src/routes.ts similarity index 100% rename from contrib/plugins/todo-list/src/routes.ts rename to plugins/example-todo-list/src/routes.ts diff --git a/contrib/plugins/todo-list/src/setupTests.ts b/plugins/example-todo-list/src/setupTests.ts similarity index 100% rename from contrib/plugins/todo-list/src/setupTests.ts rename to plugins/example-todo-list/src/setupTests.ts