chore: update documentation and project metadata

There are some outdated details and things to clean up in the documentation aspects of the repo.

* Added a GOVERNANCE document per OSPO request
* Unify build job into one
* Cleared up licenses since we no longer have Metropolis and Clarity City has its own repo
* Removed some attributions that are no longer valid for Core
* Cleaned up and lightly reorganized some of the documentation content for Core

Signed-off-by: Jeremy Wilken <[email protected]>

.github/workflows/build.yml

@@ -15,7 +15,10 @@ jobs:
           check-latest: true
       - uses: microsoft/playwright-github-action@v1
       - run: yarn install
-      - run: yarn build:ci
+      - run: yarn build
+      - run: yarn website:functions
+      - run: npm run website:deploy # Use NPM as a workaround for npx executing
 
     env:
       CI: true
+      NETLIFY_SITE_ID: 03fce0dd-9568-4ab2-a3ea-211d856989db

CHANGELOG.md

@@ -1,3 +1,3 @@
 # Changelog
 
-You can view the full release notes at https://clarity.design/news.
+You can view the full release notes at https://clarity.design/releases.

LICENSE

@@ -1,16 +1,21 @@
-Clarity
-
-Copyright © 2016-2018 VMware, Inc.  All rights reserved
-
-The MIT license (the "License") set forth below applies to all parts of the Clarity project except for the fonts which are licensed under the SIL Open Font License version 1.1.  You may not use this file except in compliance with the License.
-
 MIT License
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do
-so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-
-
+Copyright (c) 2016-2021 VMware, Inc.  All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -3,31 +3,28 @@
 # Clarity Design System
 
 ![Build](https://github.com/vmware/clarity/workflows/Build/badge.svg)
-![Website](https://github.com/vmware/clarity/workflows/Website/badge.svg)
 
-Project Clarity is an open source design system that brings together UX
-guidelines, an HTML/CSS framework, Angular components, and Web Components. This
+Clarity is an open source design system that brings together UX
+guidelines, design resources, and coding implementations with Web Components. This
 repository includes everything you need to build, customize, test, and deploy
 Clarity. For complete documentation, visit the [Clarity website](https://clarity.design).
 
+If you are looking for Clarity Angular, our previous implementation of Clarity built
+in Angular, please see the [`angular` branch](https://github.com/vmware/clarity/tree/angular/) for the latest version there.
+
 ## Getting Started
 
 Clarity is published as five npm packages:
 
 - [![npm version core](https://img.shields.io/npm/v/@cds/core/latest?label=%40cds%2Fcore&style=flat-square)](https://www.npmjs.com/package/@cds/core) Contains the Web
   Components that work in any JavaScript framework.
 - [![npm version cds angular](https://img.shields.io/npm/v/@cds/angular/latest?label=%40cds%2Fangular&style=flat-square)](https://www.npmjs.com/package/@cds/angular) Contains shims for core usage in Angular environment
-- [![npm version ui](https://img.shields.io/npm/v/@clr/ui/latest?label=%40clr%2Fui&style=flat-square)](https://www.npmjs.com/package/@clr/ui) Contains the static
-  styles for building HTML components.
-- [![npm version clr angular](https://img.shields.io/npm/v/@clr/angular/latest?label=%40clr%2Fangular&style=flat-square)](https://www.npmjs.com/package/@clr/angular) Contains the
-  Angular components. This package depends on `@clr/ui` for styles.
+- [![npm version cds react](https://img.shields.io/npm/v/@cds/angular/latest?label=%40cds%2Freact&style=flat-square)](https://www.npmjs.com/package/@cds/react) Contains shims for core usage in React environment
 - [![npm version clarity city](https://img.shields.io/npm/v/@cds/city/latest?label=%40cds%2Fcity&style=flat-square)](https://www.npmjs.com/package/@cds/city) Our open source sans-serif typeface.
 
 ## Installing Clarity
 
-- **[Install CSS Only](/docs/INSTALLATION.md#installing-clarity-ui)**
-- **[Install Angular Components](/docs/INSTALLATION.md#installing-clarity-angular)**
-- **[Install Web Components](/docs/INSTALLATION.md#installing-clarity-web-components)**
+Visit our documentation at https://clarity.design/get-started/
 
 ## Documentation
 
@@ -37,12 +34,11 @@ and example usage, see [our website](https://clarity.design).
 ## Contributing
 
 The Clarity project team welcomes contributions from the community. For more
-detailed information, see [CONTRIBUTING.md](CONTRIBUTING.md).
+detailed information, see [our contribution guidances](./docs/CONTRIBUTING.md).
 
 ## Licenses
 
-- The Clarity Design System is licensed under the MIT license.
-- The font is licensed under the Open Font License (OFL).
+- The Clarity Design System is licensed under the [MIT license](./LICENSE).
 
 ## Feedback
 
@@ -54,6 +50,6 @@ Clarity Stackblitz Templates for the version you are using at
 
 ## Support
 
-The team supports up to 2 versions behind the latest one.
+For our support policies please visit https://clarity.design/get-started/support/
 
 For questions, ideas, or just reaching out to the team feel free to open a discussion in our [GitHub Disscussion section](https://github.com/vmware/clarity/discussions).

apps/website/.vuepress/public/versions.json

@@ -1,5 +1,6 @@
 [
-  { "version": "v5", "url": "https://clarity.design" },
+  { "version": "v12", "url": "https://angular.clarity.design" },
+  { "version": "v5", "url": "https://v5.clarity.design" },
   { "version": "v4", "url": "https://v4.clarity.design/documentation" },
   { "version": "v3", "url": "https://v3.clarity.design" },
   { "version": "v2", "url": "https://v2.clarity.design" },