From e0d789a2c6f2dd9904bfa0aeef993594bffc5104 Mon Sep 17 00:00:00 2001 From: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Date: Mon, 13 Nov 2023 17:52:31 +0000 Subject: [PATCH 1/7] Remove Desktop and CLI stub articles from Get Started (#45743) Co-authored-by: Kevin Heis --- .../desktop/overview/about-github-desktop.md | 3 +++ .../get-started/using-github/github-cli.md | 17 -------------- .../using-github/github-desktop.md | 22 ------------------- content/get-started/using-github/index.md | 4 +--- .../github-cli/github-cli/about-github-cli.md | 1 + 5 files changed, 5 insertions(+), 42 deletions(-) delete mode 100644 content/get-started/using-github/github-cli.md delete mode 100644 content/get-started/using-github/github-desktop.md diff --git a/content/desktop/overview/about-github-desktop.md b/content/desktop/overview/about-github-desktop.md index 36a7946e54..168eb6e387 100644 --- a/content/desktop/overview/about-github-desktop.md +++ b/content/desktop/overview/about-github-desktop.md @@ -6,6 +6,9 @@ versions: feature: desktop redirect_from: - /desktop/installing-and-configuring-github-desktop/overview/about-github-desktop + - /github/getting-started-with-github/github-desktop + - /github/getting-started-with-github/using-github/github-desktop + - /get-started/using-github/github-desktop --- {% data variables.product.prodname_desktop %} is a free, open source application that helps you to work with files hosted on {% data variables.product.prodname_dotcom %} or other Git hosting services. diff --git a/content/get-started/using-github/github-cli.md b/content/get-started/using-github/github-cli.md deleted file mode 100644 index 466a9aaaf3..0000000000 --- a/content/get-started/using-github/github-cli.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -title: GitHub CLI -intro: '{% data reusables.cli.cli-intro %}' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - CLI ---- - -{% data reusables.cli.about-cli %} - -{% data reusables.cli.cli-features %} - -For more information, see "[AUTOTITLE](/github-cli)." diff --git a/content/get-started/using-github/github-desktop.md b/content/get-started/using-github/github-desktop.md deleted file mode 100644 index c4df6fedd2..0000000000 --- a/content/get-started/using-github/github-desktop.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: GitHub Desktop -intro: '{% data variables.product.prodname_desktop %} extends and simplifies your Git and {% data variables.product.prodname_dotcom %} workflow using a visual interface.' -versions: - fpt: '*' - ghes: '*' - ghae: '*' - ghec: '*' -topics: - - Desktop -redirect_from: - - /github/getting-started-with-github/github-desktop - - /github/getting-started-with-github/using-github/github-desktop ---- - -## About {% data variables.product.prodname_desktop %} - -{% data reusables.desktop.about-github-desktop %} - -## Sharing feedback - -If you have feedback or feature requests, you can open an issue in the [`desktop/desktop` repository](https://github.com/desktop/desktop). diff --git a/content/get-started/using-github/index.md b/content/get-started/using-github/index.md index 05ed295d61..3a40f38ffb 100644 --- a/content/get-started/using-github/index.md +++ b/content/get-started/using-github/index.md @@ -10,11 +10,9 @@ versions: ghae: '*' ghec: '*' children: + - /connecting-to-github - /exploring-early-access-releases-with-feature-preview - /supported-browsers - - /connecting-to-github - - /github-cli - - /github-desktop - /github-mobile - /keyboard-shortcuts - /github-command-palette diff --git a/content/github-cli/github-cli/about-github-cli.md b/content/github-cli/github-cli/about-github-cli.md index 63ef79f3c1..ba63d65e2d 100644 --- a/content/github-cli/github-cli/about-github-cli.md +++ b/content/github-cli/github-cli/about-github-cli.md @@ -13,6 +13,7 @@ redirect_from: - /github/getting-started-with-github/github-cli - /github/getting-started-with-github/using-github/github-cli - /actions/guides/managing-github-actions-with-github-cli + - /get-started/using-github/github-cli --- ## About {% data variables.product.prodname_cli %} From c457258e0e4cccfe9e87b5d7bd9667cc549a50b5 Mon Sep 17 00:00:00 2001 From: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Date: Mon, 13 Nov 2023 17:52:41 +0000 Subject: [PATCH 2/7] Create "Accessibility" category in Get Started (#45738) Co-authored-by: Kevin Heis --- content/account-and-profile/index.md | 1 - .../managing-notifications-from-your-inbox.md | 2 +- .../managing-user-account-settings/index.md | 1 - .../managing-accessibility-settings.md | 4 ++-- .../referential-content-type.md | 2 +- .../github-command-palette.md | 2 ++ content/get-started/accessibility/index.md | 14 ++++++++++++++ .../keyboard-shortcuts.md | 5 +++-- .../accessibility}/managing-your-theme-settings.md | 3 ++- content/get-started/index.md | 3 ++- content/get-started/using-github/index.md | 2 -- .../basic-writing-and-formatting-syntax.md | 2 +- .../about-task-lists.md | 2 +- .../using-saved-replies.md | 2 +- .../about-project-boards.md | 2 +- .../about-pull-requests.md | 2 +- .../using-files/navigating-code-on-github.md | 2 +- .../about-searching-on-github.md | 2 +- .../searching-on-github/finding-files-on-github.md | 2 +- .../for-more-info-project-keyboard-shortcuts.md | 2 +- .../search_issues_and_pull_requests_shortcut.md | 2 +- 21 files changed, 37 insertions(+), 22 deletions(-) rename content/get-started/{using-github => accessibility}/github-command-palette.md (99%) create mode 100644 content/get-started/accessibility/index.md rename content/get-started/{using-github => accessibility}/keyboard-shortcuts.md (99%) rename content/{account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings => get-started/accessibility}/managing-your-theme-settings.md (93%) diff --git a/content/account-and-profile/index.md b/content/account-and-profile/index.md index 71bd6457cc..0176d5c715 100644 --- a/content/account-and-profile/index.md +++ b/content/account-and-profile/index.md @@ -12,7 +12,6 @@ featuredLinks: - '{% ifversion ghae %}/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/personalizing-your-profile{% endif %}' - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications popular: - - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository - /account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications diff --git a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md index 2c23c0df2f..aca931dd54 100644 --- a/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md +++ b/content/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md @@ -40,7 +40,7 @@ You have several options for triaging notifications from your inbox. | Read | Marks a notification as read. To only view read notifications in your inbox, use the `is:read` query. This query doesn't include notifications marked as **Done**. | Unread | Marks notification as unread. To only view unread notifications in your inbox, use the `is:unread` query. | -To see the available keyboard shortcuts, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#notifications)." +To see the available keyboard shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#notifications)." Before choosing a triage option, you can preview your notification's details first and investigate. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/viewing-and-triaging-notifications/triaging-a-single-notification)." diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md index afe37ae167..30a673bfd3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/index.md @@ -17,7 +17,6 @@ topics: - Accounts children: - /about-your-personal-dashboard - - /managing-your-theme-settings - /managing-your-tab-size-rendering-preference - /changing-your-github-username - /permission-levels-for-a-personal-account-repository diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md index 15424015b7..b2259d1d50 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-accessibility-settings.md @@ -41,7 +41,7 @@ You can control whether links in text blocks on {% data variables.location.produ You can perform actions across the {% data variables.product.product_name %} website by using your keyboard alone. Keyboard shortcuts can be useful to save time, but can be activated accidentally or interfere with assistive technology. -By default, all keyboard shortcuts are enabled on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts)." +By default, all keyboard shortcuts are enabled on {% data variables.product.product_name %}. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.accessibility_settings %} @@ -50,7 +50,7 @@ By default, all keyboard shortcuts are enabled on {% data variables.product.prod - To disable shortcut keys that don't use modifiers keys like Control or Command, under "General", deselect **Character keys**. - If you disable character keys, you may still be able to trigger shortcuts for your web browser, and you can still trigger shortcuts for {% data variables.product.product_name %} that use a modifier key. {%- ifversion command-palette %} - - To customize the keyboard shortcuts for triggering the command palette, under "Command palette", use the drop-down menus to choose a keyboard shortcut. For more information, see "[AUTOTITLE](/get-started/using-github/github-command-palette)." + - To customize the keyboard shortcuts for triggering the command palette, under "Command palette", use the drop-down menus to choose a keyboard shortcut. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)." {%- endif %} {% ifversion motion-management %} diff --git a/content/contributing/style-guide-and-content-model/referential-content-type.md b/content/contributing/style-guide-and-content-model/referential-content-type.md index a19fc10046..2d145feff1 100644 --- a/content/contributing/style-guide-and-content-model/referential-content-type.md +++ b/content/contributing/style-guide-and-content-model/referential-content-type.md @@ -34,7 +34,7 @@ For the referential content template, see "[AUTOTITLE](/contributing/writing-for ## Examples of referential content - Referential articles - - [AUTOTITLE](/get-started/using-github/keyboard-shortcuts) + - [AUTOTITLE](/get-started/accessibility/keyboard-shortcuts) - [AUTOTITLE](/enterprise-cloud@latest/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise) - [AUTOTITLE](/free-pro-team@latest/rest/reference/billing) in the REST API documentation - [AUTOTITLE](/graphql/reference/mutations) in the GraphQL API documentation diff --git a/content/get-started/using-github/github-command-palette.md b/content/get-started/accessibility/github-command-palette.md similarity index 99% rename from content/get-started/using-github/github-command-palette.md rename to content/get-started/accessibility/github-command-palette.md index b3d6d7678f..9bb23ab963 100644 --- a/content/get-started/using-github/github-command-palette.md +++ b/content/get-started/accessibility/github-command-palette.md @@ -4,6 +4,8 @@ intro: 'Use the command palette in {% data variables.product.product_name %} to versions: feature: command-palette shortTitle: GitHub Command Palette +redirect_from: + - /get-started/using-github/github-command-palette --- {% data reusables.command-palette.beta-note %} diff --git a/content/get-started/accessibility/index.md b/content/get-started/accessibility/index.md new file mode 100644 index 0000000000..6316ea4a2b --- /dev/null +++ b/content/get-started/accessibility/index.md @@ -0,0 +1,14 @@ +--- +title: Accessibility +intro: Learn about accessibility features and settings on GitHub. +versions: + fpt: '*' + ghec: '*' + ghae: '*' + ghes: '*' +children: + - /managing-your-theme-settings + - /keyboard-shortcuts + - /github-command-palette +--- + diff --git a/content/get-started/using-github/keyboard-shortcuts.md b/content/get-started/accessibility/keyboard-shortcuts.md similarity index 99% rename from content/get-started/using-github/keyboard-shortcuts.md rename to content/get-started/accessibility/keyboard-shortcuts.md index 561fb63ff9..970d31ffcc 100644 --- a/content/get-started/using-github/keyboard-shortcuts.md +++ b/content/get-started/accessibility/keyboard-shortcuts.md @@ -8,6 +8,7 @@ redirect_from: - /articles/keyboard-shortcuts - /github/getting-started-with-github/keyboard-shortcuts - /github/getting-started-with-github/using-github/keyboard-shortcuts + - /get-started/using-github/keyboard-shortcuts versions: fpt: '*' ghes: '*' @@ -22,7 +23,7 @@ Typing ? on {% data variables.product.prodname_dotcom %} brings up a You can disable character key shortcuts, while still allowing shortcuts that use modifier keys, in your accessibility settings. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-accessibility-settings)."{% endif %} {% ifversion command-palette %} -The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[AUTOTITLE](/get-started/using-github/github-command-palette)."{% endif %} +The {% data variables.product.prodname_command_palette %} also gives you quick access to a wide range of actions, without the need to remember keyboard shortcuts. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)."{% endif %} The following sections list some of the available keyboard shortcuts, organized by the pages where you can use them on {% data variables.location.product_location %}. @@ -33,7 +34,7 @@ The following sections list some of the available keyboard shortcuts, organized |S or / | Focus the search bar. For more information, see "[AUTOTITLE](/search-github/getting-started-with-searching-on-github/about-searching-on-github)." |G N | Go to your notifications. For more information, see "[AUTOTITLE](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/about-notifications)." |Esc | When focused on a user, issue, or pull request hovercard, closes the hovercard and refocuses on the element the hovercard is in -{% ifversion command-palette %}|Command+K (Mac) or
Ctrl+K (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Command+Option+K or Ctrl+Alt+K. For more information, see "[AUTOTITLE](/get-started/using-github/github-command-palette)."{% endif %} +{% ifversion command-palette %}|Command+K (Mac) or
Ctrl+K (Windows/Linux) | Opens the {% data variables.product.prodname_command_palette %}. If you are editing Markdown text, open the command palette with Command+Option+K or Ctrl+Alt+K. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)."{% endif %} ## Repositories diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings.md b/content/get-started/accessibility/managing-your-theme-settings.md similarity index 93% rename from content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings.md rename to content/get-started/accessibility/managing-your-theme-settings.md index aa7a7b344a..30a9c404fd 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings.md +++ b/content/get-started/accessibility/managing-your-theme-settings.md @@ -13,6 +13,7 @@ redirect_from: - /github/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings - /account-and-profile/setting-up-and-managing-your-github-user-account/managing-user-account-settings/managing-your-theme-settings - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings + - /account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-user-account-settings/managing-your-theme-settings shortTitle: Manage theme settings --- @@ -41,7 +42,7 @@ If you have low vision, you may benefit from a high contrast theme, with greater {% note %} -**Note:** You can also change your theme settings with the command palette. For more information, see "[AUTOTITLE](/get-started/using-github/github-command-palette)". +**Note:** You can also change your theme settings with the command palette. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)". {% endnote %} diff --git a/content/get-started/index.md b/content/get-started/index.md index bbda481dd9..11f9caf25d 100644 --- a/content/get-started/index.md +++ b/content/get-started/index.md @@ -39,7 +39,7 @@ featuredLinks: - /get-started/quickstart/set-up-git - /get-started/using-github-docs/about-versions-of-github-docs - /get-started/quickstart/github-glossary - - /get-started/using-github/keyboard-shortcuts + - /get-started/accessibility/keyboard-shortcuts guideCards: - /get-started/learning-about-github/types-of-github-accounts - /get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github @@ -55,6 +55,7 @@ children: - /learning-about-github - /signing-up-for-github - /using-github + - /accessibility - /writing-on-github - /exploring-projects-on-github - /getting-started-with-git diff --git a/content/get-started/using-github/index.md b/content/get-started/using-github/index.md index 3a40f38ffb..6ca63437ec 100644 --- a/content/get-started/using-github/index.md +++ b/content/get-started/using-github/index.md @@ -14,8 +14,6 @@ children: - /exploring-early-access-releases-with-feature-preview - /supported-browsers - /github-mobile - - /keyboard-shortcuts - - /github-command-palette - /allowing-access-to-githubs-services-from-a-restricted-network - /troubleshooting-connectivity-problems --- diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index f404dda1fd..a03610b312 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -58,7 +58,7 @@ Quoted text is indented, with a different type color. {% note %} -**Note:** When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing R. You can quote an entire comment by clicking {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then **Quote reply**. For more information about keyboard shortcuts, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts)." +**Note:** When viewing a conversation, you can automatically quote text in a comment by highlighting the text, then typing R. You can quote an entire comment by clicking {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then **Quote reply**. For more information about keyboard shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." {% endnote %} diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md index cc708705ec..057e7f31ee 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists.md @@ -38,7 +38,7 @@ If you add a task list to the body of an issue, the list has added functionality - To help you track your team's work on an issue, the progress of an issue's task list appears in various places on {% data variables.product.product_name %}, such as a repository's list of issues. - If a task references another issue and someone closes that issue, the task's checkbox will automatically be marked as complete. -- If a task requires further tracking or discussion, you can convert the task to an issue by hovering over the task and clicking {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. To add more details before creating the issue, you can use keyboard shortcuts to open the new issue form. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#issues-and-pull-requests)." +- If a task requires further tracking or discussion, you can convert the task to an issue by hovering over the task and clicking {% octicon "issue-opened" aria-label="The issue opened icon" %} in the upper-right corner of the task. To add more details before creating the issue, you can use keyboard shortcuts to open the new issue form. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#issues-and-pull-requests)." - Any issues referenced in the task list will specify that they are tracked in the referencing issue. ![Screenshot of a {% data variables.product.prodname_dotcom %} issue showing a task list under the header "Features." Some items are checked as done, others unchecked as undone. Three list items link to other {% data variables.product.prodname_github_issues %}.](/assets/images/help/writing/task-list-rendered.png) diff --git a/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md b/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md index b096e51610..2986c8c089 100644 --- a/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md +++ b/content/get-started/writing-on-github/working-with-saved-replies/using-saved-replies.md @@ -22,7 +22,7 @@ versions: {% tip %} **Tips:** -- You can use a keyboard shortcut to autofill the comment with a saved reply. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#comments)." +- You can use a keyboard shortcut to autofill the comment with a saved reply. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#comments)." - You can filter the list by typing the title of the saved reply. {% endtip %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md index c5511f23f1..ea7a52d5fb 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards.md @@ -69,4 +69,4 @@ For more information on automation for {% data variables.product.prodname_projec - "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/copying-a-project-board)"{% endif %} - "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/tracking-work-with-project-boards/adding-issues-and-pull-requests-to-a-project-board)" - "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)" -- "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#project-boards)" +- "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#project-boards)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md index 050419b462..27fd3d500d 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests.md @@ -47,7 +47,7 @@ After you're happy with the proposed changes, you can merge the pull request. If {% tip %} **Tips:** -- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts)." +- To toggle between collapsing and expanding all outdated review comments in a pull request, hold down OptionAltAlt and click **Show outdated** or **Hide outdated**. For more shortcuts, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." - You can squash commits when merging a pull request to gain a more streamlined view of changes. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." {% endtip %} diff --git a/content/repositories/working-with-files/using-files/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md index 64d83c918e..b016498146 100644 --- a/content/repositories/working-with-files/using-files/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -49,7 +49,7 @@ To learn more about these approaches, see "[Precise and search-based navigation] Future releases will add _precise code navigation_ for more languages, which is a code navigation approach that can give more accurate results. -{% ifversion code-search-code-view %}You can use keyboard shortcuts to navigate within a code file. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#navigating-within-code-files)."{% endif %} +{% ifversion code-search-code-view %}You can use keyboard shortcuts to navigate within a code file. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#navigating-within-code-files)."{% endif %} {% ifversion code-search-code-view %} diff --git a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md index 567b28d456..89c2fec044 100644 --- a/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md +++ b/content/search-github/getting-started-with-searching-on-github/about-searching-on-github.md @@ -67,7 +67,7 @@ You can search for the following information across all repositories you can acc ## Searching using a visual interface -In addition to the search bar, you can search {% data variables.product.product_name %} using the {% data variables.search.search_page_url %} or {% data variables.search.advanced_url %}. {% ifversion command-palette %}Alternatively, you can use the interactive search in the {% data variables.product.prodname_command_palette %} to search your current location in the UI, a specific user, repository or organization, and globally across all of {% data variables.product.product_name %}, without leaving the keyboard. For more information, see "[AUTOTITLE](/get-started/using-github/github-command-palette)."{% endif %} +In addition to the search bar, you can search {% data variables.product.product_name %} using the {% data variables.search.search_page_url %} or {% data variables.search.advanced_url %}. {% ifversion command-palette %}Alternatively, you can use the interactive search in the {% data variables.product.prodname_command_palette %} to search your current location in the UI, a specific user, repository or organization, and globally across all of {% data variables.product.product_name %}, without leaving the keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/github-command-palette)."{% endif %} The {% data variables.search.advanced_url %} provides a visual interface for constructing search queries. You can filter your searches by a variety of factors, such as the number of stars or number of forks a repository has. As you fill in the advanced search fields, your query will automatically be constructed in the top search bar. diff --git a/content/search-github/searching-on-github/finding-files-on-github.md b/content/search-github/searching-on-github/finding-files-on-github.md index 182a2a9550..16e13db394 100644 --- a/content/search-github/searching-on-github/finding-files-on-github.md +++ b/content/search-github/searching-on-github/finding-files-on-github.md @@ -18,7 +18,7 @@ topics: **Tips:** - By default, file finder results exclude some directories like `build`, `log`, `tmp`, and `vendor`. To search for files in these directories, {% ifversion code-search-code-view %}use the [`path` code search qualifier](/search-github/github-code-search/understanding-github-code-search-syntax#path-qualifier){% else %}use the [`filename` code search qualifier](/search-github/searching-on-github/searching-code#search-by-filename){% endif %}.{% ifversion file-finder-exclusion-controls %} Alternatively, you can customize which directories are excluded by default [using a `.gitattributes` file](#customizing-excluded-files).{% endif %} -- You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts)." +- You can also open the file finder by pressing `t` on your keyboard. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts)." {% endtip %} diff --git a/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md b/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md index 3f22e52872..f838b15b97 100644 --- a/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md +++ b/data/reusables/project-management/for-more-info-project-keyboard-shortcuts.md @@ -1 +1 @@ -For more information about keyboard shortcuts, see "Project boards" in "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#project-boards)." +For more information about keyboard shortcuts, see "Project boards" in "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#project-boards)." diff --git a/data/reusables/search/search_issues_and_pull_requests_shortcut.md b/data/reusables/search/search_issues_and_pull_requests_shortcut.md index f78bf16d90..98f5077b2e 100644 --- a/data/reusables/search/search_issues_and_pull_requests_shortcut.md +++ b/data/reusables/search/search_issues_and_pull_requests_shortcut.md @@ -1 +1 @@ -You can focus your cursor on the search bar above the issue or pull request list with a keyboard shortcut. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#issue-and-pull-request-lists)." +You can focus your cursor on the search bar above the issue or pull request list with a keyboard shortcut. For more information, see "[AUTOTITLE](/get-started/accessibility/keyboard-shortcuts#issue-and-pull-request-lists)." From 14532a917a71f7546a29290103ec10947ba74ec1 Mon Sep 17 00:00:00 2001 From: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Date: Mon, 13 Nov 2023 17:52:50 +0000 Subject: [PATCH 3/7] Add headings to "About GitHub Desktop" (#45741) Co-authored-by: Kevin Heis --- content/desktop/overview/about-github-desktop.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/content/desktop/overview/about-github-desktop.md b/content/desktop/overview/about-github-desktop.md index 168eb6e387..e989bd732c 100644 --- a/content/desktop/overview/about-github-desktop.md +++ b/content/desktop/overview/about-github-desktop.md @@ -11,10 +11,14 @@ redirect_from: - /get-started/using-github/github-desktop --- +## About {% data variables.product.prodname_desktop %} + {% data variables.product.prodname_desktop %} is a free, open source application that helps you to work with files hosted on {% data variables.product.prodname_dotcom %} or other Git hosting services. You can use {% data variables.product.prodname_desktop %} alongside any tools you need to contribute to a project. For example, a typical workflow would be to use {% data variables.product.prodname_desktop %} to download a {% data variables.product.prodname_dotcom %} repository to your computer and create a new branch, use an editor such as {% data variables.product.prodname_vscode %} to make changes to the code, then return to {% data variables.product.prodname_desktop %} to commit and push the changes to {% data variables.product.prodname_dotcom %}. +## About the benefits of {% data variables.product.prodname_desktop %} + Like any tool for contributing changes to repositories on {% data variables.product.prodname_dotcom %}, {% data variables.product.prodname_desktop %} is built around the version control software Git. If you're new to Git and {% data variables.product.prodname_dotcom %}, you may find it easier to get started with {% data variables.product.prodname_desktop %} than you would using Git on the command line. Because {% data variables.product.prodname_desktop %} has a graphical user interface, it simplifies many of the aspects of Git that can be challenging for new users, such as memorizing commands and visualizing the changes you're making. Even if you have experience with command-line Git, you may benefit from incorporating {% data variables.product.prodname_desktop %} into your work. If you frequently need to look up syntax for less common Git commands, such as choosing which changed lines to include in a commit or adding a co-author to a commit, you may benefit from switching to {% data variables.product.prodname_desktop %} to perform these commands. @@ -23,6 +27,8 @@ Because {% data variables.product.prodname_desktop %} makes commands like these Unlike other Git clients, {% data variables.product.prodname_desktop %} is specifically designed for use with {% data variables.product.prodname_dotcom %}, so it can make you more productive when working with repositories on {% data variables.product.prodname_dotcom %}. For example, you can authenticate to {% data variables.product.prodname_dotcom_the_website %} or {% data variables.product.prodname_ghe_server %} quickly, without needing to use a separate credential manager, and you can check out a pull request to run checks without needing to open your browser. +## Getting started + {% data variables.product.prodname_desktop %} is available for Windows and macOS. For information about installing and getting started with {% data variables.product.prodname_desktop %}, see "[AUTOTITLE](/desktop/overview/getting-started-with-github-desktop)." If you're interested in the open source {% data variables.product.prodname_desktop %} project, you can see the roadmap, contribute to the project, or open an issue to provide feedback in the [`desktop/desktop`](https://github.com/desktop/desktop) repository. From e6dfa81b4bce6935c9d205dbd050175383574976 Mon Sep 17 00:00:00 2001 From: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Date: Mon, 13 Nov 2023 10:53:32 -0700 Subject: [PATCH 4/7] Enterprise bug fix hour for week of October 30, 2023 (#45635) Co-authored-by: Matt Pollard Co-authored-by: Kevin Heis --- .../adding-organizations-to-your-enterprise.md | 5 +---- .../monitoring-your-instance/about-system-logs.md | 9 ++++----- 2 files changed, 5 insertions(+), 9 deletions(-) diff --git a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md index c61811dad0..b2c6871a27 100644 --- a/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md +++ b/content/admin/managing-accounts-and-repositories/managing-organizations-in-your-enterprise/adding-organizations-to-your-enterprise.md @@ -39,10 +39,7 @@ After you add an existing organization to your enterprise, the organization's re {% endnote %} - If SAML SSO is configured for the enterprise account, the enterprise's SAML configuration will apply to the organization. If the organization used SAML SSO, the enterprise account's configuration will replace the organization's configuration. SCIM is not available for enterprise accounts, so SCIM will be disabled for the organization. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise)" and "[AUTOTITLE](/admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account)." - If SAML SSO was configured for the organization, members' existing {% data variables.product.pat_generic %} or SSH keys that were authorized to access the organization's resources will be authorized to access the same resources. To access additional organizations owned by the enterprise, members must authorize the {% data variables.product.pat_generic %} or key. For more information, see "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-a-personal-access-token-for-use-with-saml-single-sign-on)" and "[AUTOTITLE](/authentication/authenticating-with-saml-single-sign-on/authorizing-an-ssh-key-for-use-with-saml-single-sign-on)." -- If the organization was connected to {% data variables.product.prodname_ghe_server %} or {% data variables.product.prodname_ghe_managed %} using {% data variables.product.prodname_github_connect %}, adding the organization to an enterprise will not update the connection. {% data variables.product.prodname_github_connect %} features will no longer function for the organization. To continue using {% data variables.product.prodname_github_connect %}, you must disable and re-enable the feature. For more information, see the following articles. - - - "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/managing-github-connect)" in the {% data variables.product.prodname_ghe_server %} documentation - - "[AUTOTITLE](/github-ae@latest/admin/configuration/configuring-github-connect/managing-github-connect)" in the {% data variables.product.prodname_ghe_managed %} documentation +- If the organization was connected to {% data variables.product.prodname_ghe_server %} using {% data variables.product.prodname_github_connect %}, adding the organization to an enterprise will not update the connection. {% data variables.product.prodname_github_connect %} features will no longer function for the organization. To continue using {% data variables.product.prodname_github_connect %}, you must disable and re-enable the feature. For more information, see "[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/managing-github-connect)" in the {% data variables.product.prodname_ghe_server %} documentation. - If the organization used billed {% data variables.product.prodname_marketplace %} apps, the organization can continue to use the apps, but must pay the vendor directly. For more information, contact the app's vendor. - If your organization was sponsoring any accounts, the sponsorships will be canceled. - Any coupons will be removed from the organization. To reapply the coupon, [contact our sales team](https://github.com/enterprise/contact). diff --git a/content/admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs.md b/content/admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs.md index 93917a6688..6bd62c46b6 100644 --- a/content/admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs.md +++ b/content/admin/monitoring-managing-and-updating-your-instance/monitoring-your-instance/about-system-logs.md @@ -131,14 +131,13 @@ The following log files contain events from services that provide search functio | :- | :- | |
/var/log/elasticsearch/github-enterprise.log
| Records events associated with the Elasticsearch service, which your instance uses to provide search services. | -### Log files for webhooks +### Journal logs for webhooks -The following log files contain events from the service that delivers webhook payloads for your instance. For more information, see "[AUTOTITLE](/webhooks-and-events/webhooks/about-webhooks)." +The following log files contain events related to webhooks that your instance sends. -| Path | Description | +| Service name | Description | | :- | :- | -|
/var/log/hookshot/resqued.log
| Records webhook deliveries and failures from your instance. | -|
/var/log/hookshot/unicorn.log
| Records webhook events that are triggered on your instance. | +| `hookshot-go` | Records events for all webhook activity on the instance, including triggered webhooks, deliveries, and failures.| ### Log files for system services From 30cdb42671972e126bfc68e11efcdd1af4a95968 Mon Sep 17 00:00:00 2001 From: Cory Calahan Date: Mon, 13 Nov 2023 09:53:55 -0800 Subject: [PATCH 5/7] Added ghe-actions-stop and ghe-actions-start to available CLI commands (#45697) Co-authored-by: Rachael Rose Renk <91027132+rachaelrenk@users.noreply.github.com> Co-authored-by: Kevin Heis --- .../command-line-utilities.md | 32 +++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md index 65f0ecf7f1..83321cfede 100644 --- a/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md +++ b/content/admin/administering-your-instance/administering-your-instance-from-the-command-line/command-line-utilities.md @@ -921,6 +921,38 @@ If your storage system is configured correctly, you'll see the following output. All Storage tests passed ``` +### ghe-actions-stop + +This utility stops {% data variables.product.prodname_actions %} from running on {% data variables.location.product_location %}. + +{% note %} + +**Notes**: + +- {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +- In high availability configurations, run this command from the primary. + +{% endnote %} + +### ghe-actions-start + +This utility starts {% data variables.product.prodname_actions %} on {% data variables.location.product_location %} after it has been previously stopped. + +{% note %} + +**Notes**: + +- {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} +- In high availability configurations, run this command from the primary. + +{% endnote %} + +If your system is configured correctly, you'll see the following ouput: + +```shell +Actions was enabled! +``` + ## High availability ### ghe-repl-promote From 9c5a83e5ec8de9074fe5b3228d46489ffb713939 Mon Sep 17 00:00:00 2001 From: chiph Date: Mon, 13 Nov 2023 11:54:09 -0600 Subject: [PATCH 6/7] Update accessing-github-using-two-factor-authentication.md (#45704) Co-authored-by: Kremlin <53055508+Kremlin@users.noreply.github.com> Co-authored-by: Laura Coursen Co-authored-by: Kevin Heis --- .../accessing-github-using-two-factor-authentication.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md index a3dd9970e8..c587d71d90 100644 --- a/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md +++ b/content/authentication/securing-your-account-with-two-factor-authentication-2fa/accessing-github-using-two-factor-authentication.md @@ -83,9 +83,7 @@ If you have installed and signed in to {% data variables.product.prodname_mobile ## Using two-factor authentication with the command line -{% ifversion fpt or ghec %} -Enabling 2FA may affect authentication to {% data variables.product.prodname_dotcom %} through the command line. To find out if your authentication method is affected, see the following sections. -{% else %} +{% ifversion ghes %} After you've enabled 2FA, you will no longer use your password to access {% data variables.product.product_name %} on the command line. Instead, use Git Credential Manager, a {% data variables.product.pat_generic %}, or an SSH key. {% endif %} From 33e96c814ea498df0e6c619aab0f8503672b3c17 Mon Sep 17 00:00:00 2001 From: Sarah Edwards Date: Mon, 13 Nov 2023 09:55:17 -0800 Subject: [PATCH 7/7] Remove outdated sentence (#45706) Co-authored-by: Kevin Heis --- content/rest/codespaces/organizations.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/rest/codespaces/organizations.md b/content/rest/codespaces/organizations.md index 2f9a8268b2..f07b36e03e 100644 --- a/content/rest/codespaces/organizations.md +++ b/content/rest/codespaces/organizations.md @@ -13,9 +13,8 @@ autogenerated: rest ## About {% data variables.product.prodname_codespaces %} organizations -You can manage {% data variables.product.prodname_codespaces %} billed to your -organization. These endpoints are available for authenticated -organization owners and {% data variables.product.prodname_oauth_apps %}, but not GitHub Apps. For more information, +You can manage {% data variables.product.prodname_codespaces %} that are billed to your +organization. For more information, see "[AUTOTITLE](/codespaces)."