Update documentation around repository name (#222)
# Pull Request ## 📖 Description <!--- Provide some background and a description of your work. --> This change comes after the repository has been updated to "Design to Code" and aligns all documentation to refer to this naming update. ## ✅ Checklist ### General <!--- Review the list and put an x in the boxes that apply. --> - [ ] I have added tests for my changes. - [ ] I have tested my changes. - [x] I have updated the project documentation to reflect my changes. ## ⏭ Next Steps <!--- If there is relevant follow-up work to this PR, please list any existing issues or provide brief descriptions of what you would like to do next. --> - Adding a final deprecation bump for packages before they are renamed
This commit is contained in:
Родитель
904ee3b834
Коммит
09f1fe2bd5
|
@ -1,6 +1,6 @@
|
||||||
# Branch guide
|
# Branch guide
|
||||||
|
|
||||||
This is the branch guide for the FAST Tooling repository. When contributing to this project please follow the standards defined in this guide.
|
This is the branch guide for the Design to Code repository. When contributing to this project please follow the standards defined in this guide.
|
||||||
|
|
||||||
## Default
|
## Default
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
# Contributing to FAST Tooling
|
# Contributing to Design to Code
|
||||||
|
|
||||||
Contributions are welcome! You can submit a pull request to fix a bug, implementing a feature, or even correcting simple documentation typos.
|
Contributions are welcome! You can submit a pull request to fix a bug, implementing a feature, or even correcting simple documentation typos.
|
||||||
|
|
||||||
|
@ -6,11 +6,11 @@ Contributions are welcome! You can submit a pull request to fix a bug, implement
|
||||||
|
|
||||||
### Machine setup
|
### Machine setup
|
||||||
|
|
||||||
To work with the FAST Tooling [monorepo](https://en.wikipedia.org/wiki/Monorepo) you'll need Git, Node.js@^16.0.0, and npm@^7.0.0 setup on your machine.
|
To work with the Design to Code [monorepo](https://en.wikipedia.org/wiki/Monorepo) you'll need Git, Node.js@^16.0.0, and npm@^7.0.0 setup on your machine.
|
||||||
|
|
||||||
FAST Tooling uses Git as its source control system. If you haven't already installed it, you can download it [here](https://git-scm.com/downloads) or if you prefer a GUI-based approach, try [GitHub Desktop](https://desktop.github.com/).
|
Design to Code uses Git as its source control system. If you haven't already installed it, you can download it [here](https://git-scm.com/downloads) or if you prefer a GUI-based approach, try [GitHub Desktop](https://desktop.github.com/).
|
||||||
|
|
||||||
Once Git is installed, you'll also need Node.js, which FAST Tooling uses as its JavaScript runtime, enabling its build and test scripts. Node.js instructions and downloads for your preferred OS can be found [here](https://nodejs.org/en/).
|
Once Git is installed, you'll also need Node.js, which Design to Code uses as its JavaScript runtime, enabling its build and test scripts. Node.js instructions and downloads for your preferred OS can be found [here](https://nodejs.org/en/).
|
||||||
|
|
||||||
:::important
|
:::important
|
||||||
The above steps are a one-time setup for your machine and do not need to be repeated after the initial configuration.
|
The above steps are a one-time setup for your machine and do not need to be repeated after the initial configuration.
|
||||||
|
@ -18,20 +18,20 @@ The above steps are a one-time setup for your machine and do not need to be repe
|
||||||
|
|
||||||
### Cloning the repository
|
### Cloning the repository
|
||||||
|
|
||||||
Now that your machine is setup, you can clone the FAST Tooling repository. Open a terminal and run this command:
|
Now that your machine is setup, you can clone the Design to Code repository. Open a terminal and run this command:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone https://github.com/microsoft/fast-tooling.git
|
git clone https://github.com/microsoft/design-to-code.git
|
||||||
```
|
```
|
||||||
Cloning via SSH:
|
Cloning via SSH:
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
git clone git@github.com:microsoft/fast-tooling.git
|
git clone git@github.com:microsoft/design-to-code.git
|
||||||
```
|
```
|
||||||
|
|
||||||
### Installing and building
|
### Installing and building
|
||||||
|
|
||||||
From within the `fast-tooling` folder where you've cloned the repo, install all package dependencies and build all workspaces (local dependencies) with this command:
|
From within the `design-to-code` folder where you've cloned the repo, install all package dependencies and build all workspaces (local dependencies) with this command:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npm install
|
npm install
|
||||||
|
@ -106,7 +106,7 @@ Default VS Code settings for this project are configured as [Workspace settings]
|
||||||
|
|
||||||
## FAST guidance
|
## FAST guidance
|
||||||
|
|
||||||
The FAST Tooling project follows the contribution policy outlined in the FAST project for their [governance](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#governance), [acceptance and consensus seeking process](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#acceptance-and-consensus-seeking-process), and [stability policy](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#stability-policy).
|
The Design to Code project follows the contribution policy outlined in the FAST project for their [governance](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#governance), [acceptance and consensus seeking process](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#acceptance-and-consensus-seeking-process), and [stability policy](https://github.com/microsoft/fast/blob/master/CONTRIBUTING.md#stability-policy).
|
||||||
|
|
||||||
## Developer's Certificate of Origin 1.1
|
## Developer's Certificate of Origin 1.1
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# FAST Tooling
|
# Design to Code
|
||||||
|
|
||||||
This is the FAST Tooling project, containing a set of packages that can be combined to create complex workflows for web applications. The goal of these workflows is to allow users to create and modify their own web based experiences, from individual web components to completed web sites.
|
This is the Design to Code project, containing a set of packages that can be combined to create complex workflows. The goal of these workflows is to allow users to create and modify their own web based experiences, from individual web components to completed web sites.
|
||||||
|
|
||||||
This project is not to be confused with its related project [FAST](https://github.com/microsoft/fast), a set of libraries for creating native web components and design systems.
|
This project is not to be confused with its related project [FAST](https://github.com/microsoft/fast), a set of libraries for creating native web components and design systems.
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
This is the code style guide for the FAST tooling repository. When contributing to this project please follow the standards defined in this guide.
|
This is the code style guide for the Design to Code repository. When contributing to this project please follow the standards defined in this guide.
|
||||||
|
|
||||||
## Branches
|
## Branches
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
{
|
{
|
||||||
"name": "@microsoft/fast-tooling-repository",
|
"name": "@microsoft/design-to-code-repository",
|
||||||
"description": "A system of development tools, and utilities used à la carte or as a suite to build enterprise-grade websites and applications.",
|
"description": "A system of development tools, and utilities used à la carte or as a suite to build enterprise-grade websites and applications.",
|
||||||
"version": "0.1.0",
|
"version": "0.1.0",
|
||||||
"author": {
|
"author": {
|
||||||
|
@ -16,10 +16,10 @@
|
||||||
],
|
],
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/microsoft/fast-tooling.git"
|
"url": "git+https://github.com/microsoft/design-to-code.git"
|
||||||
},
|
},
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/microsoft/fast-tooling/issues/new/choose"
|
"url": "https://github.com/microsoft/design-to-code/issues/new/choose"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"bump": "beachball bump",
|
"bump": "beachball bump",
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Introduction
|
# Introduction
|
||||||
|
|
||||||
Welcome to FAST tooling, an ecosystem of packages built for the purpose of live updating JSON data.
|
Welcome to Design to Code, an ecosystem of packages built for the purpose of live updating JSON data for the purposes of designing web tech in the browser.
|
||||||
|
|
||||||
The backbone of this ecosystem is the `MessageSystem`, use this as a starting point. You can then register web components, React components, and other pieces of functionality. The `@microsoft/fast-tooling` and `@microsoft/fast-tooling-react` packages offer a selection of web components, React components, and other integrations with existing libraries that you may find useful.
|
The backbone of this ecosystem is the `MessageSystem`, use this as a starting point. You can then register web components, React components, and other pieces of functionality. The `@microsoft/fast-tooling` and `@microsoft/fast-tooling-react` packages offer a selection of web components, React components, and other integrations with existing libraries that you may find useful.
|
||||||
|
|
||||||
|
|
Загрузка…
Ссылка в новой задаче