update default web-library files

Signed-off-by: Kurt King <kurt.king@procore.com> Signed-off-by: Kurt King <kurtaking@gmail.com>
2022-12-06 07:49:16 -06:00
parent b063ad50c2
commit b028a2a228
10 changed files with 81 additions and 42 deletions
@@ -1,14 +1,12 @@
 # {{id}}

-Welcome to the {{id}} web-library plugin!
+_This package was created through the Backstage CLI_.

-_This plugin was created through the Backstage CLI_
+## Installation

-## Getting started
+Install the package via Yarn:

-Your plugin has been added to the example app in this repository, meaning you'll be able to access it by running `yarn
-start` in the root directory, and then navigating to [/{{id}}](http://localhost:3000/{{id}}).
-
-You can also serve the plugin in isolation by running `yarn start` in the plugin directory.
-This method of serving the plugin provides quicker iteration speed and a faster startup and hot reloads.
-It is only meant for local development, and the setup for it can be found inside the [/dev](./dev) directory.
+```sh
+cd <package-dir> # if within a monorepo
+  yarn add @internal/{{id}}
+  ```
@@ -1 +1,23 @@
-export { {{ pluginVar }}, {{ extensionName }} } from './plugin';
+/*
+* Copyright 2020 The Backstage Authors
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+* http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+/**
+* Core API used by Backstage plugins
+*
+* @packageDocumentation
+*/
+
+// export as needed from this file
@@ -1,7 +0,0 @@
-import { {{ pluginVar }} } from './plugin';
-
-describe('{{ id }}', () => {
-  it('should export plugin', () => {
-    expect({{ pluginVar }}).toBeDefined();
-  });
-});
@@ -1,19 +0,0 @@
-import { createPlugin, createRoutableExtension } from '@backstage/core-plugin-api';
-
-import { rootRouteRef } from './routes';
-
-export const {{ pluginVar }} = createPlugin({
-  id: '{{ id }}',
-  routes: {
-    root: rootRouteRef,
-  },
-});
-
-export const {{ extensionName }} = {{ pluginVar }}.provide(
-  createRoutableExtension({
-    name: '{{ extensionName }}',
-    component: () =>
-      import('./components/ExampleComponent').then(m => m.ExampleComponent),
-    mountPoint: rootRouteRef,
-  }),
-);
@@ -1,2 +1,18 @@
+/*
+ * Copyright 2020 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import '@testing-library/jest-dom';
 import 'cross-fetch/polyfill';