backstage integration (#121)

catalog-info.yaml

@@ -0,0 +1,30 @@
+apiVersion: backstage.io/v1alpha1
+kind: Component
+metadata:
+  name: bv-ui-core
+  github.com/project-slug: bazaarvoice/bv-ui-core
+  description: This project provides a central location for common Bazaarvoice UI code. It is intended to be installed into a project via NPM. Individual modules are authored as CommonJS modules, to be consumed by Webpack or another build tool that can ingest CommonJS.
+  annotations:
+    backstage.io/techdocs-ref: dir:.
+    github.com/project-slug: bazaarvoice/bv-ui-core
+  links:
+    - url: https://bazaarvoice.slack.com/app_redirect?channel=sme-swat
+      title: Slack channel
+      icon: send
+    - url: https://sonarqube.qa.bazaarvoice.com/dashboard?id=bazaarvoice_bv-ui-core
+      title: SonarQube
+      icon: dashboard
+  labels:
+    tech: javascript
+  tags:
+    - javascript
+    - nodejs
+spec:
+  type: library
+  system: swat
+  lifecycle: production
+  owner: swat
+
+
+
+

lib/README.md

@@ -0,0 +1,61 @@
+![](https://travis-ci.org/bazaarvoice/bv-ui-core.svg)
+
+# bv-ui-core
+
+This project provides a central location for common Bazaarvoice UI code. It is
+intended to be installed into a project via NPM. Individual modules are authored
+as CommonJS modules, to be consumed by Webpack or another build tool that can
+ingest CommonJS.
+
+**This is a public repository.** Please see the [contribution guidelines][1] for
+details on contributing to this repo.
+
+## Installation
+
+You will need NPM to add this to your project; it is installed when you install
+Node, so it is likely that you already have it. If not, you can install Node
+using an [installer][2], or by using your favorite package manager (such as
+Homebrew).
+
+Once you have NPM, you can install bv-ui-core as follows:
+
+```bash
+npm install --save bv-ui-core
+```
+
+## Usage
+
+Require bv-ui-core modules into your code:
+
+```javascript
+var someModule = require('bv-ui-core/lib/someModule');
+someModule.doThings();
+```
+
+For details on how to use a specific module, see the README document in the
+module's directory.
+
+## Modules
+
+- [body](./lib/body)
+- [checkHighContrast](./lib/checkHighContrast)
+- [cookie](./lib/cookie)
+- [cookieConsent](./lib/cookieConsent)
+- [cssLoadChecker](./lib/cssLoadChecker)
+- [date.now](./lib/date.now)
+- [domainPolice](./lib/domainPolice)
+- [evented](./lib/evented)
+- [getOriginalConstructor](./lib/getOriginalConstructor)
+- [global](./lib/global)
+- [ie](./lib/ie)
+- [loader](./lib/loader)
+- [logger](./lib/logger)
+- [namespacer](./lib/namespacer)
+- [performance](./lib/performance)
+- [polyfills](./lib/polyfills)
+- [pixelsDisplayed](./lib/pixelsDisplayed)
+- [staticAssetLoader](./lib/staticAssetLoader)
+- [waitForBody](./lib/waitForBody)
+
+[1]: ./CONTRIBUTING.md
+[2]: https://nodejs.org/download/

mkdocs.yaml

@@ -0,0 +1,5 @@
+site_name: bv-ui-core
+docs_dir: lib
+plugins:
+  - techdocs-core
+repo_url: https://github.com/bazaarvoice/bv-ui-core/