|
1 | | -# Project |
2 | 1 |
|
3 | | -> This repo has been populated by an initial template to help get you started. Please |
4 | | -> make sure to update the content to build a great experience for community-building. |
| 2 | +# Microsoft Fabric workload development kit sample |
| 3 | +## Creating and running custom workloads on Fabric |
5 | 4 |
|
6 | | -As the maintainer of this project, please make a few updates: |
| 5 | +### Welcome |
| 6 | +Welcome to the Fabric workload development kit. This repository contains everything a Microsoft Fabric partner needs to develop and build custom workloads in Fabric, use this kit to create workloads according to your specific business needs and scenarios, and run them on Fabric with high performance, scalability, and security. |
| 7 | +The Fabric workload development kit is currently in public preview and is subject to change. As such, there may be issues or missing documentation. We kindly request you to keep this in mind while using the kit. We are working hard to ensure that the kit is as stable and reliable as possible, and we appreciate your patience and understanding during this time. |
| 8 | +If you need any further assistance, please don't hesitate to contact us at <ILDCWLSupport@microsoft.com>. |
7 | 9 |
|
8 | | -- Improving this README.MD file to provide a great experience |
9 | | -- Updating SUPPORT.MD with content about this project's support experience |
10 | | -- Understanding the security reporting process in SECURITY.MD |
11 | | -- Remove this section from the README |
12 | | - |
13 | | -## Contributing |
14 | | - |
15 | | -This project welcomes contributions and suggestions. Most contributions require you to agree to a |
16 | | -Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us |
17 | | -the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. |
18 | | - |
19 | | -When you submit a pull request, a CLA bot will automatically determine whether you need to provide |
20 | | -a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions |
21 | | -provided by the bot. You will only need to do this once across all repos using our CLA. |
22 | | - |
23 | | -This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). |
24 | | -For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or |
25 | | -contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
26 | | - |
27 | | -## Trademarks |
| 10 | +### Trademarks |
28 | 11 |
|
29 | 12 | This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft |
30 | 13 | trademarks or logos is subject to and must follow |
31 | 14 | [Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general). |
32 | 15 | Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. |
33 | 16 | Any use of third-party trademarks or logos are subject to those third-party's policies. |
| 17 | + |
| 18 | +### What's in the kit |
| 19 | +The kit contains the following components: |
| 20 | +- A sample workload that demonstrates how to create and run a Fabric workload. |
| 21 | +- A boilerplate project that provides the basic structure and configuration files for a Fabric workload, including the workload manifest, the frontend manifest, and the app settings. |
| 22 | +- A workload manifest validator that checks the validity and consistency of the workload manifest file. |
| 23 | +- A set of documentation files that explain the concepts, architecture, and steps involved in developing a Fabric workload. |
| 24 | +### How to use the kit |
| 25 | +To use the kit, you need to have access to a Fabric tenant with the workload feature and developer mode enabled. See the quick guide in [Microsoft Fabric Workload workload development kit documentation](https://go.microsoft.com/fwlink/?linkid=2272303). for more information. |
| 26 | +Once you have access to a Fabric tenant, you can follow these steps: |
| 27 | +1. Clone this repository. |
| 28 | +2. Follow the quick start guide to run the sample workload and get familiar with the workflow and the tools. |
| 29 | +3. Follow the development guide to create your own custom workload using the boilerplate project as a template. |
| 30 | + |
| 31 | +### Related content |
| 32 | +For more information about Fabric and workloads, you can refer to the following resources: |
| 33 | +- [Microsoft Fabric documentation](https://learn.microsoft.com/en-us/fabric/). |
| 34 | +- [Microsoft Fabric Workload workload development kit documentation](https://go.microsoft.com/fwlink/?linkid=2272303). |
| 35 | +- [Fabric Workload REST API documentation](https://go.microsoft.com/fwlink/?linkid=2271986). |
| 36 | +- [Microsoft Fabric Workload workload Client SDK documentation](https://go.microsoft.com/fwlink/?linkid=2271989). |
0 commit comments