Retool the portable mode documentation to explain our distributions #656

DHowett · 2023-04-12T20:01:09Z

No description provided.

learn-build-service-prod · 2023-04-12T20:02:25Z

Learn Build status updates of commit 26aaffe:

⚠️ Validation status: warnings

File	Status	Preview URL	Details
TerminalDocs/distributions.md	⚠️Warning	View	Details
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

TerminalDocs/distributions.md

Line 18, Column 9: [Warning: hard-coded-locale - See documentation] Link 'https://docs.microsoft.com/en-us/windows/msix/desktop/deploy-preinstalled-apps' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
Line 43, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'Windows Terminal Portable') are not allowed. You can only have one top-level heading.
Line 18, Column 9: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/en-us/windows/msix/desktop/deploy-preinstalled-apps' will be broken in isolated environments. Replace with a relative link.
Line 20, Column 44: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://docs.microsoft.com/windows-hardware/manufacture/desktop/preinstall-apps-using-dism' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Learn Build.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-12T20:04:44Z

Learn Build status updates of commit c90c647:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-12T20:07:03Z

Learn Build status updates of commit dc40360:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-12T20:20:02Z

Learn Build status updates of commit cfaf104:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-12T20:27:34Z

Learn Build status updates of commit ea2caf3:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-13T01:11:25Z

Learn Build status updates of commit d7be49e:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-13T01:12:35Z

Learn Build status updates of commit 8b65be2:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-13T01:21:18Z

Learn Build status updates of commit ccc34a8:

✅ Validation status: passed

File	Status	Preview URL	Details
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

learn-build-service-prod · 2023-04-14T20:32:29Z

Learn Build status updates of commit 148bacc:

✅ Validation status: passed

File	Status	Preview URL
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)
TerminalDocs/TOC.yml	✅Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

lhecker · 2023-04-14T21:11:46Z

TerminalDocs/distributions.md

+    - The unpackaged distribution does not receive automatic updates, which puts you in control of exactly when new
+      versions are installed.
+- Portable
+    - A personality of the unpackaged distribution, where Terminal stores its settings in a nearby directory.


"A personality" is a bit too complex IMO and could be too confusing for people for whom English is a secondary language, or those "people" that aren't human in the first place (also known as Bing Translate 😄).

That's fair! Thanks!

lhecker · 2023-04-14T21:12:35Z

TerminalDocs/distributions.md

+    - When installed via preinstallation kit, Terminal will receive automatic updates through the Store.
+- Unpackaged, or "ZIP" (new in 1.17 stable)
+    - This distribution method was not officially supported until stable channel version 1.17.
+    - A `.zip` file that contains Windows Terminal.


I think this bullet point is mostly self-explanatory, since it says "ZIP" 2 lines above.

lhecker · 2023-04-14T21:13:21Z

TerminalDocs/distributions.md

+globally, e.g. on systems where you may not have permission to install MSIX packages or download software from the
+Microsoft Store.
+
+Portable mode allows you to carry around (and archive!) a preconfigured installation of Windows Terminal and run it from


I think "to carry around and archive" would be better.

I would rephase to "or archive" in that case

learn-build-service-prod · 2023-04-19T22:08:49Z

Learn Build status updates of commit d8e0e1b:

✅ Validation status: passed

File	Status	Preview URL
TerminalDocs/distributions.md	✅Succeeded	View
TerminalDocs/portable-mode.md	✅Succeeded	n/a (file deleted or renamed)
TerminalDocs/TOC.yml	✅Succeeded	View

For more details, please refer to the build report.

For any questions, please:

Try searching the learn.microsoft.com contributor guides
Post your question in the Learn support channel

* Stashed dynamic SSH profiles doc * Add portable mode docs to release branch 1.18 (#655) * added first draft of docs * changed headings and subheadings * Reword, add an Upgrading section --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> * Retool the portable mode documentation to explain our distributions (#656) * Retool portable mode to be 'distributions' * Fix warnings * add preinstallation to the feature matrix * add dci to matrix * reword * couple more notes * better version note * Use a data matrix table, re-alt-text the portable mode image * add distributions to the toc * address L's feedbacc * Document 'activeOnly' value for 'showCloseButton' property. (#660) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * Document 'activeOnly' value for 'showCloseButton' property. --------- Co-authored-by: Christopher Nguyen <91625426+nguyen-dows@users.noreply.github.com> * Add a small section on tab tearout in the overview page (#666) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * initial commit * added preview links and small grammatical fixes * added important preview flag * moved Important flag to the end of the section to fit Actions docs * omit unrelated changes that got pulled in from master * omit actions and profiles changes * Add preview text and re-add missing enableReadOnlyMode docs (#673) * add preview text and readd enableReadOnlyMode that was lost in the most recent commit * add preview text for activeOnly value in showCloseButton property docs --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> Co-authored-by: kovdu <koen.vandurme@gmail.com>

* fix(powerline): update oh-my-posh CLI (#632) * Themes updates for 1.17 (#634) Documents a whole pile of stuff from 1.17: * `useMica` microsoft/terminal#13935 * theme pairs microsoft/terminal#14497 * scheme pairs microsoft/terminal#14064 * closes #626 * Default prompt icon info, resolves #625 (#642) * Add app execution alias section (#643) * Add autoHideWindows Resolves #633 * Add color theme FAQs * Remove code brackets from headers Resolves #637 * Fix default if no command specified Called out in #638 * Add note differentiating null from no setting for Starting Directory. Resolves #624 * add the adobe-target metadata for A/B testing (#646) could you please help to merge this metadata change (adobe-target=true) to main branch and then to live? This is to enable A/B testing ability across many url base paths so we can improve Learn user experience based on data-driven decisions. This meta (adobe-target) itself will not change how your content is displayed or modify any other UI behaviors so it is safe to merge. * Add documentation to include information about enable/disable read-only mode functionality (#645) * Update actions to include new enable and disable functionality * Update panes to include new enable and disable functionality * Many updates to commandline args docs, and some missing actions too (#649) * Many updates to commandline args docs, and some missing actions too * Fix anchor link warnings --------- Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com> * Remove Dynamic SSH profiles from doc since it has not been implemente… (#650) * Remove Dynamic SSH profiles from doc since it has not been implemented yet. * Updated authors and date * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * remove instances of Preview for 1.15 features (#669) * remove enableReadOnlyMode and disableReadyOnlyMode docs in panes until it goes live in a future release (#672) * Update Docs with Release 1.18 (#674) * Stashed dynamic SSH profiles doc * Add portable mode docs to release branch 1.18 (#655) * added first draft of docs * changed headings and subheadings * Reword, add an Upgrading section --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> * Retool the portable mode documentation to explain our distributions (#656) * Retool portable mode to be 'distributions' * Fix warnings * add preinstallation to the feature matrix * add dci to matrix * reword * couple more notes * better version note * Use a data matrix table, re-alt-text the portable mode image * add distributions to the toc * address L's feedbacc * Document 'activeOnly' value for 'showCloseButton' property. (#660) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * Document 'activeOnly' value for 'showCloseButton' property. --------- Co-authored-by: Christopher Nguyen <91625426+nguyen-dows@users.noreply.github.com> * Add a small section on tab tearout in the overview page (#666) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * initial commit * added preview links and small grammatical fixes * added important preview flag * moved Important flag to the end of the section to fit Actions docs * omit unrelated changes that got pulled in from master * omit actions and profiles changes * Add preview text and re-add missing enableReadOnlyMode docs (#673) * add preview text and readd enableReadOnlyMode that was lost in the most recent commit * add preview text for activeOnly value in showCloseButton property docs --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> Co-authored-by: kovdu <koen.vandurme@gmail.com> --------- Co-authored-by: Jan De Dobbeleer <2492783+JanDeDobbeleer@users.noreply.github.com> Co-authored-by: Mike Griese <migrie@microsoft.com> Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com> Co-authored-by: juchen-ms <partychen.acm@gmail.com> Co-authored-by: Alex Noble <6237394+Swinkid@users.noreply.github.com> Co-authored-by: Dustin Howett <duhowett@microsoft.com> Co-authored-by: kovdu <koen.vandurme@gmail.com>

…ocs (#678) * fix(powerline): update oh-my-posh CLI (#632) * Themes updates for 1.17 (#634) Documents a whole pile of stuff from 1.17: * `useMica` microsoft/terminal#13935 * theme pairs microsoft/terminal#14497 * scheme pairs microsoft/terminal#14064 * closes #626 * Default prompt icon info, resolves #625 (#642) * Add app execution alias section (#643) * Add autoHideWindows Resolves #633 * Add color theme FAQs * Remove code brackets from headers Resolves #637 * Fix default if no command specified Called out in #638 * Add note differentiating null from no setting for Starting Directory. Resolves #624 * add the adobe-target metadata for A/B testing (#646) could you please help to merge this metadata change (adobe-target=true) to main branch and then to live? This is to enable A/B testing ability across many url base paths so we can improve Learn user experience based on data-driven decisions. This meta (adobe-target) itself will not change how your content is displayed or modify any other UI behaviors so it is safe to merge. * Add documentation to include information about enable/disable read-only mode functionality (#645) * Update actions to include new enable and disable functionality * Update panes to include new enable and disable functionality * Many updates to commandline args docs, and some missing actions too (#649) * Many updates to commandline args docs, and some missing actions too * Fix anchor link warnings --------- Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com> * Remove Dynamic SSH profiles from doc since it has not been implemente… (#650) * Remove Dynamic SSH profiles from doc since it has not been implemented yet. * Updated authors and date * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * remove instances of Preview for 1.15 features (#669) * remove enableReadOnlyMode and disableReadyOnlyMode docs in panes until it goes live in a future release (#672) * Update Docs with Release 1.18 (#674) * Stashed dynamic SSH profiles doc * Add portable mode docs to release branch 1.18 (#655) * added first draft of docs * changed headings and subheadings * Reword, add an Upgrading section --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> * Retool the portable mode documentation to explain our distributions (#656) * Retool portable mode to be 'distributions' * Fix warnings * add preinstallation to the feature matrix * add dci to matrix * reword * couple more notes * better version note * Use a data matrix table, re-alt-text the portable mode image * add distributions to the toc * address L's feedbacc * Document 'activeOnly' value for 'showCloseButton' property. (#660) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * Document 'activeOnly' value for 'showCloseButton' property. --------- Co-authored-by: Christopher Nguyen <91625426+nguyen-dows@users.noreply.github.com> * Add a small section on tab tearout in the overview page (#666) * Shelfing read-only mode docs until it goes in a future release (#653) * Added maximum history size (#657) * added maximum history size * empty commit to poke the bot * initial commit * added preview links and small grammatical fixes * added important preview flag * moved Important flag to the end of the section to fit Actions docs * omit unrelated changes that got pulled in from master * omit actions and profiles changes * Add preview text and re-add missing enableReadOnlyMode docs (#673) * add preview text and readd enableReadOnlyMode that was lost in the most recent commit * add preview text for activeOnly value in showCloseButton property docs --------- Co-authored-by: Dustin Howett <duhowett@microsoft.com> Co-authored-by: kovdu <koen.vandurme@gmail.com> * Add a tutorial for enabling shell integration (#676) * it's basically just the blog post * fix urls * Right-click context menu, allowHeadless docs (#677) * right-click context menu docs * allowHeadless too while I'm here --------- Co-authored-by: Jan De Dobbeleer <2492783+JanDeDobbeleer@users.noreply.github.com> Co-authored-by: Mike Griese <migrie@microsoft.com> Co-authored-by: Matt Wojciakowski <mattwoj@microsoft.com> Co-authored-by: juchen-ms <partychen.acm@gmail.com> Co-authored-by: Alex Noble <6237394+Swinkid@users.noreply.github.com> Co-authored-by: Dustin Howett <duhowett@microsoft.com> Co-authored-by: kovdu <koen.vandurme@gmail.com>

Retool portable mode to be 'distributions'

26aaffe

Fix warnings

c90c647

add preinstallation to the feature matrix

dc40360

add dci to matrix

cfaf104

reword

ea2caf3

DHowett added 2 commits April 12, 2023 20:09

couple more notes

d7be49e

better version note

8b65be2

Use a data matrix table, re-alt-text the portable mode image

ccc34a8

add distributions to the toc

148bacc

lhecker approved these changes Apr 14, 2023

View reviewed changes

address L's feedbacc

d8e0e1b

nguyen-dows merged commit 0c71ed8 into release-1.18 Apr 19, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Retool the portable mode documentation to explain our distributions #656

Retool the portable mode documentation to explain our distributions #656

DHowett commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

learn-build-service-prod bot commented Apr 13, 2023

learn-build-service-prod bot commented Apr 13, 2023

learn-build-service-prod bot commented Apr 13, 2023

learn-build-service-prod bot commented Apr 14, 2023

lhecker Apr 14, 2023

DHowett Apr 14, 2023

lhecker Apr 14, 2023

lhecker Apr 14, 2023

DHowett Apr 14, 2023

learn-build-service-prod bot commented Apr 19, 2023

Retool the portable mode documentation to explain our distributions #656

Retool the portable mode documentation to explain our distributions #656

Conversation

DHowett commented Apr 12, 2023

learn-build-service-prod bot commented Apr 12, 2023

⚠️ Validation status: warnings

TerminalDocs/distributions.md

learn-build-service-prod bot commented Apr 12, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 12, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 12, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 12, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 13, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 13, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 13, 2023

✅ Validation status: passed

learn-build-service-prod bot commented Apr 14, 2023

✅ Validation status: passed

lhecker Apr 14, 2023

Choose a reason for hiding this comment

DHowett Apr 14, 2023

Choose a reason for hiding this comment

lhecker Apr 14, 2023

Choose a reason for hiding this comment

lhecker Apr 14, 2023

Choose a reason for hiding this comment

DHowett Apr 14, 2023

Choose a reason for hiding this comment

learn-build-service-prod bot commented Apr 19, 2023

✅ Validation status: passed