From 633dc3503235711c946769449847e2588e972c4b Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 16 Feb 2024 13:57:20 +0100 Subject: [PATCH 01/21] fix(ui-library): adding Figma and Tokens Studio documentation to readme --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0867f01e2..6866e4db5 100644 --- a/README.md +++ b/README.md @@ -94,6 +94,14 @@ In case you discover a security vulnerability please review our [security policy In addition, you might need to install Corepack. For more information checkout [Corepack Documentation](https://nodejs.org/api/corepack.html). +### Figma +Figma is a collaborative tool used for designing user interfaces. Figma can be run on any operating system that can run a browser which can help designers, developers and various other stakeholders to collaborate seamlessly. Sharing designs, managing permissions on a granular level and requesting feedback are some of the many features that help teams work in a more agile fashion. + +### Tokens Studio +Tokens Studio for Figma (also known as Figma Tokens) is a plugin for Figma that allows users to integrate design tokens into their Figma designs. +Before you start working with B01LER Design System for Figma, make sure to install the Tokens Studio for Figma (Figma Tokens) plugin so you can access and customize the UI kit easily. + +The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed ## :rocket: How to start From 839ef69766c2b3260887e5c5a752ba5776c94c3f Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 16 Feb 2024 13:59:34 +0100 Subject: [PATCH 02/21] fix(ui-library): removing usage section from readme --- README.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/README.md b/README.md index 6866e4db5..256e2e341 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,6 @@ - [:rocket: How to start](#rocket-how-to-start) - [Installation](#installation) - [Setup](#setup) - - [Usage](#usage) - [:white\_check\_mark: How to test](#white_check_mark-how-to-test) - [:v: Contribute](#v-contribute) - [:page\_facing\_up: License](#page_facing_up-license) @@ -145,10 +144,6 @@ The plugin allows both designers and developers to inspect tokens that have been Note: This is not filled out yet! ... -### Usage -Note: This is not filled out yet! -... - ## :white_check_mark: How to test Note: This is not filled out yet! From 9c3fd937f51ec9014d4ebd189da521817bf3aab1 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 16 Feb 2024 14:07:55 +0100 Subject: [PATCH 03/21] fix(ui-library): adding yarn start note --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 256e2e341..c7b78de81 100644 --- a/README.md +++ b/README.md @@ -140,6 +140,8 @@ The plugin allows both designers and developers to inspect tokens that have been $ yarn start ``` +> Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentationon how to use them and the parameters that they can accept. + ### Setup Note: This is not filled out yet! ... From 46cc6a450dc0123044b78d8c69761a9127fbd963 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 16 Feb 2024 15:34:00 +0100 Subject: [PATCH 04/21] fix(ui-library): providing link to Getting Started section in Figma --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index c7b78de81..eb24c2018 100644 --- a/README.md +++ b/README.md @@ -143,7 +143,7 @@ The plugin allows both designers and developers to inspect tokens that have been > Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentationon how to use them and the parameters that they can accept. ### Setup -Note: This is not filled out yet! +Please refer to the 'Getting Started section' in our [Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8311-4751&mode=design&t=SPtTkLRxRECGO4Ga-0) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/boilerds/B01LER-v1-alpha%20release.fig)) for detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. ... From 7bd45f5e1f2aa2bdf77b6c998c1a4131d803edfc Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Mon, 19 Feb 2024 14:55:12 +0100 Subject: [PATCH 05/21] fix(ui-library): adding Tokens Studio installation guide to readme --- README.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index eb24c2018..dff299f61 100644 --- a/README.md +++ b/README.md @@ -121,7 +121,7 @@ The plugin allows both designers and developers to inspect tokens that have been $ git clone https://github.com/deven-org/B01LER-Kitchen.git ``` -3. now we enable corepack for yarn and choose right version +3. Now we enable corepack for yarn and choose right version ```sh $ corepack enable @@ -143,7 +143,19 @@ The plugin allows both designers and developers to inspect tokens that have been > Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentationon how to use them and the parameters that they can accept. ### Setup -Please refer to the 'Getting Started section' in our [Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8311-4751&mode=design&t=SPtTkLRxRECGO4Ga-0) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/boilerds/B01LER-v1-alpha%20release.fig)) for detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. + +> Note: To be able to edit tokens, you must own a pro license of token studio + +1. First, open your Copy of the B01LER and bookmark Tokens Studio in the Plugins panel +2. Next, launch Tokens Studio using 'New Empty File' since no tokens have been defined yet +3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied to authenticate yourself and to connect your cloned B01LER repository. +4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab should now contain all tokens sets of B01LER available. + +Please refer to the 'Getting Started' section in our [Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8311-4751&mode=design&t=SPtTkLRxRECGO4Ga-0) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/boilerds/B01LER-v1-alpha%20release.fig)) for more detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. + +... + +The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right tokens when rebranding B01LER or when you want to extend or change some functionality of a component. ... From 8ff1d12e4a425041f5b4eeb9f38f8e1057b148ba Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 20 Feb 2024 14:55:38 +0100 Subject: [PATCH 06/21] fix(ui-library): adding build instructions to readme --- README.md | 38 +++++++++++++++++++++++++++++++++++--- 1 file changed, 35 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index dff299f61..bfa8e3968 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ - [Questions, feedback or feature requests?](#questions-feedback-or-feature-requests) - [Report an issue](#report-an-issue) - [:gear: Requirements](#gear-requirements) - - [:rocket: How to start](#rocket-how-to-start) + - [:arrow_forward: How to start](#arrow_forward-how-to-start) - [Installation](#installation) - [Setup](#setup) - [:white\_check\_mark: How to test](#white_check_mark-how-to-test) @@ -102,7 +102,7 @@ Before you start working with B01LER Design System for Figma, make sure to insta The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed -## :rocket: How to start +## :arrow_forward: How to start ### Installation > Note: You need to run terminal as administrator on Windows machines. @@ -140,7 +140,7 @@ The plugin allows both designers and developers to inspect tokens that have been $ yarn start ``` -> Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentationon how to use them and the parameters that they can accept. +> Note: This command will also open up Storybook locally. This provides you with a full list of available components that you can experiment with. Each component in Storybook also contains detailed documentation how to use them and the parameters that they can accept. ### Setup @@ -163,6 +163,38 @@ The 'Getting Started' section also explains the logic behind our token names and Note: This is not filled out yet! ... +## :toolbox: How to build +> Note: Each command must be run from the root directory of the project + +The B01LER UI Library can be built using the following command: + + ```sh + $ yarn build:ui-library + ``` + +B01LER can also be built with Storybook bundled alongside it which provides you with a sandbox to experiment with our components: + + ```sh + $ yarn build:storybook + ``` + +B01LER comes with an example vanilla JS application to demonstrate how easy it is to use components in your app. To build this example app, run the following command: + + ```sh + $ yarn build:js-example + ``` + +In the generated `dist` folder, the generated `index.html` file can be opened in the browser to preview our components. +... + +## rocket: How to deploy +Note: This is not filled out yet! +... + +## :building_construction: How to develop +Note: This is not filled out yet! +... + ## :v: Contribute For a detailed documentation on how to contribute to the B01LER project, have a look at our [contribution guide](./CONTRIBUTING.md). From cec332f68b2de9ed9a863202a38cc6810ab74e55 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Wed, 21 Feb 2024 14:14:57 +0100 Subject: [PATCH 07/21] fix(ui-library): linking readme to deployment.md file --- README.md | 2 +- doc/DEPLOYMENT.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 76a9b1d71..1e009ffd4 100644 --- a/README.md +++ b/README.md @@ -187,7 +187,7 @@ In the generated `dist` folder, the generated `index.html` file can be opened in ... ## rocket: How to deploy -Note: This is not filled out yet! +Learn about our approach to deployment [here](./doc/DEPLOYMENT.md). ... ## :building_construction: How to develop diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index 710ca3bf3..47610e89c 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -1,5 +1,5 @@ # Deployment -This chapter should provide the user with all needed information around the deployment of your project. Please provide a short introduction here. +This chapter should provide the user with all needed information around the deployment of your project. ## Content - [Tooling](#tooling) @@ -28,4 +28,4 @@ If you have a release management setup in place, please describe the process and Please write down your deployment schedule. Consider using screenshots or graphs for better visualization. ## Support -If someone needs support while deploying your project, please list the possible contact persons or communication channels where people can get support. \ No newline at end of file +If someone needs support while deploying your project, please list the possible contact persons or communication channels where people can get support. From 574179fac48194f5c1581bdd154d4c9ae775ec64 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 11:14:44 +0100 Subject: [PATCH 08/21] fix(ui-library): updating Deployment.md file --- doc/DEPLOYMENT.md | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index 47610e89c..b8b839e5a 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -1,6 +1,12 @@ # Deployment This chapter should provide the user with all needed information around the deployment of your project. +Currently, the B01LER project is getting deployed to [render.com](https://render.com) periodically. In the near future, we intend on implementing a more formal deployment schedule so that the latest version of the project will be available to view and interact with. + +The project can be viewed [here](https://b01ler.onrender.com/). This link allows you to experiment with the project and learn about how you can use components via Storybook. + +We also deploy our JS Example app to [Render](https://b01ler.onrender.com/js-example-app). This application shows you how our components look when implemented in a vanilla Javascript application. + ## Content - [Tooling](#tooling) - [How to deploy](#how-to-deploy) @@ -10,22 +16,22 @@ This chapter should provide the user with all needed information around the depl - [Support](#support) ## Tooling -Please explain what kind of tools you use for your deployment, why you have choosen them and how to work with them. +Note: This is not filled out yet! ## How to deploy -In this section you should discribe the deployment process for your project. Think about how developers who are unfamiliar with the project can deploy it to the respective enviroments. +Note: This is not filled out yet! ## Versioning -Please describe briefly how you manage the versioning of your project. +Note: This is not filled out yet! ## Release Management -If you have a release management setup in place, please describe the process and who to contact if support is needed. +Note: This is not filled out yet! ## Deployment Schedule -Please write down your deployment schedule. Consider using screenshots or graphs for better visualization. +Note: This is not filled out yet! ## Support -If someone needs support while deploying your project, please list the possible contact persons or communication channels where people can get support. +Note: This is not filled out yet! From 170bbd989bac3c5eb451a040cd6b327c5a57c4fe Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:12:55 +0100 Subject: [PATCH 09/21] fix(ui-library): adding notes Deployment.md file to explain each section --- doc/DEPLOYMENT.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index b8b839e5a..715d1d68a 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -16,22 +16,22 @@ We also deploy our JS Example app to [Render](https://b01ler.onrender.com/js-exa - [Support](#support) ## Tooling -Note: This is not filled out yet! +Please explain what kind of tools you use for your deployment, why you have choosen them and how to work with them. ## How to deploy -Note: This is not filled out yet! +In this section you should discribe the deployment process for your project. Think about how developers who are unfamiliar with the project can deploy it to the respective enviroments. ## Versioning -Note: This is not filled out yet! +Please describe briefly how you manage the versioning of your project. ## Release Management -Note: This is not filled out yet! +If you have a release management setup in place, please describe the process and who to contact if support is needed. ## Deployment Schedule -Note: This is not filled out yet! +Please write down your deployment schedule. Consider using screenshots or graphs for better visualization. ## Support -Note: This is not filled out yet! +If someone needs support while deploying your project, please list the possible contact persons or communication channels where people can get support. From 99ff422288d9d4563d79b49eb76f714f0ea362ba Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:13:37 +0100 Subject: [PATCH 10/21] fix(ui-library): adding Support section to Deployment.md file --- doc/DEPLOYMENT.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/DEPLOYMENT.md b/doc/DEPLOYMENT.md index 715d1d68a..a776bd79e 100644 --- a/doc/DEPLOYMENT.md +++ b/doc/DEPLOYMENT.md @@ -34,4 +34,4 @@ If you have a release management setup in place, please describe the process and Please write down your deployment schedule. Consider using screenshots or graphs for better visualization. ## Support -If someone needs support while deploying your project, please list the possible contact persons or communication channels where people can get support. +If support is needed while deploying BO1LER, please refer to our [README feedback section](README.md#tipping_hand_person-help--feedback) where we list the many ways that we can be reached to support you. From b4c8748fbdbb9c18322b2f0c3569a8297d581c27 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:18:59 +0100 Subject: [PATCH 11/21] fix(ui-library): adding anchors to Figma and Tokens Studio in Readme file --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 1e009ffd4..fc7cc8eae 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,8 @@ - [Questions, feedback or feature requests?](#questions-feedback-or-feature-requests) - [Report an issue](#report-an-issue) - [:gear: Requirements](#gear-requirements) + - [Figma](#figma) + - [Tokens Studio](#tokens-studio) - [:arrow_forward: How to start](#arrow_forward-how-to-start) - [Installation](#installation) - [Setup](#setup) From d868f9ee82a6654b38ad0de9fa0721b062fafa9b Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:24:34 +0100 Subject: [PATCH 12/21] fix(ui-library): removing 'next' step from readme --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index fc7cc8eae..0f79086b3 100644 --- a/README.md +++ b/README.md @@ -149,7 +149,7 @@ The plugin allows both designers and developers to inspect tokens that have been > Note: To be able to edit tokens, you must own a pro license of token studio 1. First, open your Copy of the B01LER and bookmark Tokens Studio in the Plugins panel -2. Next, launch Tokens Studio using 'New Empty File' since no tokens have been defined yet +2. Launch Tokens Studio using 'New Empty File' since no tokens have been defined yet 3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied to authenticate yourself and to connect your cloned B01LER repository. 4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab should now contain all tokens sets of B01LER available. From 78fc0771a68b107e42bf398bcbde75715a9861dc Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:37:36 +0100 Subject: [PATCH 13/21] fix(ui-library): removing getting started paragraph --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index 0f79086b3..0eaae4551 100644 --- a/README.md +++ b/README.md @@ -157,9 +157,6 @@ Please refer to the 'Getting Started' section in our [Figma file](https://www.fi ... -The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right tokens when rebranding B01LER or when you want to extend or change some functionality of a component. -... - ## :white_check_mark: How to test Learn about our testing approach [here](./doc/TESTING.md). From 6001c15611263167f694bb6a3f454d49efcd07df Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 12:38:24 +0100 Subject: [PATCH 14/21] fix(ui-library): removing example js app run instructions --- README.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/README.md b/README.md index 0eaae4551..bfe3e8d02 100644 --- a/README.md +++ b/README.md @@ -181,8 +181,6 @@ B01LER comes with an example vanilla JS application to demonstrate how easy it i ```sh $ yarn build:js-example ``` - -In the generated `dist` folder, the generated `index.html` file can be opened in the browser to preview our components. ... ## rocket: How to deploy From 471620bdf7359d897cf2eb3ef5aa497251cecf6c Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 13:04:03 +0100 Subject: [PATCH 15/21] fix(ui-library): fix readme formatting --- README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index bfe3e8d02..67c6ffb99 100644 --- a/README.md +++ b/README.md @@ -102,7 +102,7 @@ Figma is a collaborative tool used for designing user interfaces. Figma can be r Tokens Studio for Figma (also known as Figma Tokens) is a plugin for Figma that allows users to integrate design tokens into their Figma designs. Before you start working with B01LER Design System for Figma, make sure to install the Tokens Studio for Figma (Figma Tokens) plugin so you can access and customize the UI kit easily. -The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed +The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed. ## :arrow_forward: How to start @@ -148,15 +148,14 @@ The plugin allows both designers and developers to inspect tokens that have been > Note: To be able to edit tokens, you must own a pro license of token studio -1. First, open your Copy of the B01LER and bookmark Tokens Studio in the Plugins panel -2. Launch Tokens Studio using 'New Empty File' since no tokens have been defined yet +1. First, open your Copy of the B01LER and bookmark Tokens Studio in the Plugins panel. +2. Launch Tokens Studio using 'New Empty File' since no tokens have been defined yet. 3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied to authenticate yourself and to connect your cloned B01LER repository. 4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab should now contain all tokens sets of B01LER available. Please refer to the 'Getting Started' section in our [Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8311-4751&mode=design&t=SPtTkLRxRECGO4Ga-0) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/boilerds/B01LER-v1-alpha%20release.fig)) for more detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. -... - +The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right tokens when rebranding B01LER or when you want to extend or change some functionality of a component. ## :white_check_mark: How to test Learn about our testing approach [here](./doc/TESTING.md). @@ -181,11 +180,11 @@ B01LER comes with an example vanilla JS application to demonstrate how easy it i ```sh $ yarn build:js-example ``` -... -## rocket: How to deploy +In the generated `dist` folder, the generated `index.html` file can be opened in the browser to preview our components. + +## :rocket: How to deploy Learn about our approach to deployment [here](./doc/DEPLOYMENT.md). -... ## :building_construction: How to develop Note: This is not filled out yet! From 0393d9ac02df02263b069b95d6ce0708e4d9d4ac Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Fri, 23 Feb 2024 17:10:28 +0100 Subject: [PATCH 16/21] fix(ui-library): updating table of contents --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 67c6ffb99..6811acf01 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,8 @@ - [Installation](#installation) - [Setup](#setup) - [:white\_check\_mark: How to test](#white_check_mark-how-to-test) + - [:toolbox: How to build](#toolbox-how-to-build) + - [:rocket: How to deploy](#rocket-how-to-deploy) - [:v: Contribute](#v-contribute) - [:page\_facing\_up: License](#page_facing_up-license) - [:green\_heart: Code of conduct](#green_heart-code-of-conduct) From 4616e621deafa6e7a9f9f7c7add6f5995a3cd7f0 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 27 Feb 2024 09:38:40 +0100 Subject: [PATCH 17/21] fix(ui-library): updating bug report and feature requests urls --- docs/ARCHITECTURE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 4e56d7b2b..d03ae3ea0 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -77,4 +77,4 @@ In addition to components and styles, the design system includes detailed guidel Figma plays an essential role in our product development, as B01LER relies heavily on its functionalities. It serves as the platform for our design assets, including the component designs. Moreover, we utilize the [tokens studio plugin](https://www.figma.com/community/plugin/843461159747178978) within Figma to manage and update our design tokens effectively. Figma allows our team to create, share, and collaborate on designs in real-time, streamlining the design process and facilitating cross-functional collaboration. ## Contributing -Contributions to the design system are welcome! If you have suggestions for new components, styles, or guidelines, please open an issue or submit a pull request. Your contributions help improve the consistency and quality of our user interfaces. Before opening a [bug report](https://github.com/deven-org/B01LER-Kitchen/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+) or a [feature request](https://github.com/deven-org/B01LER-Kitchen/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Aenhancement&projects=deven-org%2F3&template=2_feature_request.yaml&title=%5BFeature+Request%5D%3A+) please check out our [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md). In case you discover a security vulnerability please review our [security policy](SECURITY.md) for more details on how to report it. +Contributions to the design system are welcome! If you have suggestions for new components, styles, or guidelines, please open an issue or submit a pull request. Your contributions help improve the consistency and quality of our user interfaces. Before opening a [bug report](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Abug&projects=deven-org%2F3&template=1_bug_report.yaml&title=%5BBug%5D%3A+) or a [feature request](https://github.com/deven-org/boiler/issues/new?assignees=&labels=%F0%9F%9A%A8+new%3A%3Aenhancement&projects=deven-org%2F3&template=2_feature_request.yaml&title=%5BFeature+Request%5D%3A+) please check out our [contribution guide](CONTRIBUTING.md) and our [code of conduct](CODE_OF_CONDUCT.md). In case you discover a security vulnerability please review our [security policy](SECURITY.md) for more details on how to report it. From 920de186d4fe71669978163d3a579352c8efaae9 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 27 Feb 2024 09:45:15 +0100 Subject: [PATCH 18/21] fix(ui-library): updating package.json metadata with new repo name --- package.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index 166f2f711..2f16f67a6 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/deven-org/BO1LER-Kitchen.git" + "url": "git+https://github.com/deven-org/boiler.git" }, "private": true, "workspaces": [ @@ -38,9 +38,9 @@ "author": "", "license": "MIT", "bugs": { - "url": "https://github.com/deven-org/BO1LER-Kitchen/issues" + "url": "https://github.com/deven-org/boiler/issues" }, - "homepage": "https://github.com/deven-org/BO1LER-Kitchen#readme", + "homepage": "https://github.com/deven-org/boiler#readme", "devDependencies": { "@babel/core": "^7.23.0", "@babel/plugin-proposal-decorators": "^7.23.0", From d456a9aca6e08dc0894150ab02ee4afd27a8bda5 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 27 Feb 2024 10:12:44 +0100 Subject: [PATCH 19/21] fix(ui-library): updating pipeline files with new repo name --- .github/ISSUE_TEMPLATE/1_bug_report.yaml | 4 ++-- .github/ISSUE_TEMPLATE/2_feature_request.yaml | 4 ++-- .github/ISSUE_TEMPLATE/3_custom_issue.yaml | 4 ++-- .github/ISSUE_TEMPLATE/config.yml | 2 +- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml index fb6cbc1cb..32b93aeae 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -7,7 +7,7 @@ body: - type: markdown attributes: value: | - Before reporting a bug or a documentation error, please [check if the issue already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + Before reporting a bug or a documentation error, please [check if the issue already exists](https://github.com/deven-org/boiler/issues). --- @@ -56,7 +56,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/boiler/blob/develop/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/2_feature_request.yaml b/.github/ISSUE_TEMPLATE/2_feature_request.yaml index dc771d332..b4a5e8ba0 100644 --- a/.github/ISSUE_TEMPLATE/2_feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/2_feature_request.yaml @@ -7,7 +7,7 @@ body: - type: markdown attributes: value: | - Before opening a feature request, please [check if the request already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + Before opening a feature request, please [check if the request already exists](https://github.com/deven-org/boiler/issues). - type: textarea id: description attributes: @@ -23,7 +23,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/boiler/blob/develop/docs/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/3_custom_issue.yaml b/.github/ISSUE_TEMPLATE/3_custom_issue.yaml index cff98e778..8f5b44188 100644 --- a/.github/ISSUE_TEMPLATE/3_custom_issue.yaml +++ b/.github/ISSUE_TEMPLATE/3_custom_issue.yaml @@ -6,7 +6,7 @@ body: - type: markdown attributes: value: | - Before creating an issue please [check if the issue already exists](https://github.com/deven-org/B01LER-Kitchen/issues). + Before creating an issue please [check if the issue already exists](https://github.com/deven-org/boiler/issues). - type: textarea id: description attributes: @@ -47,7 +47,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/B01LER-Kitchen/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/boiler/blob/develop/docs/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index f71f915c7..f7d167967 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Ask questions or give feedback - url: https://github.com/deven-org/B01LER-Kitchen/discussions + url: https://github.com/deven-org/boiler/discussions about: Start a discussion to ask questions or give feedback. From 996396613da40f98e7a1fb25abaeee9020b914e5 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 27 Feb 2024 10:19:08 +0100 Subject: [PATCH 20/21] fix(ui-library): updating Figma file links --- README.md | 2 +- docs/GETSTARTED.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 301a6e052..b9249deee 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,7 @@ The plugin allows both designers and developers to inspect tokens that have been 3. Connect your repository to Tokens Studio. First, generate and copy a new Personal Access Token in Github. You can use either Tokens (Classic) or 'Fine-grained tokens'. Next, use the copied token to add GitHub as a Sync Provider. Click the 'Settings tab' in Tokens Studio and in the 'Add new menu', select GitHub. Use the Personal Token that you copied to authenticate yourself and to connect your cloned B01LER repository. 4. If the entered credential are correct you will be asked to Pull from git. Please accept this dialog. The tokens tab should now contain all tokens sets of B01LER available. -Please refer to the 'Getting Started' section in our [Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=8311-4751&mode=design&t=SPtTkLRxRECGO4Ga-0) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/boilerds/B01LER-v1-alpha%20release.fig)) for more detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. +Please refer to the 'Getting Started' section in our [Figma file](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1) (the link to the Figma file above is exclusively for members of the Accenture organization, while those outside the organization can download the file [here](https://boilerds.com/B01LER%20[v0.2%20-alpha%20release].fig)) for more detailed instructions on how to set up the library, configure Figma Tokens Studio and customize the project assets to meet your requirements. The 'Getting Started' section also explains the logic behind our token names and enable you to find and change the right tokens when rebranding B01LER or when you want to extend or change some functionality of a component. diff --git a/docs/GETSTARTED.md b/docs/GETSTARTED.md index b6f9776e0..693de5008 100644 --- a/docs/GETSTARTED.md +++ b/docs/GETSTARTED.md @@ -84,7 +84,7 @@ Another way is to reach out to our community leaders. Instructions on when and h ## Link Archive Here you can find some useful links: - **[GitHub project](https://github.com/orgs/deven-org/projects/3/views/31?pane=info)** - This is where we are managing our work. Basically it is better view of all the issues in the repository. Here you can find all our boards, our backlogs and our roadmaps. The documentation of all this can be found in the side-panel. -- **[Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=1134-44297&mode=design&t=BFbmHTvPYeKQBmHt-0)** - This is the main Figma file. Here you can find all the component designs and all the design tokens via the Tokens Studio plugin. +- **[Figma file](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1)** - This is the main Figma file. Here you can find all the component designs and all the design tokens via the Tokens Studio plugin. - **[README](/README.md)** - In case you have not read the README, you should catch up soon. From here all other documentation. From here the most important files in the `/docs` folder are linked, which you should check out as well. - **[One Note](https://ts.accenture.com/sites/b01ler-core/Shared%20Documents/Forms/AllItems.aspx?RootFolder=%2Fsites%2Fb01ler%2Dcore%2FShared%20Documents)** - In the B01LER Core One Note you can find meeting notes from regular meetings like planning, refinement and weekly checkups, as well as meeting notes from all other team internal meetings. - **[Parabol](https://action.parabol.co/team/lk4SUDAJz2/)** - Parabol is used for retrospectives. Here you can see an overview of all actions that were defined in a previous retro. From e7914f6f9759bccc14b376d86ea9227e73322d79 Mon Sep 17 00:00:00 2001 From: David Kennedy <david.a.kennedy@accenture.com> Date: Tue, 27 Feb 2024 11:31:18 +0100 Subject: [PATCH 21/21] fix(ui-library): updating figma link in getstarted.md --- .github/ISSUE_TEMPLATE/1_bug_report.yaml | 2 +- README.md | 2 +- docs/DEPLOYMENT.md | 2 +- docs/GETSTARTED.md | 2 +- 4 files changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/1_bug_report.yaml b/.github/ISSUE_TEMPLATE/1_bug_report.yaml index 32b93aeae..3b17826ac 100644 --- a/.github/ISSUE_TEMPLATE/1_bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/1_bug_report.yaml @@ -56,7 +56,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/boiler/blob/develop/CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/deven-org/boiler/blob/develop/docs/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/README.md b/README.md index b9249deee..9466250a9 100644 --- a/README.md +++ b/README.md @@ -95,7 +95,7 @@ Before you start working with B01LER Design System for Figma, make sure to insta The plugin allows both designers and developers to inspect tokens that have been applied to components. An overview of all tokens for a component can be viewed with deep inspect or the specific tokens used for the building blocks of a component can also be viewed -## :rocket: How to start +## :arrow_forward: How to start ### Installation > **Note:** You need to run terminal as administrator on Windows machines. diff --git a/docs/DEPLOYMENT.md b/docs/DEPLOYMENT.md index a776bd79e..7168b6e52 100644 --- a/docs/DEPLOYMENT.md +++ b/docs/DEPLOYMENT.md @@ -34,4 +34,4 @@ If you have a release management setup in place, please describe the process and Please write down your deployment schedule. Consider using screenshots or graphs for better visualization. ## Support -If support is needed while deploying BO1LER, please refer to our [README feedback section](README.md#tipping_hand_person-help--feedback) where we list the many ways that we can be reached to support you. +If support is needed while deploying BO1LER, please refer to our [README feedback section](/README.md#tipping_hand_person-help--feedback) where we list the many ways that we can be reached to support you. diff --git a/docs/GETSTARTED.md b/docs/GETSTARTED.md index 693de5008..b6f9776e0 100644 --- a/docs/GETSTARTED.md +++ b/docs/GETSTARTED.md @@ -84,7 +84,7 @@ Another way is to reach out to our community leaders. Instructions on when and h ## Link Archive Here you can find some useful links: - **[GitHub project](https://github.com/orgs/deven-org/projects/3/views/31?pane=info)** - This is where we are managing our work. Basically it is better view of all the issues in the repository. Here you can find all our boards, our backlogs and our roadmaps. The documentation of all this can be found in the side-panel. -- **[Figma file](https://www.figma.com/file/kG44mSWhEp2VcMvMqbJrRY/B01LER-%5Bv0.2--alpha-release%5D?type=design&node-id=1134%3A44297&mode=design&t=ZatzD7omF9pxalvP-1)** - This is the main Figma file. Here you can find all the component designs and all the design tokens via the Tokens Studio plugin. +- **[Figma file](https://www.figma.com/file/C4vgEKz8mKyulJ4gm3Qdql/%F0%9F%AB%A7-%5BBLR%5D-The-B01LER?type=design&node-id=1134-44297&mode=design&t=BFbmHTvPYeKQBmHt-0)** - This is the main Figma file. Here you can find all the component designs and all the design tokens via the Tokens Studio plugin. - **[README](/README.md)** - In case you have not read the README, you should catch up soon. From here all other documentation. From here the most important files in the `/docs` folder are linked, which you should check out as well. - **[One Note](https://ts.accenture.com/sites/b01ler-core/Shared%20Documents/Forms/AllItems.aspx?RootFolder=%2Fsites%2Fb01ler%2Dcore%2FShared%20Documents)** - In the B01LER Core One Note you can find meeting notes from regular meetings like planning, refinement and weekly checkups, as well as meeting notes from all other team internal meetings. - **[Parabol](https://action.parabol.co/team/lk4SUDAJz2/)** - Parabol is used for retrospectives. Here you can see an overview of all actions that were defined in a previous retro.