-
Notifications
You must be signed in to change notification settings - Fork 473
Project Reunion Docs #6
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
21 commits
Select commit
Hold shift + click to select a range
e6bc42f
added docs folder and updated README
mevey b1fbf8e
Fixed gitignore conflict
mevey 0a81e7b
Added doc templates
mevey c7b6d8a
removing developer guides for now
mevey 5b3fb51
landing readme structure
mevey b82d52f
image changes
mevey 196c910
Landing cleanup
mevey 214dd7e
All but faq
mevey 00a1971
tweaks
mevey c2b7878
FAQ
mevey 9e0c1a3
tweaks
mevey 07fbf83
Landing cleanup
mevey 0805fb2
implmented review comments
mevey a815d21
Merge branch 'master' into docs
mevey 2b429c0
added privacy clause
mevey a5871c7
bolding stufff
mevey a635989
final docs
mevey b3348aa
Fixing links
mevey 20f3d45
project reunion docs
mevey 8294a90
remove images
mevey e329830
project reunion docs
mevey File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -350,4 +350,4 @@ healthchecksdb | |
| MigrationBackup/ | ||
|
|
||
| # Ionide (cross platform F# VS Code tools) working folder | ||
| .ionide/ | ||
| .ionide/ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| # Documentation | ||
|
|
||
| * [High level overview](https://github.com/microsoft/ProjectReunion/blob/master/README.md) - Why we're doing this. | ||
| * [Roadmap](roadmap.md) - Where we're going. We're following a roadmap that | ||
| gets us to building a first version of Project Reunion exploring some basic common features. | ||
| [You can help by filing issues for features you'd like to see](https://github.com/microsoft/ProjectReunion/issues/new/choose)! | ||
| * [Contributor guide](contributor-guide.md) - How to contribute to Project Reunion. | ||
| * [FAQ](faq.md) - frequently asked questions about Project Reunion. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| ## Contributing | ||
|
|
||
| _We want to hear from you!_ | ||
|
|
||
| File a [new issue!](https://github.com/microsoft/ProjectReunion/issues/new/choose) Tell us what problem you're | ||
| trying to solve, how you've tried to solve it so far, and what would be the ideal solution for your app. Bonus | ||
| points if there's a gist or existing repo we can look at with you. | ||
|
|
||
|
|
||
| 1. **[Ask a question](https://github.com/microsoft/ProjectReunion/issues/new?assignees=&labels=question&template=question.md&title=Question%3A+%5Byour+question+here%5D)**<br> | ||
| Also, have a look at our [frequently asked questions](faq.md) page which we will update often. | ||
|
|
||
| 2. **[Start a discussion](https://github.com/microsoft/ProjectReunion/issues/new?assignees=&labels=discussion&template=discussion.md&title=Discussion%3A+%5Byour+title+here%5D+)**<br> | ||
| Discussions can be about any topics or ideas related to Project Reunion.For example, | ||
| you might start a Discussion issue to see if others are interested in a cool new idea | ||
| you've been thinking about that isn't quite ready to be filed as a more formal Feature Proposal. | ||
|
|
||
| 3. **[Make a feature proposal](https://github.com/microsoft/ProjectReunion/issues/new?assignees=&labels=feature+proposal&template=feature-proposal.md&title=)**<br> | ||
| What components do you want to see in Project Reunion? For example you can propose a new API on an existing type, or an idea for a new API. | ||
| It's fine if you don't have all the details: you can start with a summary and rationale. | ||
|
|
||
|
|
||
| **Over time, we will add Project Reunion code and samples into this repo and provide code contribution/developer guidelines.** | ||
|
|
||
|
|
||
| Most contributions require you to agree to a | ||
| Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us | ||
| the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. | ||
|
|
||
| When you submit a pull request, a CLA bot will automatically determine whether you need to provide | ||
| a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions | ||
| provided by the bot. You will only need to do this once across all repos using our CLA. | ||
|
|
||
| This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). | ||
| For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or | ||
| contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,46 @@ | ||
| # Frequently Asked Questions | ||
| We will update this page periodically. | ||
|
mevey marked this conversation as resolved.
|
||
|
|
||
| ### 1. How do I start using Project Reunion in my app? | ||
| If you have a Desktop Win32 or UWP app there are multiple components available now. | ||
|
|
||
| These components are available for you to use now and adhere to the �Project Reunion Family Promise� | ||
| that they have a single API for use in all kinds of applications. | ||
| - **[WinUI 3 for XAML](https://github.com/microsoft/microsoft-ui-xaml)** in your Win32 app helps you | ||
| build fluent UX with the ease of XAML. This component is part of the Project Reunion | ||
| Family of functionality, building on the identity + packaging + deployment transparent ideas that | ||
| Project Reunion supports for your app as well. | ||
| - **[C++/WinRT](https://github.com/microsoft/cppwinrt)**, | ||
| **[RUST/WinRT](https://github.com/microsoft/winrt-rs)**, | ||
| and **[C#/WinRT](https://github.com/microsoft/cswinrt)** | ||
| provide language-native projections of Windows, Project Reunion, | ||
| and your own custom types defined in metadata. Consume APIs from the Windows Kit, produce them for | ||
| use by other supported projections, create your own new language projections. | ||
| - **[MSIX](https://docs.microsoft.com/en-us/windows/msix/overview)** and | ||
| **[MSIX-Core](https://github.com/microsoft/msix-packaging)** | ||
| let you package your application for distribution to Windows Desktop machines | ||
| via the store or your own delivery pipeline. MSIX-Core lets you use the reuse parts of the MSIX | ||
| packaging story on older versions of Windows. | ||
|
|
||
| _Coming soon_ | ||
| - **[Microsoft Edge�s WebView2](https://docs.microsoft.com/en-us/microsoft-edge/webview2)** | ||
|
|
||
| [Tell us what other components you'd like to see as part of the Project reunion Family](https://github.com/microsoft/ProjectReunion/issues/new/choose) | ||
|
|
||
| ### 2. Do I need to be packaged to use Project Reunion? | ||
|
mevey marked this conversation as resolved.
|
||
| Your app does not need to be packaged to use Project Reunion functionality. | ||
|
|
||
| If you are packaged using either a Universal Windows Application package or a Desktop Bridge package, | ||
| referencing the NuGet package is enough to start using Project Reunion right away. | ||
|
|
||
| If you have your own installer, we�ll have instructions to carry the Project Reunion components with your app | ||
| and how to install them using some common installers. | ||
|
|
||
|
|
||
| ### 3. How do I contribute? | ||
| Use this repo�s GitHub Issues to [ask questions, start a discussion or make a feature proposal](https://github.com/microsoft/ProjectReunion/issues/new/choose). | ||
|
mevey marked this conversation as resolved.
|
||
|
|
||
|
|
||
|
|
||
|
|
||
| ##### I don�t see my question here! [Create an issue to ask a question or start a discussion](https://github.com/microsoft/ProjectReunion/issues/new/choose). | ||
|
mevey marked this conversation as resolved.
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| # Roadmap | ||
|
|
||
| Project Reunion is an umbrella of work that we will develop together over time. | ||
| Here's how we intend to roll out Project Reunion. | ||
| <table> | ||
| <tbody> | ||
| <tr> | ||
| <th>//BUILD 2020</th> | ||
| <th>End of 2020</th> | ||
| <th>2021++</th> | ||
| </tr> | ||
| <tr> | ||
| <td> | ||
| <ul> | ||
| <li>WinUI preview for UWP & Win32</li> | ||
| <li>Windows Virtual Desktop</li> | ||
| <li>WebView2 Preview</li> | ||
| <li>GitHub repo for Project Reunion</li> | ||
| <li>Engineering in the open</li> | ||
| </ul> | ||
| </td> | ||
| <td> | ||
| <ul> | ||
| <li>WinUi Preview for UWP & Win32</li> | ||
| <li>Project Reunion Preview</li> | ||
| </ul> | ||
| </td> | ||
| <td> | ||
| <ul> | ||
| <li>Multiple releases per year</li> | ||
| <li>Continue expanding existing app compatibility</li> | ||
| <li>Continue delivery of new capabilities</li> | ||
| </ul> | ||
| </td> | ||
| </tr> | ||
| </tbody> | ||
| </table> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.