Skip to content

Commit 283b483

Browse files
huynhicodeEisenbergEffect
andauthoredMay 26, 2022
docs: versioning prep (#5990)
* update docusaurus version to 2.0.0-beta.20 * add keywords * add md extensions to introduction file * add md extensions to getting-started file * add md extensions to fast-frame file * add md extensions to getting started readme file * add md extensions to defining-elements file * add md extensions to declaring-templates file * add md extensions to using-directives file * add md extensions to next-steps file * add md extensions to overview file * add md extensions to creating-a-compound-library file * add md extensions to design-tokens file * add md extensions to aspnet file * add md extensions to react file * update join file * add md extensions to contributing file * add md extensions to writing-documentation file * add md extensions to issue-management file * add md extensions to release-planning file * add md extensions to cheat-sheet file * add md extensions to faq file * update documentation footer * update hideable sidebar configuration for Docusaurus 2.0.0-beta.20 * Change files * minor grammar fixes Co-authored-by: Rob Eisenberg <EisenbergEffect@users.noreply.github.com>

40 files changed

+231
-153
lines changed
 

‎BRANCH_GUIDE.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ This is the branch guide for the FAST repository. When contributing to this proj
44

55
## Default
66

7-
The `master` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that it can be automatically checked for publishing.
7+
The `master` branch is the default branch. It is used for all releases pinned to the current major version. Most pull requests should be merged directly into this branch so that they can be automatically checked for publishing.
88

99
## Features
1010

11-
If a large feature or a breaking change has been defined, a feature branch may be created. To be significant enough work to require a feature branch, the work must comprise of more than one pull request. The feature branch should follow the naming convention `features/*`. This will allow GitHub workflows including the build gate to trigger on any pull request opened against the feature branch.
11+
If a large feature or a breaking change has been defined, a feature branch may be created. To be significant enough work to require a feature branch, the work must comprise of more than one pull request. The feature branch should follow the naming convention `features/*`. This will allow GitHub workflows, including the build gate, to trigger on any pull request opened against the feature branch.
1212

1313
### Changelog
1414

15-
Due to the default behavior of beachball (the package publishing utility used in this repository) the `beachball.config.js` which defaults to checking for changes against the default branch must be updated to point to the feature branch, and if necessary, allowed to add major changes. The branch creation should start by updating `beachball.config.js`, to do this refer to the [beachball options](https://github.com/microsoft/beachball/blob/master/docs/overview/configuration.md#options). This change must be reverted before inclusion to the default branch.
15+
Due to the default behavior of beachball (the package publishing utility used in this repository), the `beachball.config.js` which defaults to checking for changes against the default branch must be updated to point to the feature branch, and if necessary, allowed to add major changes. The branch creation should start by updating `beachball.config.js`, to do this refer to the [beachball options](https://github.com/microsoft/beachball/blob/master/docs/overview/configuration.md#options). This change must be reverted before inclusion to the default branch.
1616

1717
### Merging
1818

‎CODE_OF_CONDUCT.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Our Pledge
44

5-
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.
5+
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to make 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.
66

77
## Our Standards
88

@@ -19,7 +19,7 @@ Examples of unacceptable behavior by participants include:
1919
* The use of sexualized language or imagery and unwelcome sexual attention or advances
2020
* Trolling, insulting/derogatory comments, and personal or political attacks
2121
* Public or private harassment
22-
* Publishing others' private information, such as a physical or electronic address, without explicit permission
22+
* Publishing other's private information, such as a physical or electronic address, without explicit permission
2323
* Other conduct which could reasonably be considered inappropriate in a professional setting
2424

2525
## Our Responsibilities

‎CONTRIBUTING.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ yarn global add lerna
2323
```
2424

2525
:::important
26-
The above steps are a one-time setup for your machine and do not need to be repeated after the initial configuration.
26+
The above steps are a one-time set up for your machine and do not need to be repeated after the initial configuration.
2727
:::
2828

2929
### Cloning the repository
@@ -81,7 +81,7 @@ Packages are located within the `packages` folder of the repository. Each packag
8181
If you'd like to contribute by fixing a bug, implementing a feature, or even correcting typos in our documentation, you'll want to submit a pull request. Before submitting a pull request, be sure to [rebase](https://www.atlassian.com/git/tutorials/merging-vs-rebasing) your branch (typically from master) or use the *merge* button provided by GitHub.
8282

8383
:::note
84-
For additional details on branch management read the [branch guide](/docs/community/branch-guide) documentation.
84+
For additional details on branch management, read the [branch guide](../community/branch-guide.md) documentation.
8585
:::
8686

8787
#### Change Files
@@ -104,12 +104,12 @@ When working across feature branches, you'll need to target the branch using the
104104
}
105105
```
106106

107-
Running `yarn change` will walk you through a CLI process for generating change files. The process will walk you through selecting the type of change as well as ask you to provide a description of any changes. As a convenience, the utility looks to provide recent commit messages for use in the description. *For changes which do not affect the published package(s), please use "none" when selecting the change type*.
107+
Running `yarn change` will walk you through a CLI process for generating change files. The process will walk you through selecting the type of change as well as ask you to provide a description of any changes. As a convenience, the utility looks to provide recent commit messages for use in the description. *For changes that do not affect the published package(s), please use "none" when selecting the change type*.
108108

109109
More information on the change process and change types can be found on the [Beachball website](https://microsoft.github.io/beachball/cli/change.html#change).
110110

111111
:::note
112-
If you are addressing multiple issues which are unrelated, consider either doing multiple pull requests, or generate separate change files to ensure accurate generation of changelogs and versioning of packages.
112+
If you are addressing multiple issues which are unrelated, consider either doing multiple pull requests, or generating separate change files to ensure accurate generation of changelogs and versioning of packages.
113113
:::
114114

115115
:::note
@@ -151,7 +151,7 @@ When you submit a pull request, a CLA-bot automatically determines if you need t
151151

152152
## Guiding principle
153153

154-
Owners, the steering committee, collaborators, code owners, and contributors work in concert with one another on behalf of the FAST community and prioritize the communities interests over their own.
154+
Owners, the steering committee, collaborators, code owners, and contributors work in concert with one another on behalf of the FAST community and prioritize the community's interests over their own.
155155

156156
The development, release, and work management processes must reflect this principle. Accepting contributions to the project requires a review by collaborators.
157157

@@ -163,7 +163,7 @@ The development, release, and work management processes must reflect this princi
163163

164164
### Steering committee
165165

166-
*Steering committee* members are key *collaborators* who have demonstrated design or technical expertise critical to the driving the FAST project and community forward.
166+
*Steering committee* members are key *collaborators* who have demonstrated design or technical expertise critical to driving the FAST project and community forward.
167167

168168
### Collaborators
169169

@@ -180,9 +180,9 @@ As subject matter experts, *code owners* approve pull requests on the packages t
180180
### Nominations & appointments
181181

182182
* To become a *contributor*, a community member must have a pull request approved and merged into the FAST project master branch.
183-
* To become a *collaborator*, a *contributor* will petition the *steering committee* who will approve or deny the request.
184-
* To become a *code owner*, a *collaborator* will be (a) nominated by a *steering committee* member or (b) petition the *steering committee* who will approve or deny the request.
185-
* To join the *steering committee*, a *collaborator* will be nominated by a *steering committee* member and the *steering committee* who will approve or deny the request.
183+
* To become a *collaborator*, a *contributor* will petition the *steering committee*, who will approve or deny the request.
184+
* To become a *code owner*, a *collaborator* will be (a) nominated by a *steering committee* member or (b) petition the *steering committee*, who will approve or deny the request.
185+
* To join the *steering committee*, a *collaborator* will be nominated by a *steering committee* member and the *steering committee*, who will approve or deny the request.
186186

187187
## Acceptance and consensus seeking process
188188

@@ -192,12 +192,12 @@ All pull requests must be approved by an assigned *collaborator* before the pull
192192

193193
1. Reviewing the pull request if they are not the creator of it
194194
2. Adding any additional reviewers to review at their discretion
195-
3. Ensuring the the pull request is given feedback in [a reasonable period of time](#response-time) from *collaborators* or *code owners* with the expertise to evaluate the changes
195+
3. Ensuring the pull request is given feedback in [a reasonable period of time](#response-time) from *collaborators* or *code owners* with the expertise to evaluate the changes
196196
4. Merging the pull request
197197

198198
When a pull request : (a) has a significant impact on the project, (b) is inherently controversial, or (c) has not reached consensus with *collaborators*; add a "status:controversial" label to the pull request for the *steering committee* to review the pull request. Pull requests labeled with "status:controversial" are not approved until the *steering committee* reviews the issue and makes a decision.
199199

200-
Additionally, *owners*, can temporarily enable [interaction limits](https://help.github.com/articles/limiting-interactions-with-your-repository/) to allow a "cool-down" period when hot topics become disruptive.
200+
Additionally, *owners* can temporarily enable [interaction limits](https://help.github.com/articles/limiting-interactions-with-your-repository/) to allow a "cool-down" period when hot topics become disruptive.
201201

202202
Specific *collaborators* or *code owners* can be added to a pull request by including their user alias in the "Reviewers" section.
203203

@@ -207,15 +207,15 @@ The amount of time can vary but at least 3 days during the typical working week
207207

208208
## Stability policy
209209

210-
An essential consideration in every pull request is its impact on the system. To manage impacts, we work collectively to ensure that we do not introduce unnecessary breaking changes, performance or functional regressions, or negative impacts on usability for users or supported partners. To learn more about our approaches to planning and releases, see [our release planning document](/docs/community/release-planning).
210+
An essential consideration in every pull request is its impact on the system. To manage impacts, we work collectively to ensure that we do not introduce unnecessary breaking changes, performance or functional regressions, or negative impacts on usability for users or supported partners. To learn more about our approaches to planning and releases, see [our release planning document](../community/release-planning.md).
211211

212212
## Developer's Certificate of Origin 1.1
213213

214214
By making a contribution to this project, I certify that:
215215

216216
* a. The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
217217
* b. The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
218-
* c. The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
218+
* c. The contribution was provided directly to me by some other person who certified (a), (b), or (c) and I have not modified it.
219219
* d. I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.
220220

221221
## Resources

‎SECURITY.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If you believe you have found a security vulnerability in any Microsoft-owned re
1212

1313
Instead, please report them to the Microsoft Security Response Center (MSRC) at [https://msrc.microsoft.com/create-report](https://msrc.microsoft.com/create-report).
1414

15-
If you prefer to submit without logging in, send email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key; please download it from the the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
15+
If you prefer to submit without logging in, send an email to [secure@microsoft.com](mailto:secure@microsoft.com). If possible, encrypt your message with our PGP key. Please download it from the [Microsoft Security Response Center PGP Key page](https://www.microsoft.com/en-us/msrc/pgp-key-msrc).
1616

1717
You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Additional information can be found at [microsoft.com/msrc](https://www.microsoft.com/msrc).
1818

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "none",
3+
"comment": "add md extensions to referenced doc links for fast-element readme",
4+
"packageName": "@microsoft/fast-element",
5+
"email": "steph@huynhicode.dev",
6+
"dependentChangeType": "none"
7+
}
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"type": "none",
3+
"comment": "add md extensions to referenced links for integration guides",
4+
"packageName": "@microsoft/fast-foundation",
5+
"email": "steph@huynhicode.dev",
6+
"dependentChangeType": "none"
7+
}

‎packages/web-components/fast-element/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { FASTElement } from '@microsoft/fast-element';
2626
```
2727

2828
:::tip
29-
Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](https://fast.design/docs/integrations/introduction).
29+
Looking for a setup that integrates with a particular front-end framework or bundler? Check out [our integration docs](../integrations/introduction.md).
3030
:::
3131

3232
### From CDN
@@ -58,5 +58,5 @@ For simplicity, examples throughout the documentation will assume the library ha
5858
:::
5959

6060
:::tip
61-
Looking for a quick guide on building components? Check out [our Cheat Sheet](https://www.fast.design/docs/resources/cheat-sheet#building-components).
61+
Looking for a quick guide on building components? Check out [our Cheat Sheet](../resources/cheat-sheet.md#building-components).
6262
:::

‎packages/web-components/fast-element/docs/guide/declaring-templates.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,7 @@ When binding to `class`, the underlying engine will not over-write classes added
144144

145145
**Example: Nullish value**
146146

147-
Some cases may occur where an attribute needs to have a value when used however not present if unused. These are different than boolean attributes by where their presence alone triggers their effect. In this situation a nullish value (`null` or `undefined`) may be provided so the attribute won't exist in that condition.
147+
Some cases may occur where an attribute needs to have a value when used however not present if unused. These are different than boolean attributes by where their presence alone triggers their effect. In this situation, a nullish value (`null` or `undefined`) may be provided so the attribute won't exist in that condition.
148148

149149
```html
150150
<div aria-hidden="${x => x.isViewable ? 'true' : null}"></div>
@@ -218,13 +218,13 @@ The second example demonstrates an important characteristic of the templating en
218218
It is during the `connectedCallback` phase of the Custom Element lifecycle that `FASTElement` creates templates and binds the resulting view. The creation of the template only occurs the first time the element is connected, while binding happens every time the element is connected (with unbinding happening during the `disconnectedCallback` for symmetry).
219219

220220
:::note
221-
In the future we're planning new optimizations that will enable us to safely determine when we do not need to unbind/rebind certain views.
221+
In the future, we're planning new optimizations that will enable us to safely determine when we do not need to unbind/rebind certain views.
222222
:::
223223

224224
In most cases, the template that `FASTElement` renders is determined by the `template` property of the Custom Element's configuration. However, you can also implement a method on your Custom Element class named `resolveTemplate()` that returns a template instance. If this method is present, it will be called during `connectedCallback` to obtain the template to use. This allows the element author to dynamically select completely different templates based on the state of the element at the time of connection.
225225

226-
In addition to dynamic template selection during the `connectedCallback`, the `$fastController` property of `FASTElement` enables dynamically changing the template at any time through setting the controller's `template` property to any valid template.
226+
In addition to dynamic template selection during the `connectedCallback`, the `$fastController` property of `FASTElement` enables dynamically changing the template at any time by setting the controller's `template` property to any valid template.
227227

228228
:::tip
229-
Check out [our Cheat Sheet](/docs/resources/cheat-sheet#bindings) for a quick guide on bindings.
229+
Check out [our Cheat Sheet](../resources/cheat-sheet.md#bindings) for a quick guide on bindings.
230230
:::

‎packages/web-components/fast-element/docs/guide/defining-elements.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ export class NameTag extends FASTElement {
5858
To add attributes to your HTML element, create properties decorated by the `@attr` decorator. All attributes defined this way will be automatically registered with the platform so that they can be updated through the browser's native `setAttribute` API as well as the property. You can optionally add a method with the naming convention *propertyName*Changed to your class (e.g. `greeting` and `greetingChanged()`), and this method will be called whenever your property changes, whether it changes through the property or the attribute API.
5959

6060
:::note
61-
All properties decorated with `@attr` are also *observable*. See [observables and state](./observables-and-state) for information about how observables enable efficient rendering.
61+
All properties decorated with `@attr` are also *observable*. See [observables and state](./observables-and-state.md) for information about how observables enable efficient rendering.
6262
:::
6363

6464
By default, anything extending from `FASTElement` will automatically have a `ShadowRoot` attached in order to enable encapsulated rendering.
@@ -142,7 +142,7 @@ export class MyCounter extends FASTElement {
142142

143143
## The element lifecycle
144144

145-
All Web Components support a series of lifecycle events that you can tap into to execute custom code at specific points in time. `FASTElement` implements several of these callbacks automatically in order to enable features of its templating engine (described in [declaring templates](./declaring-templates)). However, you can override them to provide your own code. Here's an example of how you would execute custom code when your element is inserted into the DOM.
145+
All Web Components support a series of lifecycle events that you can tap into to execute custom code at specific points in time. `FASTElement` implements several of these callbacks automatically in order to enable features of its templating engine (described in [declaring templates](./declaring-templates.md)). However, you can override them to provide your own code. Here's an example of how you would execute custom code when your element is inserted into the DOM.
146146

147147
**Example: Tapping into the Custom Element Lifecycle**
148148

0 commit comments

Comments
 (0)
Please sign in to comment.