Skip to content
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

docs: Add Sign in with Uno page (backport #18741) #18781

Merged
merged 8 commits into from
Nov 13, 2024
Merged
Binary file added doc/articles/Assets/uno-settings-main.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-rider.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-vs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-vsc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/articles/Assets/uno-settings-welcome.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
15 changes: 14 additions & 1 deletion doc/articles/common-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,17 @@ The Uno Platform features and support are constantly evolving, yet you may encou

A better resource for high-level questions about Uno Platform is the [general FAQ](xref:Uno.Development.FAQ).

## Sign in with Uno Platform

Sign in with your Uno Platform account directly in your favorite IDE—Visual Studio, VS Code, or Rider, to unlock powerful tools like Hot Reload, helping you speed up development.

More detailed information is available [here](xref:Uno.GetStarted.Licensing).

## Hot Reload

More troubleshooting information is available [in this section](xref:Uno.Features.HotReload#troubleshooting).
When using Hot Reload, ensure you first review the [supported features](xref:Uno.Features.HotReload#features), [supported features per OS](xref:Uno.Features.HotReload#supported-features-per-os), and [supported features per platform](xref:Uno.Features.HotReload#supported-features-per-platform).

If issues persist, additional troubleshooting information is available in [this section](xref:Uno.Features.HotReload#troubleshooting).

## Development Environments

Expand All @@ -28,6 +36,11 @@ More troubleshooting information is available [in this section](xref:Uno.Feature
- [Common issues on iOS/mac Catalyst](xref:Uno.UI.CommonIssues.IosCatalyst)
- [Common issues on UWP](xref:Uno.UI.CommonIssues.UWP)

## Build Errors

- [Troubleshooting build errors](xref:Uno.Development.Troubleshooting)
- [Build error codes](xref:Build.Solution.error-codes)

## Next Steps

Learn more about:
Expand Down
10 changes: 9 additions & 1 deletion doc/articles/create-an-app-rider.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,15 @@ Creating an Uno Platform project is done [using dotnet new](xref:Uno.GetStarted.
---

> [!IMPORTANT]
> A notification window will appear for the free registration of the extension. If the notification disappears before you can enter the license, you can find it again in the "Notification Bell" icon at the top right of the Rider window.
> A notification should appear prompting you to sign in or register with Uno Platform.
>
> Signing in with your Uno Platform account in Rider unlocks powerful tools like Hot Reload, helping you speed up development.
>
> With a single registration, you also gain early access to new features and the opportunity to connect with the Uno Platform community, where you can share feedback and network.
>
> Detailed information on registration and sign-in is available <a href="https://aka.platform.uno/account-access" target="_blank">here</a>.
>
> ![Uno Platform Sign in / Register notification](Assets/uno-settings-rider-notification.png)

### Considerations for macOS and Linux

Expand Down
11 changes: 11 additions & 0 deletions doc/articles/create-an-app-vs2022.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,17 @@ To create an Uno Platform app:
1. A banner at the top of the editor may ask to reload projects, click **Reload projects**:
![Visual Studio - A banner indicating to reload projects](Assets/quick-start/vs2022-project-reload.png)

1. > [!IMPORTANT]
> A notification should appear prompting you to sign in or register with Uno Platform.
>
> Signing in with your Uno Platform account in Visual Studio unlocks powerful tools like Hot Reload, helping you speed up development.
>
> With a single registration, you also gain early access to new features and the opportunity to connect with the Uno Platform community, where you can share feedback and network.
>
> Detailed information on registration and sign-in is available <a href="https://aka.platform.uno/account-access" target="_blank">here</a>.
>
> ![Uno Platform sign in / register notification](Assets/uno-settings-notification.png)

## Debug the App

### [**Desktop**](#tab/desktop)
Expand Down
12 changes: 10 additions & 2 deletions doc/articles/create-an-app-vscode.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,16 @@ Next, open the project using Visual Studio Code:
* Visual Studio Code might ask to restore the NuGet packages. Allow it to restore them if asked.
* Once the solution has been loaded, in the status bar at the bottom left of VS Code, `MyApp.sln` is selected by default. Select `MyApp.csproj` to load the project instead.

> [!IMPORTANT]
> A notification window will appear for the free registration of the extension. If the notification disappears before you can enter the license, you can find it again in the "Notification Bell" icon at the bottom right of the VS Code window.
* > [!IMPORTANT]
> A notification should appear prompting you to sign in or register with Uno Platform.
>
> Signing in with your Uno Platform account in Visual Studio Code unlocks powerful tools like Hot Reload, helping you speed up development.
>
> With a single registration, you also gain early access to new features and the opportunity to connect with the Uno Platform community, where you can share feedback and network.
>
> Detailed information on registration and sign-in is available <a href="https://aka.platform.uno/account-access" target="_blank">here</a>.
>
> ![Uno Platform Sign in / Register notification](Assets/uno-settings-vsc-notification.png)

## Debug the App

Expand Down
102 changes: 102 additions & 0 deletions doc/articles/get-started-licensing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
---
uid: Uno.GetStarted.Licensing
---

# Sign in with Uno Platform

Sign in with your Uno Platform account directly in your favorite IDE (Visual Studio, VS Code, or Rider), to unlock powerful tools like Hot Reload, helping you speed up development. With a single registration, you also get early access to new features and the opportunity to connect with the Uno Platform community to share feedback and network.

## Create your account

1. Go to our website, [platform.uno](https://platform.uno/), and click on the **Sign in** button in the top right corner, or go directly to [platform.uno/my-account](https://platform.uno/my-account).
1. Enter your email address and click on **Register**.
1. On the registration page, fill in your information. Once done, click on **Sign up**.
1. You will receive a confirmation email from `no-reply@platform.uno`. Follow the instructions in the email to activate your account.
1. You should then see the sign-in page. Enter your email and password and click on **Sign in** to access your account details, where you can update information or add more details.

## Sign in to your IDE of choice

After creating your Uno Platform account, follow the steps below to sign in to your preferred IDE:

**I am developing on...**

### [**Visual Studio 2022**](#tab/vs2022)

If you’ve already set up **Visual Studio 2022** by following the [Get Started on Visual Studio 2022](xref:Uno.GetStarted.vs2022) documentation, sign in as follows:

1. Create a new Uno Platform project by following the [Creating an app with Visual Studio 2022](xref:Uno.GettingStarted.CreateAnApp.VS2022) documentation or open an existing one with Uno.Sdk version 5.5 or higher.

For existing applications, you should take this opportunity to update to the [latest `Uno.Sdk` version](https://www.nuget.org/packages/Uno.Sdk).

1. After your project has finished loading, a notification should appear. Click on the **Sign in / Register** button.

![Visual Studio 2022 notification](Assets/uno-settings-notification.png)

> [!TIP]
> Ensure that the lower left IDE icon shows a check mark and says "Ready" ![A checkmark with a text saying ready](getting-started/wizard/assets/vs2022-ready-statusbar.png). This ensures that the projects have been created, and their dependencies have been restored completely.
>
> [!NOTE]
> If the notification doesn’t appear, access the Settings app by clicking on **Extensions** > **Uno Platform** > **Settings...**.
>
> ![Visual Studio 2022 Menu](Assets/uno-settings-vs.png)

### [**Visual Studio Code**](#tab/vscode)

If you’ve already set up **Visual Studio Code** by following the [Get Started on VS Code](xref:Uno.GetStarted.vscode) documentation, sign in as follows:

1. Create a new Uno Platform project by following the [Creating an app with VS Code](xref:Uno.GettingStarted.CreateAnApp.VSCode) documentation or open an existing one with Uno.Sdk version 5.5 or higher.

For existing applications, you should take this opportunity to update to the [latest `Uno.Sdk` version](https://www.nuget.org/packages/Uno.Sdk).

1. After your project has finished loading, a notification should appear. Click on the **Sign in / Register** button.

![Visual Studio Code notification](Assets/uno-settings-vsc-notification.png)

> [!NOTE]
> If the notification doesn’t appear, access the Settings app by selecting **View** > **Command Palette...** and typing `Uno Platform: Open Settings`.
>
> ![Visual Studio Code Menu](Assets/uno-settings-vsc.png)

### [**JetBrains Rider**](#tab/rider)

If you’ve already set up **JetBrains Rider** by following the [Get Started on JetBrains Rider](xref:Uno.GetStarted.Rider) documentation, sign in as follows:

1. Create a new Uno Platform project by following the [Create an app with JetBrains Rider](xref:Uno.GettingStarted.CreateAnApp.Rider) documentation or open an existing one with Uno.Sdk version 5.5 or higher.

For existing applications, you should take this opportunity to update to the [latest `Uno.Sdk` version](https://www.nuget.org/packages/Uno.Sdk).

1. After your project has finished loading, a notification should appear. Click on the **Sign in / Register** button.

![JetBrains Rider notification](Assets/uno-settings-rider-notification.png)

> [!NOTE]
> If the notification doesn’t appear, access the Settings app by selecting **Tools** > **Uno Platform** > **Settings...**.
>
> ![JetBrains Rider Menu](Assets/uno-settings-rider.png)

---

### Uno Platform Settings window

1. In the Uno Platform Settings window, click on **Sign in**. You’ll be redirected to your browser to enter your Uno Platform account credentials.

![Uno Platform Settings Welcome](Assets/uno-settings-welcome.png)

1. Once signed in, you’ll see a confirmation of your account along with your license details.

You can then use the **Hot Reload** feature to speed up your workflow and test changes in real-time. For more information, refer to the [Hot Reload documentation](xref:Uno.Features.HotReload).

![Uno Platform Settings signed in](Assets/uno-settings-main.png)

> [!TIP]
> You can also access a menu where you can select **My Account** to view your account details, **Refresh** the account changes, and **Sign out**.
>
> ![Uno Platform Settings Menu](Assets/uno-settings-menu.png)

1. After you are done, feel free to close the Uno Platform Settings window. You can always access it again from your IDE menu by following the steps above.

## Questions

For general questions about Uno Platform, refer to the [general FAQ](xref:Uno.Development.FAQ) or see the [troubleshooting section](xref:Uno.UI.CommonIssues) for common issues and solutions.

If you encounter any issues or need further assistance, join our [Discord server](https://platform.uno/discord), connect with us via [GitHub](https://github.com/unoplatform/uno/discussions), or reach out on our [contact page](https://platform.uno/contact).
53 changes: 35 additions & 18 deletions doc/articles/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,24 +32,41 @@
- name: Troubleshoot
topicHref: xref:Uno.UI.CommonIssues
items:
- name: All Development Environments
href: xref:Uno.UI.CommonIssues.AllIDEs
- name: Visual Studio 2022 for Windows
href: xref:Uno.UI.CommonIssues.vs2022
- name: VS Code
href: xref:Uno.UI.CommonIssues.vscode
- name: WebAssembly
href: xref:Uno.UI.CommonIssues.Wasm
- name: UWP
href: xref:Uno.UI.CommonIssues.UWP
- name: Skia (Gtk/Wpf/Framebuffer)
href: xref:Uno.UI.CommonIssues.Skia
- name: iOS/mac Catalyst
href: xref:Uno.UI.CommonIssues.IosCatalyst
- name: Troubleshooting build errors
href: uno-builds-troubleshooting.md
- name: Build error codes
href: xref:Build.Solution.error-codes
- name: Overview
href: xref:Uno.UI.CommonIssues
- name: Sign in with Uno Platform
href: xref:Uno.GetStarted.Licensing
- name: Hot Reload
topicHref: xref:Uno.Features.HotReload#troubleshooting
- name: Development Environments
topicHref: xref:Uno.UI.CommonIssues.AllIDEs
items:
- name: All Development Environments
href: xref:Uno.UI.CommonIssues.AllIDEs
- name: Visual Studio 2022 for Windows
href: xref:Uno.UI.CommonIssues.vs2022
- name: VS Code
href: xref:Uno.UI.CommonIssues.vscode
- name: Rider
href: xref:Uno.UI.CommonIssues.rider
- name: Platforms
topicHref: xref:Uno.UI.CommonIssues.Wasm
items:
- name: WebAssembly
href: xref:Uno.UI.CommonIssues.Wasm
- name: UWP
href: xref:Uno.UI.CommonIssues.UWP
- name: Skia (Gtk/Wpf/Framebuffer)
href: xref:Uno.UI.CommonIssues.Skia
- name: iOS/mac Catalyst
href: xref:Uno.UI.CommonIssues.IosCatalyst
- name: Build Errors
topicHref: xref:Uno.Development.Troubleshooting
items:
- name: Troubleshooting build errors
href: xref:Uno.Development.Troubleshooting
- name: Build error codes
href: xref:Build.Solution.error-codes

- name: Samples & Tutorials
topicHref: xref:Uno.SamplesTutorials.Overview
Expand Down
Loading