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 remaining 1.5 release features #176

Merged
merged 15 commits into from
Nov 11, 2020
Merged

Conversation

cinnamon-msft
Copy link
Collaborator

@cinnamon-msft cinnamon-msft commented Nov 10, 2020

  • Documented disableAnimations
  • Documented rowsToScroll for scrollUp and scrollDown
  • Added preview labels

@opbld31
Copy link

opbld31 commented Nov 10, 2020

Docs Build status updates of commit 86dd89b:

⚠️ Validation status: warnings

File Status Preview URL Details
TerminalDocs/customize-settings/global-settings.md ⚠️Warning View Details
TerminalDocs/customize-settings/actions.md 💡Suggestion View Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

TerminalDocs/customize-settings/global-settings.md

  • Line 203, Column 186: [Warning-file-not-found] Invalid file link: './actions'.

TerminalDocs/customize-settings/actions.md

  • Line 680, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 700, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.

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 Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings 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:

@opbld30
Copy link

opbld30 commented Nov 10, 2020

Docs Build status updates of commit d75e52b:

⚠️ Validation status: warnings

File Status Preview URL Details
TerminalDocs/customize-settings/global-settings.md ⚠️Warning View Details
TerminalDocs/customize-settings/actions.md 💡Suggestion View Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

TerminalDocs/customize-settings/global-settings.md

  • Line 203, Column 186: [Warning-file-not-found] Invalid file link: './actions'.

TerminalDocs/customize-settings/actions.md

  • Line 680, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 700, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.

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 Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings 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:

TerminalDocs/command-line-arguments.md Outdated Show resolved Hide resolved
If you'd like to enter a `wt` command into the command palette, you can do so by starting with the `>` character. This will run the `wt` command in the current window. More information on `wt` commands can be found on the [Command line arguments page](./command-line-arguments.md).
If you'd like to enter a `wt` command into the command palette, you can do so by deleting the `>` character in the text box. This will run the `wt` command in the current window. More information on `wt` commands can be found on the [Command line arguments page](./command-line-arguments.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Do we need new gifs?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Oh yep, I'll make one later tonight

TerminalDocs/customize-settings/actions.md Show resolved Hide resolved
@@ -662,7 +666,7 @@ ___

### Scroll up

This scrolls the screen up.
This scrolls the screen up by the number of rows defined by `"rowsToScroll"`. If `"rowsToScroll"` is not provided, it will scroll up the amount defined by the system default, which is the same amount as mouse scrolling.
Copy link
Contributor

Choose a reason for hiding this comment

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

Didn't we kill rowsToScroll?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The global setting got killed, this just got added here: microsoft/terminal#7924

Comment on lines 103 to 119
### Enable tab switcher

When this is set to `true`, the `nextTab` and `prevTab` commands will use the tab switcher UI. The UI will show all the currently open tabs in a vertical list, navigable with the keyboard or mouse.

The tab switcher will open on the initial press of the actions for `nextTab` and `prevTab`, and will stay open as long as a modifier key is held down. When all modifier keys are released, the switcher will close and the highlighted tab will be focused. <kbd>tab</kbd>/<kbd>shift+tab</kbd>, the <kbd>up</kbd> and <kbd>down</kbd> arrow keys, and the `nextTab`/`prevTab` actions can be used to cycle through the switcher UI.

**Property name:** `useTabSwitcher`

**Necessity:** Optional

**Accepts:** `true`, `false`

**Default value:** `true`

> [!CAUTION]
> The `useTabSwitcher` setting is no longer available in versions 1.5 and later. It is recommended that you use the `tabSwitcherMode` setting instead.

Copy link
Contributor

Choose a reason for hiding this comment

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

It's not clear that this only exists for legacy purposes.

The caution is also misleading. It is available still. In fact, it's literally the same as tabSwitcherMode. It's just been renamed and we're suggesting you don't use it because it's old.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

We're treating it as deprecated, so I added the same message that we have for rowsToScroll. We'll eventually not support this setting I'd imagine.

Copy link
Contributor

Choose a reason for hiding this comment

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

oh we can finally nuke rowstoscroll since we're out of its support range!

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

nuke == remove from docs yeah?

Copy link
Contributor

Choose a reason for hiding this comment

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

ya


Controls what happens when the application emits a BEL character. When set to `"audible"`, the Terminal will play a sound. When set to `"none"`, nothing will happen.
Controls what happens when the application emits a BEL character. When set to `"audible"`, the terminal will play a sound. When set to `"none"`, nothing will happen.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Controls what happens when the application emits a BEL character. When set to `"audible"`, the terminal will play a sound. When set to `"none"`, nothing will happen.
Controls what happens when the application emits a BEL character. When set to `"audible"`, the Terminal will play a sound. When set to `"none"`, nothing will happen.

I thought we specifically want to use cap T here? Idk. We might be inconsistent with this :/

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The docs should all have lowercase t for this, unless we missed a few from community contributions.

Co-authored-by: Carlos Zamora <carlos.zamora@microsoft.com>
@opbld32
Copy link

opbld32 commented Nov 11, 2020

Docs Build status updates of commit 3cc6e57:

🕙 Pending: waiting for processors (6 builds ahead of you)

⚠️ Docs Build is busy, currently there are 6 builds ahead of this one, for more information you can view the Build queue graph on the Docs Portal.

@opbld32
Copy link

opbld32 commented Nov 11, 2020

Docs Build status updates of commit 3cc6e57:

⚠️ Validation status: warnings

File Status Preview URL Details
TerminalDocs/customize-settings/global-settings.md ⚠️Warning View Details
TerminalDocs/customize-settings/actions.md 💡Suggestion View Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

TerminalDocs/customize-settings/global-settings.md

  • Line 203, Column 186: [Warning-file-not-found] Invalid file link: './actions'.

TerminalDocs/customize-settings/actions.md

  • Line 680, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.
  • Line 700, Column 1: [Suggestion-table-syntax-invalid] Table syntax is invalid. Ensure your table includes a header and is surrounded by empty lines. NOTE: This Suggestion will become a Warning on 1/29/21.

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 Docs Build.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

Note: Your PR may contain errors or warnings 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:

@opbld32
Copy link

opbld32 commented Nov 11, 2020

Docs Build status updates of commit 2af6d77:

🕙 Pending: waiting for processors (11 builds ahead of you)

⚠️ Docs Build is busy, currently there are 11 builds ahead of this one, for more information you can view the Build queue graph on the Docs Portal.

@opbld32
Copy link

opbld32 commented Nov 11, 2020

Docs Build status updates of commit bffc8b6:

🕙 Pending: waiting for processors (17 builds ahead of you)

⚠️ Docs Build is busy, currently there are 17 builds ahead of this one, for more information you can view the Build queue graph on the Docs Portal.

@opbld33
Copy link

opbld33 commented Nov 11, 2020

Docs Build status updates of commit bffc8b6:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/actions.md ✅Succeeded View
TerminalDocs/customize-settings/global-settings.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld31
Copy link

opbld31 commented Nov 11, 2020

Docs Build status updates of commit 1a004be:

🕙 Pending: waiting for processors (22 builds ahead of you)

⚠️ Docs Build is busy, currently there are 22 builds ahead of this one, for more information you can view the Build queue graph on the Docs Portal.

@opbld32
Copy link

opbld32 commented Nov 11, 2020

Docs Build status updates of commit 1a004be:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/actions.md ✅Succeeded View
TerminalDocs/customize-settings/global-settings.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@opbld30
Copy link

opbld30 commented Nov 11, 2020

Docs Build status updates of commit c9aa4ed:

✅ Validation status: passed

File Status Preview URL Details
TerminalDocs/command-line-arguments.md ✅Succeeded View
TerminalDocs/command-palette.md ✅Succeeded View
TerminalDocs/customize-settings/actions.md ✅Succeeded View
TerminalDocs/customize-settings/global-settings.md ✅Succeeded View
TerminalDocs/customize-settings/profile-settings.md ✅Succeeded View
TerminalDocs/images/command-palette-command-line-mode.gif ✅Succeeded View
TerminalDocs/troubleshooting.md ✅Succeeded View
TerminalDocs/tutorials/powerline-setup.md ✅Succeeded View

For more details, please refer to the build report.

Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report.

For any questions, please:

@cinnamon-msft cinnamon-msft merged commit 9508aee into release-1.5 Nov 11, 2020
@cinnamon-msft cinnamon-msft deleted the cinnamon/release-1.5 branch November 11, 2020 17:45
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.

7 participants