Skip to content

Commit 52dc0d3

Browse files
authored
docs: Update package READMEs to leverage markdown-magic header and footer templates (#22013)
Also makes a few misc. cleanup changes
1 parent ea8df2d commit 52dc0d3

File tree

74 files changed

+3579
-120
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+3579
-120
lines changed

examples/apps/attributable-map/README.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When the app loads it will update the URL. Copy that new URL into a second brows
1414

1515
![timestamp-watcher](./images/hitcounter.gif)
1616

17-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
17+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
1818

1919
<!-- prettier-ignore-start -->
2020
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -40,3 +40,46 @@ The project uses the following distributed data structures:
4040

4141
- SharedDirectory - root
4242
- AttributableMap - HitCounter
43+
44+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
45+
46+
<!-- prettier-ignore-start -->
47+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
48+
49+
## Contribution Guidelines
50+
51+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
52+
53+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
54+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
55+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
56+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
57+
58+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
59+
60+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
61+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
62+
63+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
64+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
65+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
66+
67+
## Help
68+
69+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
70+
71+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
72+
73+
Thank you!
74+
75+
## Trademark
76+
77+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
78+
79+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
80+
81+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
82+
83+
<!-- prettier-ignore-end -->
84+
85+
<!-- AUTO-GENERATED-CONTENT:END -->

examples/apps/collaborative-textarea/README.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
**Collaborative TextArea** is a basic example that creates a SharedString and uses the react CollaborativeTextArea
44
component to launch a basic collaborative HTML `<textarea>`
55

6-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
6+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
77

88
<!-- prettier-ignore-start -->
99
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -45,3 +45,46 @@ Collaborative TextArea uses the following distributed data structures:
4545

4646
- SharedDirectory - root
4747
- SharedString - stores the text
48+
49+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
50+
51+
<!-- prettier-ignore-start -->
52+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
53+
54+
## Contribution Guidelines
55+
56+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
57+
58+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
59+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
60+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
61+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
62+
63+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
64+
65+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
66+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
67+
68+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
69+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
70+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
71+
72+
## Help
73+
74+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
75+
76+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
77+
78+
Thank you!
79+
80+
## Trademark
81+
82+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
83+
84+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
85+
86+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
87+
88+
<!-- prettier-ignore-end -->
89+
90+
<!-- AUTO-GENERATED-CONTENT:END -->

examples/apps/contact-collection/README.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The specific access mechanisms can vary -- in this example, `ContactCollection`
1515

1616
For another example of this pattern, consider the `SharedDirectory` DDS. The `getWorkingDirectory()` method allows granular access to an `IDirectory` that can be used separately from the remainder of the `SharedDirectory`, despite the data being stored in the same data store. Although the details differ since it is a DDS rather than a data object, the principle is the same.
1717

18-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
18+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
1919

2020
<!-- prettier-ignore-start -->
2121
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -56,3 +56,46 @@ For in browser testing update `./jest-puppeteer.config.js` to:
5656
Contact collection uses the following distributed data structures:
5757

5858
- SharedDirectory -- root
59+
60+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
61+
62+
<!-- prettier-ignore-start -->
63+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
64+
65+
## Contribution Guidelines
66+
67+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
68+
69+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
70+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
71+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
72+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
73+
74+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
75+
76+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
77+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
78+
79+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
80+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
81+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
82+
83+
## Help
84+
85+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
86+
87+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
88+
89+
Thank you!
90+
91+
## Trademark
92+
93+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
94+
95+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
96+
97+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
98+
99+
<!-- prettier-ignore-end -->
100+
101+
<!-- AUTO-GENERATED-CONTENT:END -->

examples/apps/data-object-grid/README.md

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

33
**Data object grid** is a Fluid component that provides a grid layout for users to compose their own experiences by adding and re-arranging data objects. This example explores how modular document types could work in Fluid.
44

5-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
5+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
66

77
<!-- prettier-ignore-start -->
88
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -25,3 +25,46 @@ You can run this example using the following steps:
2525
## Data objects
2626

2727
The data-object-grid package pulls in a collection of outside data objects into a registry that enables creation and constructing views. This isolates the knowledge of how to create and render the data objects away from the core application, and makes it extensible to further data object types.
28+
29+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
30+
31+
<!-- prettier-ignore-start -->
32+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
33+
34+
## Contribution Guidelines
35+
36+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
37+
38+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
39+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
40+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
41+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
42+
43+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
44+
45+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
46+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
47+
48+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
49+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
50+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
51+
52+
## Help
53+
54+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
55+
56+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
57+
58+
Thank you!
59+
60+
## Trademark
61+
62+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
63+
64+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
65+
66+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
67+
68+
<!-- prettier-ignore-end -->
69+
70+
<!-- AUTO-GENERATED-CONTENT:END -->

examples/apps/presence-tracker/README.md

+44-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
This implementation visualizes the Container in a standalone application, rather than using the webpack-fluid-loader environment that most of our examples use. This implementation relies on [Tinylicious](/server/routerlicious/packages/tinylicious), so there are a few extra steps to get started. We bring our own view that we will bind to the data in the container.
88

9-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
9+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
1010

1111
<!-- prettier-ignore-start -->
1212
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -25,3 +25,46 @@ You can run this example using the following steps:
2525
<!-- prettier-ignore-end -->
2626

2727
<!-- AUTO-GENERATED-CONTENT:END -->
28+
29+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
30+
31+
<!-- prettier-ignore-start -->
32+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
33+
34+
## Contribution Guidelines
35+
36+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
37+
38+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
39+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
40+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
41+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
42+
43+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
44+
45+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
46+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
47+
48+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
49+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
50+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
51+
52+
## Help
53+
54+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
55+
56+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
57+
58+
Thank you!
59+
60+
## Trademark
61+
62+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
63+
64+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
65+
66+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
67+
68+
<!-- prettier-ignore-end -->
69+
70+
<!-- AUTO-GENERATED-CONTENT:END -->

examples/apps/task-selection/README.md

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

33
The task selection example demonstrates a couple different ways to pick a single client amongst the connected clients to perform a task (in this case, rolling a dice once per second). This builds upon the external-views sample as a base.
44

5-
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_GETTING_STARTED:usesTinylicious=TRUE) -->
5+
<!-- AUTO-GENERATED-CONTENT:START (EXAMPLE_README_HEADER:usesTinylicious=TRUE) -->
66

77
<!-- prettier-ignore-start -->
88
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
@@ -37,3 +37,46 @@ For in browser testing update `./jest-puppeteer.config.js` to:
3737
headless: false,
3838
},
3939
```
40+
41+
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
42+
43+
<!-- prettier-ignore-start -->
44+
<!-- NOTE: This section is automatically generated using @fluid-tools/markdown-magic. Do not update these generated contents directly. -->
45+
46+
## Contribution Guidelines
47+
48+
There are many ways to [contribute](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md) to Fluid.
49+
50+
- Participate in Q&A in our [GitHub Discussions](https://github.com/microsoft/FluidFramework/discussions).
51+
- [Submit bugs](https://github.com/microsoft/FluidFramework/issues) and help us verify fixes as they are checked in.
52+
- Review the [source code changes](https://github.com/microsoft/FluidFramework/pulls).
53+
- [Contribute bug fixes](https://github.com/microsoft/FluidFramework/blob/main/CONTRIBUTING.md).
54+
55+
Detailed instructions for working in the repo can be found in the [Wiki](https://github.com/microsoft/FluidFramework/wiki).
56+
57+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
58+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or contact [[email protected]](mailto:[email protected]) with any additional questions or comments.
59+
60+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
61+
Use of these trademarks or logos must follow Microsoft’s [Trademark & Brand Guidelines](https://www.microsoft.com/trademarks).
62+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
63+
64+
## Help
65+
66+
Not finding what you're looking for in this README? Check out [fluidframework.com](https://fluidframework.com/docs/).
67+
68+
Still not finding what you're looking for? Please [file an issue](https://github.com/microsoft/FluidFramework/wiki/Submitting-Bugs-and-Feature-Requests).
69+
70+
Thank you!
71+
72+
## Trademark
73+
74+
This project may contain Microsoft trademarks or logos for Microsoft projects, products, or services.
75+
76+
Use of these trademarks or logos must follow Microsoft's [Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
77+
78+
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
79+
80+
<!-- prettier-ignore-end -->
81+
82+
<!-- AUTO-GENERATED-CONTENT:END -->

0 commit comments

Comments
 (0)