chore(UX-1177): Update license information (#3)

docs: Update installation instructions in readme and update links in storybook
ZebraDevs · Dec 4, 2024 · 99b71e4 · 99b71e4
1 parent da14d9a
commit 99b71e4
Show file tree

Hide file tree

Showing 12 changed files with 1,689 additions and 32 deletions.
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1 +1 @@
-* @benken @thelukewalton @mikecoomber
+* @ZebraDevs/front-end-devs 
diff --git a/.storybook/extractArgs.ts b/.storybook/extractArgs.ts
@@ -1,5 +1,7 @@
 /**
  * Adapted from cem-plugin-better-lit-types: https://github.com/Uscreen-video/cem-plugin-better-lit-types.
+ * 
+ * See LICENSE_3RD_PARTY for license information.
  */
 
 import { reduceTypes } from "cem-plugin-better-lit-types/storybook";
@@ -160,4 +162,4 @@ export const getDeclaration = (manifest, tagName, type = "") => {
     });
 
   return _declaration;
-};
+};
diff --git a/CODE_OF_CONDUCT b/CODE_OF_CONDUCT
@@ -0,0 +1,57 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the Contributor Covenant,
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
diff --git a/CONTRIBUTING b/CONTRIBUTING
@@ -25,6 +25,7 @@ Before a PR can be reviewed, ensure you have done the following, and fixed any i
 - Check formatting: `npm run lint`
 - Run unit-tests: `npm run test`
 
+Once a PR is opened, review is required by the Codeowners. It is also required that all status checks pass before a PR can be merged.
 
 ## Documentation
 
@@ -33,12 +34,12 @@ All parameters, attributes and slots should be documented with brief description
 
 Once code is written, all components should have a story written in Storybook. Single components can use autodocs to create their documentation, but for complex components we may need to create the markdown. We must run `npm run analyze` before writing stories, as this updates [custom-elements.json](./custom-elements.json) which storybook uses.
 
-To create a story, first create a directory under `src/stories` for the component. 
+To create a story, first create a directory under `src/stories` for the component.
 
 In storybook, always add the `title` parameter as this is used in documentation.
 
 For single components, we should add `tags:['autodocs']` to storybook to generate the documentation.
 
 For complex components, we should create a folder within `src/stories` for this component. In this directory, we create all stories needed and add the same `title` to all.
-Then create a `Docs.mdx` file in this folder, alongside all the stories. 
-Within this we need to import the stories, and the blocks from storybook - see [Badges](./src/stories/Badges/Docs.mdx) for an example. We can then display the canvas, description and ArgTypes for all the components.
+Then create a `Docs.mdx` file in this folder, alongside all the stories.
+Within this we need to import the stories, and the blocks from storybook - see [Badges](./src/stories/Badges/Docs.mdx) for an example. We can then display the canvas, description and ArgTypes for all the components.
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Zebra Technologies
+Copyright (c) 2024 Zebra Technologies
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

diff --git a/LICENSE-3RD-PARTY b/LICENSE-3RD-PARTY
@@ -0,0 +1,140 @@
+# THIRD PARTY LICENSES
+
+---
+
+## A Beautiful Site, LLC
+
+Applies to:
+
+- make-react.js
+- shared.js
+
+Copyright (c) 2020 A Beautiful Site, LLC
+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.
+
+## Uscreen
+
+Applies to:
+
+- extractArgs.ts
+
+MIT License
+
+Copyright (c) 2023 Uscreen
+
+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.
+
+## IBM Plex Sans
+
+Applies to:
+
+- typography.ts
+
+Copyright © 2017 IBM Corp. with Reserved Font Name "Plex"
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+
+This license is copied below, and is also available with a FAQ at: http://scripts.sil.org/OFL
+
+### SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1. Neither the Font Software nor any of its individual components,
+   in Original or Modified Versions, may be sold by itself.
+
+2. Original or Modified Versions of the Font Software may be bundled,
+   redistributed and/or sold with any software, provided that each copy
+   contains the above copyright notice and this license. These can be
+   included either as stand-alone text files, human-readable headers or
+   in the appropriate machine-readable metadata fields within text or
+   binary files as long as those fields can be easily viewed by the user.
+
+3. No Modified Version of the Font Software may use the Reserved Font
+   Name(s) unless explicit written permission is granted by the corresponding
+   Copyright Holder. This restriction only applies to the primary font name as
+   presented to the users.
+
+4. The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+   Software shall not be used to promote, endorse or advertise any
+   Modified Version, except to acknowledge the contribution(s) of the
+   Copyright Holder(s) and the Author(s) or with their explicit written
+   permission.
+
+5. The Font Software, modified or unmodified, in part or in whole,
+   must be distributed entirely under this license, and must not be
+   distributed under any other license. The requirement for fonts to
+   remain under this license does not apply to any document created
+   using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
diff --git a/README.md b/README.md
@@ -9,55 +9,74 @@ The Zeta Design System includes foundations, components, and best practices that
 
 To view examples of all the components in the library, you can pull this repo and run the Storybook instance.
 
-You can also view the latest release at [Zeta](https://zeta-ds.web.app/) or the latest commits to main [here](https://zeta-web-main.web.app/).
+You can also view the latest release at [Zeta](https://design.zebra.com/) or the latest commits to main [here](https://zeta-web-main.web.app/).
 
 ## How to Use
 
-Zeta Web Components can be directly used in many web frameworks.
+Web Components can be directly used in many web frameworks.
 
 > ⚛️ **Note**: Using React? Zeta is not ready just yet. Whilst you wait, you can use [zds_react](https://www.npmjs.com/package/@zebra-fed/zds-react).
 
 1. Install `@zebra-fed/zeta-web`
 
    ```sh
-   # Future install instructions
    # NPM
    npm install @zebra-fed/zeta-web
    # YARN
    yarn add @zebra-fed/zeta-web
    ```
 
-2. Import the desired Zeta Web Component into your app:
+2. Import the global styles into the main app file
 
    ```js
-   /* Import the component in the JS/TS file where it is used */
+   import "@zebra-fed/zeta-web/index.css";
+   ```
+
+   or in HTML,
+
+   ```html
+   <link rel="stylesheet" href="./node_modules/@zebra-fed/zeta-web/dist/index.css" />
+   ```
+
+3. Import the desired Zeta Web Component, or the full package into your app:
+
+   ```js
+   // Individual button component
    import "@zebra-fed/zeta-web/dist/components/button/button.js";
 
-   /* Import the Global Styles into the main App file */
-   import "@zebra-fed/zeta-web/index.css";
+   // or full package
+   import "@zebra-fed/zeta-web";
    ```
 
    or in HTML,
 
    ```html
-   <link rel="stylesheet" href="./node_modules/@zebra-fed/zeta-web/dist/style.css" />
+   <!-- Individual button component -->
    <script type="module" src="./node_modules/@zebra-fed/zeta-web/dist/components/button/button.js"></script>
+
+   <!-- or full package-->
+   <script type="module" src="./node_modules/@zebra-fed/zeta-web/dist/index.js"></script>
    ```
 
-   You can also import the full package:
+   To reduce bloat, we recommend only importing the components you will actually use into your project.
+
+4. If you use any element that uses icons, you will also need to import the index.css from [@zebra-fed/zeta-icons](https://www.npmjs.com/package/@zebra-fed/zeta-icons).
+
+   > 🚧 **Note**: This is a temporary step for now. This will be automatically imported where needed in the future.
 
    ```js
-   import "@zebra-fed/zeta-web";
+   import "@zebra-fed/zeta-icons/index.css";
    ```
 
-3. If you use any element that uses icons, you will also need to import the index.css from [@zebra-fed/zeta-web](https://www.npmjs.com/package/@zebra-fed/zeta-icons)
-   This is a temporary step for now. This will be automatically imported where needed in the future.
+   or in HTML,
 
    ```html
-   <link rel="stylesheet" href="./node_modules/@zebra-fed/zeta-icons/dist/style.css" />
+   <link rel="stylesheet" href="./node_modules/@zebra-fed/zeta-icons/index.css" />
    ```
 
-4. Use the Web Component like any HTML element
+   Full list of icons can be found at [Zeta Icons](https://design.zebra.com/icons/).
+
+5. Use the Web Component like any HTML element
 
    ```html
    <zeta-button>Hello world!</zeta-button>
@@ -92,3 +111,7 @@ To improve the development experience while using the zeta web-components, the f
      }
    }
    ```
+
+## Licensing
+
+This software is licensed with the MIT license (see [LICENSE](./LICENSE) and [THIRD PARTY LICENSES](./LICENSE-3RD-PARTY)).
diff --git a/catalog-info.yaml b/catalog-info.yaml
@@ -11,13 +11,13 @@ metadata:
       title: Storybook
     - url: https://design-zebra.web.app/web/tsdoc/
       title: TSDoc
-#    - url: https://npmjs.com/package/@zebra/zeta-web
-#      title: npm
+   - url: https://npmjs.com/package/@zebra-fed/zeta-web
+     title: npm
   tags: 
     - typescript
     - web-components
   annotations:
-    github.com/project-slug: zebratechnologies/zeta-web
+    github.com/project-slug: ZebraDevs/zeta-web
     github.com/team-slug: zebratechnologies/front-end-development
 #    backstage.io/techdocs-ref: dir:.
 spec:
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		* @benken @thelukewalton @mikecoomber
		* @ZebraDevs/front-end-devs