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

Add FAQ section to Portable Mode Docs #797

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Conversation

nguyen-dows
Copy link
Collaborator

Add a FAQ section to the Portable Mode docs and address #665

Copy link

Learn Build status updates of commit 226208c:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/distributions.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

### Portable mode FAQs

#### Why don't ms-appdata URLs work in Portable mode?
Prior to portable mode, a common heuristic to reference images in `settings.json` would be to use `ms-appdata:///Local`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

heuristic feels like a very strange word to use here. This is more of a "practice".

#### Why don't ms-appdata URLs work in Portable mode?
Prior to portable mode, a common heuristic to reference images in `settings.json` would be to use `ms-appdata:///Local`.

Portable mode promises a terminal that is encapsulated in a separate folder (i.e. a flash drive). References to `ms-appdata` will not work in Portable mode however references `ms-appx` will.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly this doesn't explain why it doesn't work.

Suggested change
Portable mode promises a terminal that is encapsulated in a separate folder (i.e. a flash drive). References to `ms-appdata` will not work in Portable mode however references `ms-appx` will.
Portable mode offers a self-contained Terminal installation, where user data and application data are stored in the same place. As there is no separate user data folder, references to such folder (e.g. with `ms-appdata`) will not work.
To refer to paths relative to the application install directory, use an `ms-appx:` URL.
To refer to paths relative to the settings directory, use the environment variable `%WT_SETTINGS_DIR%`.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants