Skip to content

Commit

Permalink
add brightlayer refs
Browse files Browse the repository at this point in the history
  • Loading branch information
JeffGreiner-eaton committed Nov 19, 2021
1 parent 85e66cb commit e48b7d8
Show file tree
Hide file tree
Showing 146 changed files with 3,883 additions and 3,933 deletions.
10 changes: 5 additions & 5 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ jobs:
- MASTER_BRANCH: master
- DEV_BRANCH: dev
- DEV_TARGET: https://github.com/px-blue/px-blue.github.io
- MASTER_TARGET: https://github.com/pxblue/pxblue.github.io
- MASTER_TARGET: https://github.com/brightlayer-ui/brightlayer-ui.github.io
- BLUI_DEV_TARGET: https://github.com/brightlayer-ui-dev/brightlayer-ui-dev.github.io
- BLUI_MASTER_TARGET: https://github.com/brightlayer-ui/brightlayer-ui.github.io
- GH_EMAIL: pxblue@eaton.com
- GH_NAME: PX Blue Agent
- GH_EMAIL: brightlayer-ui@eaton.com
- GH_NAME: Brightlayer UI Agent
steps:
- checkout
- restore_cache:
Expand All @@ -22,7 +22,7 @@ jobs:
name: Install dependencies
command: |
yarn install
yarn upgrade @pxblue/icons-mui
yarn upgrade @brightlayer-ui/icons-mui
- save_cache:
paths:
- node_modules
Expand Down Expand Up @@ -90,7 +90,7 @@ jobs:
git config --global user.name "$GH_NAME"
if [ $CIRCLE_BRANCH == $MASTER_BRANCH ]; then
echo "Not publishing yet since org 'pxblue' has not changed name yet."
echo "Not publishing yet since org 'brightlayer-ui' has not changed name yet."
# git clone $BLUI_MASTER_TARGET out-blui
else
git clone $BLUI_DEV_TARGET out-blui
Expand Down
2 changes: 1 addition & 1 deletion .eslintrc.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
module.exports = {
parser: '@typescript-eslint/parser',
extends: ['@pxblue/eslint-config/tsx'],
extends: ['@brightlayer-ui/eslint-config/tsx'],
parserOptions: {
project: './tsconfig.json',
},
Expand Down
2 changes: 1 addition & 1 deletion .github/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@ newPRWelcomeComment: >

# Comment to be posted to on pull requests merged by a first time user
firstPRMergeComment: >
Congrats on merging your first pull request 👍! Welcome to the PX Blue community 🤗!
Congrats on merging your first pull request 👍! Welcome to the Brightlayer UI community 🤗!
# It is recommend to include as many gifs and emojis as possible
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
# Doc-It (a.k.a. pxblue.github.io)
# Doc-It (a.k.a. brightlayer-ui.github.io)

[![CircleCI](https://circleci.com/gh/pxblue/doc-it/tree/master.svg?style=shield&circle-token=fc2656a76d70b4ff9cdc66cccc758c0dfbf89d25)](https://circleci.com/gh/pxblue/doc-it/tree/master)
[![CircleCI](https://circleci.com/gh/brightlayer-ui/doc-it/tree/master.svg?style=shield&circle-token=fc2656a76d70b4ff9cdc66cccc758c0dfbf89d25)](https://circleci.com/gh/brightlayer-ui/doc-it/tree/master)

Doc-It is the source code for the pxblue.github.io documentation site for Power Xpert Blue. The site is built to both provide documentation on how to use the system, but also as an example of how to use it. The entire site is using using the PX Blue design system - built with React+Redux, Material UI, and the PX Blue component library.
Doc-It is the source code for the brightlayer-ui.github.io documentation site for Brightlayer UI. The site is built to both provide documentation on how to use the system, but also as an example of how to use it. The entire site is using using the Brightlayer UI design system - built with React+Redux, Material UI, and the Brightlayer UI component library.

## Contributing

To contribute to the documentation site, you will need to clone a local copy of the repository:

```
git clone https://github.com/pxblue/doc-it
git clone https://github.com/brightlayer-ui/doc-it
```

You can then install the necessary dependencies and run a local instance with the following commands:
Expand Down Expand Up @@ -51,9 +51,9 @@ The folder structure of the application is segregated to keep the application an
│ └── /shared // extra utility functions
|
└── /docs // markdown-based page definitions
|── /community // information on how to be a part of PX Blue
|── /design // information for designers using PX Blue
|── /development // information for developers using PX Blue
|── /community // information on how to be a part of Brightlayer UI
|── /design // information for designers using Brightlayer UI
|── /development // information for developers using Brightlayer UI
|── /get-started // information on getting started with a project
|── /patterns // design patterns and sample code
|── /release-notes // information about past releases
Expand All @@ -66,7 +66,7 @@ The Doc-it project is configured with automated builds and deployment scripts.

When changes are committed to the dev branch, they are automatically run through the test scripts and if the tests pass, the site is deployed to the staging server.

When changes are committed to the master branch and the tests pass, the changes are automatically deployed to pxblue.github.io.
When changes are committed to the master branch and the tests pass, the changes are automatically deployed to brightlayer-ui.github.io.

## Browsers support

Expand Down
2 changes: 1 addition & 1 deletion cypress/support/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Applitools admin console test results https://auth.applitools.com/users/login
Authentication located in Teams wiki PX Blue Logistical.
Authentication located in Teams wiki Brightlayer UI Logistical.

Cypress.io and Applitools eyes-cypress package are configured to run out of the integration folder. UI tests are defined by vs-test-name.spec.js and normal cypress tests are test-name.spec.js

Expand Down
21 changes: 11 additions & 10 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "doc-it",
"author": "PX Blue <pxblue@eaton.com>",
"author": "Brightlayer UI <brightlayer-ui@eaton.com>",
"version": "2.4.2",
"private": true,
"scripts": {
Expand All @@ -22,19 +22,20 @@
"indexer": "cd scripts/crawl && node crawler.js && node indexer.js && cd ../.. && prettier \"src/database/*.json\" --write",
"analyze": "source-map-explorer 'build/static/js/*.js'"
},
"prettier": "@pxblue/prettier-config",
"prettier": "@brightlayer-ui/prettier-config",
"dependencies": {
"@brainhubeu/react-carousel": "1.12.15",
"@brightlayer-ui/colors": "^3.0.1",
"@brightlayer-ui/colors-branding": "^3.1.0",
"@brightlayer-ui/icons-mui": "^2.7.0",
"@brightlayer-ui/react-components": "^5.3.2",
"@brightlayer-ui/react-progress-icons": "^2.1.1",
"@brightlayer-ui/react-themes": "^6.1.0",
"@fontsource/roboto-mono": "^4.1.1",
"@material-ui/core": "^4.11.0",
"@material-ui/icons": "^4.11.2",
"@material-ui/lab": "^4.0.0-alpha.56",
"@pxblue/colors": "^3.0.0",
"@pxblue/colors-branding": "^3.0.0",
"@pxblue/icons-mui": "^2.5.0",
"@pxblue/react-components": "^5.3.1",
"@pxblue/react-progress-icons": "^2.1.0",
"@pxblue/react-themes": "^6.1.0",
"@pxblue/icons-mui": "^2.7.0",
"axios": "^0.19.2",
"clsx": "^1.1.0",
"color": "^3.1.3",
Expand All @@ -54,11 +55,11 @@
},
"devDependencies": {
"@babel/core": "7.12.3",
"@brightlayer-ui/eslint-config": "^2.0.5",
"@brightlayer-ui/prettier-config": "^1.0.3",
"@mdx-js/loader": "^1.5.5",
"@mdx-js/react": "^1.5.5",
"@pmmmwh/react-refresh-webpack-plugin": "0.4.3",
"@pxblue/eslint-config": "^2.0.0",
"@pxblue/prettier-config": "^1.0.2",
"@svgr/webpack": "5.5.0",
"@testing-library/jest-dom": "^5.11.4",
"@testing-library/react": "^11.1.0",
Expand Down
6 changes: 3 additions & 3 deletions public/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
<html lang="en">
<head>
<meta charset="utf-8" />
<link rel="icon" href="%PUBLIC_URL%/pxblue.png" />
<link rel="icon" href="%PUBLIC_URL%/brightlayer-ui.png" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="theme-color" content="#007bc1" />
<meta name="description" content="Documentation site for the PX Blue design system." />
<meta name="description" content="Documentation site for the Brightlayer UI design system." />
<meta name="google-site-verification" content="iuEyJbuvDYHf_Ksbyb7W4CzOpQVTzoKWEPzZN4oOluk" />
<link rel="apple-touch-icon" href="%PUBLIC_URL%/images/pxblue192.png" />
<!--
Expand All @@ -22,7 +22,7 @@
work correctly both with client-side routing and a non-root public URL.
Learn how to configure a non-root public URL by running `npm run build`.
-->
<title>Power Xpert Blue | Powering Teams to Make What Matters</title>
<title>Brightlayer UI | Powering Teams to Make What Matters</title>
<script type="text/javascript">
// Single Page Apps for GitHub Pages
// https://github.com/rafrex/spa-github-pages
Expand Down
6 changes: 3 additions & 3 deletions public/manifest.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"short_name": "PX Blue",
"name": "PX Blue Documentation",
"short_name": "Brightlayer UI",
"name": "Brightlayer UI Documentation",
"icons": [
{
"src": "pxblue.png",
"src": "brightlayer-ui.png",
"sizes": "64x64 32x32 24x24 16x16",
"type": "image/x-icon"
},
Expand Down
10 changes: 5 additions & 5 deletions scripts/crawl/sitemap.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"title": "Power Xpert Blue | Powering Teams to Make What Matters*",
"title": "Brightlayer UI | Powering Teams to Make What Matters*",
"url": "",
"hasLandingPage": true,
"pages": [
{
"title": "What is PX Blue?",
"title": "What is Brightlayer UI?",
"url": "/overview"
},
{
Expand All @@ -26,15 +26,15 @@
]
},
{
"title": "Developing w/ PX Blue",
"title": "Developing w/ Brightlayer UI",
"url": "/development",
"pages": [
{
"title": "Environment Setup",
"url": "/environment"
},
{
"title": "PX Blue CLI",
"title": "Brightlayer UI CLI",
"url": "/cli"
},
{
Expand Down Expand Up @@ -85,7 +85,7 @@
]
},
{
"title": "Designing w/ PX Blue",
"title": "Designing w/ Brightlayer UI",
"url": "/design",
"pages": [
{
Expand Down
16 changes: 8 additions & 8 deletions src/__configuration__/community/index.tsx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
import React from 'react';
import { Gavel, BugReport, EmojiObjects, QuestionAnswer, Group, Drafts, ImportExport } from '@material-ui/icons';
import * as Colors from '@pxblue/colors';
import * as BrandingColors from '@pxblue/colors-branding';
import * as Colors from '@brightlayer-ui/colors';
import * as BrandingColors from '@brightlayer-ui/colors-branding';

export const links = [
{
title: 'License',
url: '/community/license',
description: `Learn about the open source license under which PX Blue is made available.`,
description: `Learn about the open source license under which Brightlayer UI is made available.`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<Gavel fontSize={'inherit'} color={'inherit'} />
Expand All @@ -20,7 +20,7 @@ export const links = [
{
title: 'Innersourcing',
url: '/community/innersourcing',
description: `Help improve PX Blue for others by sharing your work with the larger community.`,
description: `Help improve Brightlayer UI for others by sharing your work with the larger community.`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<ImportExport fontSize={'inherit'} color={'inherit'} />
Expand All @@ -46,7 +46,7 @@ export const links = [
{
title: 'Request Features',
url: '/community/features',
description: `Have an idea for a new addition to PX Blue? Tell us about it!`,
description: `Have an idea for a new addition to Brightlayer UI? Tell us about it!`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<EmojiObjects fontSize={'inherit'} color={'inherit'} />
Expand All @@ -59,7 +59,7 @@ export const links = [
{
title: 'FAQ',
url: '/community/faq',
description: `Read answers to common questions about using PX Blue.`,
description: `Read answers to common questions about using Brightlayer UI.`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<QuestionAnswer fontSize={'inherit'} color={'inherit'} />
Expand All @@ -72,7 +72,7 @@ export const links = [
{
title: 'Our Team',
url: '/community/our-team',
description: `Meet the people behind PX Blue and learn what makes us tick.`,
description: `Meet the people behind Brightlayer UI and learn what makes us tick.`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<Group fontSize={'inherit'} color={'inherit'} />
Expand All @@ -85,7 +85,7 @@ export const links = [
{
title: 'Contact Us',
url: '/community/contactus',
description: `We love hearing from you! Feel free to contact us any time to talk about PX Blue or your projects.`,
description: `We love hearing from you! Feel free to contact us any time to talk about Brightlayer UI or your projects.`,
image: (
<span style={{ fontSize: 120, color: 'white', display: 'flex' }}>
<Drafts fontSize={'inherit'} color={'inherit'} />
Expand Down
2 changes: 1 addition & 1 deletion src/__configuration__/contributors/contributors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ export const contributors: OtherContributor[] = [
},
{
name: 'Bryan Elkus',
role: 'PX Blue Independent Audit',
role: 'Brightlayer UI Independent Audit',
},
{
name: 'Kyle Harris',
Expand Down
12 changes: 6 additions & 6 deletions src/__configuration__/design/resources.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,31 @@ export const patternLinks = [
{
title: 'Style Guides',
url: '/style',
description: 'PX Blue style guidelines, including colors, themes, icons, typography, and more.',
description: 'Brightlayer UI style guidelines, including colors, themes, icons, typography, and more.',
image: style,
background: { position: 'center' },
},
{
title: 'Design Patterns',
url: '/patterns',
description: 'Common interactions and designs found in PX Blue applications.',
description: 'Common interactions and designs found in Brightlayer UI applications.',
image: patterns,
background: { position: 'right' },
},
];

export const figmaCommunityFileLinks = [
{
title: 'PX Blue Component Stickersheet',
title: 'Brightlayer UI Component Stickersheet',
url: 'https://www.figma.com/community/file/1024360297793425107',
description: 'Pre-built Material and PX Blue Figma components',
description: 'Pre-built Material and Brightlayer UI Figma components',
image: componentStickersheet,
background: { position: 'center' },
},
{
title: 'PX Blue Design Pattern Library',
title: 'Brightlayer UI Design Pattern Library',
url: 'https://www.figma.com/community/file/1023327014725714313',
description: 'A Figma design library that includes common patterns used across various PX Blue projects.',
description: 'A Figma design library that includes common patterns used across various Brightlayer UI projects.',
image: designPatternLibrary,
background: { position: 'right' },
},
Expand Down
18 changes: 9 additions & 9 deletions src/__configuration__/landingPage/cardData.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,49 +11,49 @@ import roadmap from '../../../src/app/assets/card-images/roadmap.png';
export const cardData = [
{
title: 'Style Guide',
description: `Learn more about PX Blue style guidelines, including colors, themes, icons, typography, and more.`,
description: `Learn more about Brightlayer UI style guidelines, including colors, themes, icons, typography, and more.`,
image: style,
path: '/style',
},
{
title: 'Icons',
description: `Browse the library of icons available in PX Blue including Material icons as well as custom ones for PX Blue applications.`,
description: `Browse the library of icons available in Brightlayer UI including Material icons as well as custom ones for Brightlayer UI applications.`,
image: icons,
path: '/style/iconography',
},
{
title: 'Design Patterns',
description: `Learn about common interactions and designs found in PX Blue applications.`,
description: `Learn about common interactions and designs found in Brightlayer UI applications.`,
image: patterns,
path: '/patterns',
},
{
title: 'Figma Sticker Sheet',
description: `View our library of pre-built Material and PX Blue Figma components to jump start your project design process.`,
description: `View our library of pre-built Material and Brightlayer UI Figma components to jump start your project design process.`,
image: figma,
path: 'https://www.figma.com/community/file/1024360297793425107',
},
{
title: 'Component APIs',
description: `Check out our libraries of pre-built JavaScript components that accelerate your application development.`,
image: components,
path: 'https://pxblue-components.github.io',
path: 'https://brightlayer-ui-components.github.io',
},
{
title: 'Development Resources',
description: `Have a look at all of the code examples and packages available from PX Blue. We're constantly updating and adding new materials.`,
description: `Have a look at all of the code examples and packages available from Brightlayer UI. We're constantly updating and adding new materials.`,
image: resources,
path: '/resources/developer',
},
{
title: 'GitHub',
description: `All PX Blue resources and materials are open source and available for viewing on our GitHub organization.`,
description: `All Brightlayer UI resources and materials are open source and available for viewing on our GitHub organization.`,
image: github,
path: 'https://github.com/pxblue',
path: 'https://github.com/brightlayer-ui',
},
{
title: 'Community',
description: `Learn how to join the PX Blue community by innersourcing, requesting features, etc.`,
description: `Learn how to join the Brightlayer UI community by innersourcing, requesting features, etc.`,
image: community,
path: '/community',
},
Expand Down
2 changes: 1 addition & 1 deletion src/__configuration__/markdown/markdownMapping.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
import { Link as LinkIcon } from '@material-ui/icons';
import { Link, LinkProps } from 'react-router-dom';
import { REGULAR_WIDTH_STYLE, copyTextToClipboard } from '../../app/shared';
import * as Colors from '@pxblue/colors';
import * as Colors from '@brightlayer-ui/colors';
import color from 'color';
import clsx from 'clsx';
import './markdown.css';
Expand Down
Loading

0 comments on commit e48b7d8

Please sign in to comment.