File and link cleanup.

Jason Gore 2018-05-24 11:28:49 -07:00
Родитель dc408b9029
Коммит 25adb944d7
15 изменённых файлов: 39 добавлений и 46 удалений

@ -66,7 +66,7 @@ All styles must also be registered through this module instead of being put dire
See the documentation for more details on implementation.
### `styling` package
The new and recommended way is the [styling package](./Styling.md) in this repo.
The new and recommended way is the [styling package](Styling) in this repo.
Styles are defined in a JSON format and managed in code, avoiding issues like specificity and providing a typesafe surface for customization.
The theme itself gets passed to the component. As the theme changes, the state of the component changes as well, and it will modify its own CSS to match.

10
Contributing/Bug-Fixes.md Normal file

@ -0,0 +1,10 @@
## Contributing bug fixes
Please use the following steps to contribute bug fixes
* Setup your branch using instructions in [Git branch Setup](Setup)
* Code and test the bug fix.
* Test the fix and make sure all the tests are passing.

@ -1,10 +0,0 @@
## Contributing bug fixes
Please use the following steps to contribute bug fixes
* Setup your branch using instructions in [Git branch Setup](./Setup.md)
* Code and test the bug fix.
* Test the fix and make sure all the tests are passing.

@ -3,11 +3,11 @@
Please use the following steps to contribute a new component or a bug fix to the Office UI Fabric project.
* Setup your branch using instructions in [Git branch Setup](./Setup.md).
* Setup your branch using instructions in [Git branch Setup](Setup).
* Read [BugFix](./BugFixes.md) guide for preparing a bug fix and the [New Component](./NewComponent.md) guide for building a new component.
* Read [BugFix](Bug-Fixes) guide for preparing a bug fix and the [New Component](New-Component) guide for building a new component.
* Run `npm run change` and provide component details. Please read the [ChangeFiles](./ChangeFiles.md) document for more details on providing change instructions.
* Run `npm run change` and provide component details. Please read the [Change-Files](Change-Files) document for more details on providing change instructions.
* Push the changes to your remote branch.

@ -12,7 +12,7 @@ This document describes how to setup your development environment and contribute
## Building
If you do not wish to contribute chages to the **office-ui-fabric-react** project, please follow the instructions on the [README](../README.md) page. Else, keep reading.
If you do not wish to contribute chages to the **office-ui-fabric-react** project, please follow the instructions on the [README](HOME) page. Else, keep reading.
## Creating your own fork

29
FAQ.md

@ -12,9 +12,9 @@ These components are also used by third party developers building extensiblity c
## *Q. How do I get started with Office UI Fabric React?*
Start with our [README](./README.md) document.
Start with our [README](HOME) document.
To create your first app using Office UI Fabric React read the [Sample App](./ghdocs/OnBoarding/SampleApp.md) document.
To create your first app using Office UI Fabric React read the [Sample App](Sample-App) document.
## *Q. Where is the official website located?*
@ -83,7 +83,7 @@ We have a very active community both outside and inside Microsoft. Please use th
## *Q. How do I contribute to Office UI Fabric React?*
Start by reading our [Contributing](./ghdocs/Contributing/Contributing.md) document. Please point out any missing or incorrect details.
Start by reading our [Contributing](Contributing) document. Please point out any missing or incorrect details.
## *Q. Can I become a part of the Fabric core team?*
@ -97,21 +97,14 @@ We are very proactive and work hard to keep the outstanding pull request count l
Please refer to the following documents.
[**Contributing fixes and new components**](./ghdocs/Contributing/Contributing.md)
[**Accessibility**](./ghdocs/BestPractices/Accessibility.md)
[**Component Design**](./ghdocs/BestPractices/ComponentDesign.md)
[**Styling**](./ghdocs/BestPractices/Styling.md)
[**Theming**](./ghdocs/BestPractices/Theming.md)
[**Testing**](./ghdocs/BestPractices/Testing.md)
[**Advanced**](./ghdocs/BestPractices/Advanced.md)
[**Browse Support**](./ghdocs/Testing/BrowserSupport.md)
* [**Contributing fixes and new components**](Contributing)
* [**Accessibility**](Accessibility)
* [**Component Design**](Component-Design)
* [**Styling**](Styling)
* [**Theming**](Theming)
* [**Testing**](Testing)
* [**Advanced**](Advanced-Usage)
* [**Browse Support**](Browser-Support)
## *Q. When and how does the issue Triage work?*

@ -22,7 +22,7 @@ Fabric React is a responsive, mobile-first collection of robust components desig
### Using Fabric React
[Here is a step by step tutorial](SampleApp) on how to build a simple React app with an Office UI Fabric React component.
[Here is a step by step tutorial](Sample-App) on how to build a simple React app with an Office UI Fabric React component.
Integrating components into your project depends heavily on your setup. The recommended setup is to use a bundler such as Webpack which can resolve NPM package imports in your code and can bundle the specific things you import.
@ -51,7 +51,7 @@ ReactDOM.render(
## Browser support
Fabric React supports many commonly used browsers. See the [browser support doc](BrowserSupport) for more information.
Fabric React supports many commonly used browsers. See the [browser support doc](Browser-Support) for more information.
## Server-side rendering
@ -125,11 +125,11 @@ In Jest:
## Advanced usage
For advanced usage including info about module vs. path-based imports, using an AMD bundler like Require, and deployment features, see our [advanced documentation](AdvancedUsage).
For advanced usage including info about module vs. path-based imports, using an AMD bundler like Require, and deployment features, see our [advanced documentation](Advanced-Usage).
## Contribute to Fabric React
Please take a look at our [contribution guidelines](Contributing) for more info. Also read [Contribute Bug fixes](BugFixes) and [Contribute New component](NewComponent).
Please take a look at our [contribution guidelines](Contributing) for more info. Also read [Contribute Bug fixes](Bug-Fixes) and [Contribute New component](New-Component).
## Building the repo

@ -1,6 +1,6 @@
### Using office-ui-fabric-react
### Usage
* [Configuring your environment](Configuring-your-environment)
* [Create a simple app](SampleApp)
* [Create a simple app](Sample-App)
* [The Fabric component](The-Fabric-Component)
* [Using icons](Using-icons)
* [Use componentRef instead of ref](Using-componentRef-instead-of-ref)
@ -10,25 +10,25 @@
* [CLA](CLA)
* [Overview](Contributing)
* [Setup](Setup)
* [Fixing Bugs](BugFixes)
* [Change Files](ChangeFiles)
* [Fixing Bugs](Bug-Fixes)
* [Change Files](Change-Files)
### Creating New Components
* [Setting Up Local Workspace](Setting-Up-Local-Workspace)
* [Creating the Component](NewComponent)
* [Creating the Component](New-Component)
* [Documenting](Using-markdown-for-Fabric-documentation)
### Best Practices
* [Accessibility](Accessibility)
* [Advanced Usage](AdvancedUsage)
* [Component Design](ComponentDesign)
* [Deprecation Guidelines](DeprecationGuidelines)
* [Advanced Usage](Advanced-Usage)
* [Component Design](Component-Design)
* [Deprecation Guidelines](Deprecation-Guidelines)
* [Styling](Styling)
* [Testing](Testing)
* [Theming](Theming)
### References
* [Browser Support](BrowserSupport)
* [Browser Support](Browser-Support)
* [mergeStyles reference](mergeStyles)
* [Migration from 4.x to 5.x](Fabric5)
* [SCSS to mergeStyles](SCSS-to-mergeStyles)