Skip to content

Commit

Permalink
feat(docs): Show how to enable opt-in features to devs/contributors. (#…
Browse files Browse the repository at this point in the history
…859)

We don't show Landscape config page nor the subscribe button by default.
Those willing to test those features by hand need to enable them
explicitly via the Windows registry, since #835 .
  • Loading branch information
CarlosNihelton authored Aug 7, 2024
2 parents 1185b81 + 4db8262 commit a573e39
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/.custom_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ zshrc
ESM
Ok

# Registry keys
# Registry keys and types
DWORD
UbuntuPro
UbuntuProToken
LandscapeConfig
2 changes: 2 additions & 0 deletions docs/custom_conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@

# Linkcheck does not have access to the repo
'https://github.com/canonical/ubuntu-pro-for-wsl/*',
# This page redirects to SSO login:
'https://ubuntu.com/pro/dashboard',
]

# Pages on which to ignore anchors
Expand Down
29 changes: 29 additions & 0 deletions docs/dev/howto/07-enable-opt-in-features.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# How to enable opt-in features

Some features in UP4W are opt-in. While the code is arranged such that CI
always tests with those features enabled, when running UP4W on your machine,
you need to enable them explicitly via the Windows registry. This guide shows
you how to do that.

## Enable Landscape configuration in the GUI

1. Open the Windows registry editor: press `Win + R`, type `regedit` and press `Enter`.
1. Navigate to the following key: `HKEY_CURRENT_USER\Software\Canonical\UbuntuPro\`.
1. Create a new DWORD value named `ShowLandscapeConfig` and set it to `1`.

The next time you open the GUI, you'll find that the Landscape configuration
page can be shown via the set up wizard or by clicking on the 'Configure
Landscape' button.

## Enable subscribing via the Microsoft Store

1. Open the Windows registry editor: press `Win + R`, type `regedit` and press `Enter`.
1. Navigate to the following key: `HKEY_CURRENT_USER\Software\Canonical\UbuntuPro\`.
1. Create a new DWORD value named `AllowStorePurchase` and set it to `1`.

The next time you open the GUI you'll find the button to subscribe to Ubuntu
Pro via the Microsoft Store.

```{warning}
Beware that can incur in real charges if you proceed with the purchase.
```
1 change: 1 addition & 0 deletions docs/dev/howto/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,6 @@ These how-to guides cover key operations and processes in Ubuntu Pro for WSL.
Install UP4W <02-install>
Restart UP4W <03-restart>
Access UP4W logs <06-access-the-logs>
Enable opt-in features <07-enable-opt-in-features>
Reset UP4W <reset-factory>
```

0 comments on commit a573e39

Please sign in to comment.