diff --git a/assets/images/help/desktop/mac-editor-menu.png b/assets/images/help/desktop/mac-editor-menu.png index 78162a2936..df7c1878e6 100644 Binary files a/assets/images/help/desktop/mac-editor-menu.png and b/assets/images/help/desktop/mac-editor-menu.png differ diff --git a/assets/images/help/desktop/windows-editor-menu.png b/assets/images/help/desktop/windows-editor-menu.png index 64b97c62b6..f742b5375e 100644 Binary files a/assets/images/help/desktop/windows-editor-menu.png and b/assets/images/help/desktop/windows-editor-menu.png differ diff --git a/assets/images/help/profile/collapsed-section-example.png b/assets/images/help/profile/collapsed-section-example.png new file mode 100644 index 0000000000..f83d76ba63 Binary files /dev/null and b/assets/images/help/profile/collapsed-section-example.png differ diff --git a/assets/images/help/profile/edit-profile-readme.png b/assets/images/help/profile/edit-profile-readme.png new file mode 100644 index 0000000000..5a52937ea7 Binary files /dev/null and b/assets/images/help/profile/edit-profile-readme.png differ diff --git a/assets/images/help/profile/lightmode-image-example.png b/assets/images/help/profile/lightmode-image-example.png new file mode 100644 index 0000000000..4d42d6fd0e Binary files /dev/null and b/assets/images/help/profile/lightmode-image-example.png differ diff --git a/assets/images/help/profile/markdown-quote-example.png b/assets/images/help/profile/markdown-quote-example.png new file mode 100644 index 0000000000..7459ec47a1 Binary files /dev/null and b/assets/images/help/profile/markdown-quote-example.png differ diff --git a/assets/images/help/profile/markdown-table-example.png b/assets/images/help/profile/markdown-table-example.png new file mode 100644 index 0000000000..77f74063af Binary files /dev/null and b/assets/images/help/profile/markdown-table-example.png differ diff --git a/assets/images/help/profile/readme-commit-changes.png b/assets/images/help/profile/readme-commit-changes.png new file mode 100644 index 0000000000..4caed6260a Binary files /dev/null and b/assets/images/help/profile/readme-commit-changes.png differ diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index 1fb69ef80b..c0511693a3 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -24,7 +24,7 @@ You decide what information to include in your profile README, so you have full ![Profile README file displayed on profile](/assets/images/help/repository/profile-with-readme.png) -You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)." +You can format text and include emoji, images, and GIFs in your profile README by using {% data variables.product.company_short %} Flavored Markdown. For more information, see "[Getting started with writing and formatting on {% data variables.product.prodname_dotcom %}](/github/writing-on-github/getting-started-with-writing-and-formatting-on-github)." For a hands-on guide to customizing your profile README, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." ## Prerequisites diff --git a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 9dcf891257..5bd218b446 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -33,6 +33,12 @@ You must store this file in the `.github` directory of your repository. When you Any options that also affect security updates are used the next time a security alert triggers a pull request for a security update. For more information, see "[Configuring {% data variables.product.prodname_dependabot_security_updates %}](/code-security/supply-chain-security/managing-vulnerabilities-in-your-projects-dependencies/configuring-dependabot-security-updates)." +{% note %} + +**Note:** You cannot configure {% data variables.product.prodname_dependabot_alerts %} using the *dependabot.yml* file. + +{% endnote %} + The *dependabot.yml* file has two mandatory top-level keys: `version`, and `updates`. You can, optionally, include a top-level `registries` key{% ifversion ghes = 3.5 %} and/or a `enable-beta-ecosystems` key{% endif %}. The file must start with `version: 2`. ## Configuration options for the *dependabot.yml* file diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 6f2add118e..17139235ce 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -58,7 +58,7 @@ You can create default contribution guidelines for your organization{% ifversion If you're stumped, here are some good examples of contribution guidelines: -- The Atom editor [contribution guidelines](https://github.com/atom/atom/blob/master/CONTRIBUTING.md). +- The {% data variables.product.prodname_docs %} [contribution guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md). - The Ruby on Rails [contribution guidelines](https://github.com/rails/rails/blob/main/CONTRIBUTING.md). - The Open Government [contribution guidelines](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md). diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md index 060faea04e..42d4793a90 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md @@ -1,6 +1,6 @@ --- title: Making changes in a branch -intro: 'Use your favorite text editor, such as [Atom](https://atom.io/), to make changes to your project, then use {% data variables.product.prodname_desktop %} to visualize useful commits.' +intro: 'Use your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), to make changes to your project, then use {% data variables.product.prodname_desktop %} to visualize useful commits.' redirect_from: - /desktop/contributing-to-projects/making-changes-in-a-branch versions: diff --git a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md index 3f830fbfe3..0371648057 100644 --- a/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md +++ b/content/desktop/installing-and-configuring-github-desktop/configuring-and-customizing-github-desktop/configuring-a-default-editor.md @@ -14,7 +14,6 @@ shortTitle: Configure default editor {% mac %} -- [Atom](https://atom.io/) - [MacVim](https://macvim-dev.github.io/macvim/) - [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) - [Visual Studio Codium](https://vscodium.com/) @@ -43,7 +42,6 @@ shortTitle: Configure default editor {% windows %} -- [Atom](https://atom.io/) - [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) - [Visual Studio Codium](https://vscodium.com/) - [Sublime Text](https://www.sublimetext.com/) diff --git a/content/developers/overview/managing-deploy-keys.md b/content/developers/overview/managing-deploy-keys.md index 9e2ba511e5..45e840a023 100644 --- a/content/developers/overview/managing-deploy-keys.md +++ b/content/developers/overview/managing-deploy-keys.md @@ -83,13 +83,15 @@ See [our guide on creating a personal access token](/authentication/keeping-your #### Setup 1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server, and remember where you save the generated public and private rsa key pair. -2. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. ![Navigation to profile](/assets/images/profile-page.png) -3. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) -4. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) -5. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) -6. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) -7. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. -8. Click **Add key**. +{% data reusables.profile.navigating-to-profile %} + + ![Navigation to profile](/assets/images/profile-page.png) +1. On your profile page, click **Repositories**, then click the name of your repository. ![Repositories link](/assets/images/repos.png) +2. From your repository, click **Settings**. ![Repository settings](/assets/images/repo-settings.png) +3. In the sidebar, click **Deploy Keys**, then click **Add deploy key**. ![Add Deploy Keys link](/assets/images/add-deploy-key.png) +4. Provide a title, paste in your public key. ![Deploy Key page](/assets/images/deploy-key.png) +5. Select **Allow write access** if you want this key to have write access to the repository. A deploy key with write access lets a deployment push to the repository. +6. Click **Add key**. #### Using multiple repositories on one server diff --git a/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md index 19f6ecfba3..463ad45f8b 100644 --- a/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md +++ b/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -13,11 +13,7 @@ shortTitle: Extensions & integrations --- ## Editor tools -You can connect to {% data variables.product.product_name %} repositories within third-party editor tools, such as Atom, Unity, and {% data variables.product.prodname_vs %}. - -### {% data variables.product.product_name %} for Atom - -With the {% data variables.product.product_name %} for Atom extension, you can commit, push, pull, resolve merge conflicts, and more from the Atom editor. For more information, see the official [{% data variables.product.product_name %} for Atom site](https://github.atom.io/). +You can connect to {% data variables.product.product_name %} repositories within third-party editor tools such as Unity and {% data variables.product.prodname_vs %}. ### {% data variables.product.product_name %} for Unity diff --git a/content/get-started/getting-started-with-git/associating-text-editors-with-git.md b/content/get-started/getting-started-with-git/associating-text-editors-with-git.md index d903687c9b..37d6192f7a 100644 --- a/content/get-started/getting-started-with-git/associating-text-editors-with-git.md +++ b/content/get-started/getting-started-with-git/associating-text-editors-with-git.md @@ -18,15 +18,6 @@ shortTitle: Associate text editors --- {% mac %} -## Using Atom as your editor - -1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Type this command: - ```shell - $ git config --global core.editor "atom --wait" - ``` - ## Using {% data variables.product.prodname_vscode %} as your editor 1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. @@ -58,15 +49,6 @@ shortTitle: Associate text editors {% windows %} -## Using Atom as your editor - -1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Type this command: - ```shell - $ git config --global core.editor "atom --wait" - ``` - ## Using {% data variables.product.prodname_vscode %} as your editor 1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. @@ -97,15 +79,6 @@ shortTitle: Associate text editors {% linux %} -## Using Atom as your editor - -1. Install [Atom](https://atom.io/). For more information, see "[Installing Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" in the Atom documentation. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Type this command: - ```shell - $ git config --global core.editor "atom --wait" - ``` - ## Using {% data variables.product.prodname_vscode %} as your editor 1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation. diff --git a/content/get-started/index.md b/content/get-started/index.md index 18d0395a5c..4e69dd5e5e 100644 --- a/content/get-started/index.md +++ b/content/get-started/index.md @@ -32,6 +32,7 @@ featuredLinks: - /get-started/onboarding/getting-started-with-github-enterprise-cloud - /get-started/onboarding/getting-started-with-github-enterprise-server - /get-started/onboarding/getting-started-with-github-ae + - /get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github popular: - /github/getting-started-with-github/signing-up-for-a-new-github-account - /get-started/quickstart/hello-world diff --git a/content/get-started/onboarding/getting-started-with-your-github-account.md b/content/get-started/onboarding/getting-started-with-your-github-account.md index c0693210f6..388fb6eaee 100644 --- a/content/get-started/onboarding/getting-started-with-your-github-account.md +++ b/content/get-started/onboarding/getting-started-with-your-github-account.md @@ -75,7 +75,7 @@ For more information about how to authenticate to {% data variables.product.prod | ------------- | ------------- | ------------- | | Browse to {% data variables.product.prodname_dotcom_the_website %} | If you don't need to work with files locally, {% data variables.product.product_name %} lets you complete most Git-related actions directly in the browser, from creating and forking repositories to editing files and opening pull requests.| This method is useful if you want a visual interface and need to do quick, simple changes that don't require working locally. | | {% data variables.product.prodname_desktop %} | {% data variables.product.prodname_desktop %} extends and simplifies your {% data variables.product.prodname_dotcom_the_website %} workflow, using a visual interface instead of text commands on the command line. For more information on getting started with {% data variables.product.prodname_desktop %}, see "[Getting started with {% data variables.product.prodname_desktop %}](/desktop/installing-and-configuring-github-desktop/overview/getting-started-with-github-desktop)." | This method is best if you need or want to work with files locally, but prefer using a visual interface to use Git and interact with {% data variables.product.product_name %}. | -| IDE or text editor | You can set a default text editor, like [Atom](https://atom.io/) or [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | +| IDE or text editor | You can set a default text editor like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) to open and edit your files with Git, use extensions, and view the project structure. For more information, see "[Associating text editors with Git](/github/using-git/associating-text-editors-with-git)." | This is convenient if you are working with more complex files and projects and want everything in one place, since text editors or IDEs often allow you to directly access the command line in the editor. | | Command line, with or without {% data variables.product.prodname_cli %} | For the most granular control and customization of how you use Git and interact with {% data variables.product.product_name %}, you can use the command line. For more information on using Git commands, see "[Git cheatsheet](/github/getting-started-with-github/quickstart/git-cheatsheet)."

{% data variables.product.prodname_cli %} is a separate command-line tool you can install that brings pull requests, issues, {% data variables.product.prodname_actions %}, and other {% data variables.product.prodname_dotcom %} features to your terminal, so you can do all your work in one place. For more information, see "[{% data variables.product.prodname_cli %}](/github/getting-started-with-github/using-github/github-cli)." | This is most convenient if you are already working from the command line, allowing you to avoid switching context, or if you are more comfortable using the command line. | | {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API | {% data variables.product.prodname_dotcom %} has a REST API and GraphQL API that you can use to interact with {% data variables.product.product_name %}. For more information, see "[Getting started with the API](/github/extending-github/getting-started-with-the-api)." | The {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %}{% else %}{% data variables.product.product_name %}{% endif %} API would be most helpful if you wanted to automate common tasks, back up your data, or create integrations that extend {% data variables.product.prodname_dotcom %}. | ### 4. Writing on {% data variables.product.product_name %} diff --git a/content/get-started/quickstart/communicating-on-github.md b/content/get-started/quickstart/communicating-on-github.md index 73ae95ff70..746d67c59d 100644 --- a/content/get-started/quickstart/communicating-on-github.md +++ b/content/get-started/quickstart/communicating-on-github.md @@ -150,3 +150,5 @@ For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt o {% endif %} For team discussions, you can edit or delete discussions on a team's page, and you can configure notifications for team discussions. For more information, see "[About team discussions](/organizations/collaborating-with-your-team/about-team-discussions)." + +To learn some advanced formatting features that will help you communicate, see "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)." \ No newline at end of file diff --git a/content/get-started/quickstart/git-and-github-learning-resources.md b/content/get-started/quickstart/git-and-github-learning-resources.md index 7979e5918b..a4f544484c 100644 --- a/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/content/get-started/quickstart/git-and-github-learning-resources.md @@ -58,6 +58,6 @@ Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides ch An interactive [online Git course](https://www.pluralsight.com/courses/code-school-git-real) from [Pluralsight](https://www.pluralsight.com/codeschool) has seven levels with dozens of exercises in a fun game format. Feel free to adapt our [.gitignore templates](https://github.com/github/gitignore) to meet your needs. -Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [Atom](https://atom.io) text editor. +Extend your {% data variables.product.prodname_dotcom %} reach through {% ifversion fpt or ghec %}[integrations](/articles/about-integrations){% else %}integrations{% endif %}, or by installing [{% data variables.product.prodname_desktop %}](https://desktop.github.com) and the robust [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) text editor. Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md index 847979c78d..ffec457383 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md @@ -10,7 +10,7 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Write & format on GitHub +shortTitle: About writing & formatting --- [Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text. @@ -42,3 +42,4 @@ You can enable a fixed-width font in every comment field on {% data variables.pr - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) - "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)" - "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" 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 a7321a27c9..b229b71ca3 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 @@ -179,13 +179,7 @@ You can specify the theme an image is displayed for in Markdown by using the HTM For example, the following code displays a sun image for light themes and a moon for dark themes: -```HTML - - - - Shows an illustrated sun in light color mode and a moon with stars in dark color mode. - -``` +{% data reusables.getting-started.picture-element-example %} The old method of specifying images based on the theme, by using a fragment appended to the URL (`#gh-dark-mode-only` or `#gh-light-mode-only`), is deprecated and will be removed in favor of the new method described above. {% endif %} @@ -216,7 +210,7 @@ To order your list, precede each line with a number. You can create a nested list by indenting one or more list items below another item. -To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [Atom](https://atom.io/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. +To create a nested list using the web editor on {% data variables.product.product_name %} or a text editor that uses a monospaced font, like [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), you can align your list visually. Type space characters in front of your nested list item, until the list marker character (- or *) lies directly below the first character of the text in the item above it. ```markdown 1. First list item @@ -394,3 +388,4 @@ For more information, see Daring Fireball's "[Markdown Syntax](https://daringfir - [{% data variables.product.prodname_dotcom %} Flavored Markdown Spec](https://github.github.com/gfm/) - "[About writing and formatting on GitHub](/articles/about-writing-and-formatting-on-github)" - "[Working with advanced formatting](/articles/working-with-advanced-formatting)" +- "[Quickstart for writing on {% data variables.product.prodname_dotcom %}](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)" diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md index dbd50c1ca9..8a64a3b4fc 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md @@ -12,6 +12,7 @@ versions: ghae: '*' ghec: '*' children: + - /quickstart-for-writing-on-github - /about-writing-and-formatting-on-github - /basic-writing-and-formatting-syntax shortTitle: Start writing on GitHub diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md new file mode 100644 index 0000000000..f9ce600b7e --- /dev/null +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github.md @@ -0,0 +1,244 @@ +--- +title: Quickstart for writing on GitHub +intro: Learn advanced formatting features by creating a {% ifversion ghae %}gist to describe yourself{% else %}README for your {% data variables.product.prodname_dotcom %} profile{% endif %}. +versions: + fpt: '*' + ghes: '*' + ghae: '*' + ghec: '*' +shortTitle: Quickstart +--- + +## Introduction + +Markdown is an easy-to-read, easy-to-write language for formatting plain text. You can use Markdown syntax, along with some additional HTML tags, to format your writing on {% data variables.product.prodname_dotcom %}, in places like repository READMEs and comments on pull requests and issues. In this guide, you'll learn some advanced formatting features by creating {% ifversion ghae %}a gist{% else %}or editing a README for your {% data variables.product.prodname_dotcom %} profile{% endif %}. + +If you're new to Markdown, you might want to start with "[Basic writing and formatting syntax](/articles/basic-writing-and-formatting-syntax)" or the [Communicate using Markdown](https://github.com/skills/communicate-using-markdown) {% data variables.product.prodname_learning %} course. + +{% ifversion not ghae %} + +If you already have a profile README, you can follow this guide by adding some features to your existing README, or by creating a gist with a Markdown file called something like `about-me.md`. For more information, see "[Creating gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)." + +{% endif %} + +{% ifversion ghae %} + +## Creating a gist + +Gists let you store or share code snippets and other pieces of information with others on {% data variables.product.product_location %}. To use formatting features in gists, add a gist file with a `.md` extension. + +1. Navigate to your {% data variables.gists.gist_homepage %}. +1. Optionally, type a description for the gist, such as "About me." +1. In the **Filename including extension...** field, type `about-me.md`. + +For more information, see "[Creating gists](/get-started/writing-on-github/editing-and-sharing-content-with-gists/creating-gists)." + +{% else %} + +## Creating or editing your profile README + +Your profile README lets you share information about yourself with the community on {% data variables.product.product_location %}. The README is displayed at the top of your profile page. + +If you don't already have a profile README, you can add one. + +1. Create a repository with the same name as your {% data variables.product.prodname_dotcom %} username, initializing the repository with a `README.md` file. For more information, see "[Managing your profile README](/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme#adding-a-profile-readme)." +1. Edit the `README.md` file and delete the template text (beginning `### Hi there`) that is automatically added when you create the file. + +If you already have a profile README, you can edit it from your profile page. + +{% data reusables.profile.navigating-to-profile %} +1. Click the {% octicon "pencil" aria-label="The Pencil icon" %} next to your profile README. + + ![Screenshot of a profile page, with the pencil icon highlighted next to the profile README](/assets/images/help/profile/edit-profile-readme.png) + +{% endif %} + +## Adding an image to suit your visitors + +You can include images in your communication on {% data variables.product.prodname_dotcom %}. Here, you'll add a responsive image, such as a banner, to the top of your {% ifversion ghae %}gist{% else %}profile README{% endif %}. + +By using the HTML `` element with the `prefers-color-scheme` media feature, you can add an image that changes depending on whether a visitor is using light or dark mode. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)." + +1. Copy and paste the following markup into your {% ifversion ghae %}`about-me.md`{% else %}`README.md`{% endif %} file. + + ```HTML{:copy} + + + + YOUR-ALT-TEXT + + ``` +1. Replace the placeholders in the markup with the URLs of your chosen images. Alternatively, to try the feature first, you can copy the URLs from our example below. + + - Replace `YOUR-DARKMODE-IMAGE` with the URL of an image to display for visitors using dark mode. + - Replace `YOUR-LIGHTMODE-IMAGE` with the URL of an image to display for visitors using light mode. + - Replace `YOUR-DEFAULT-IMAGE` with the URL of an image to display in case neither of the other images can be matched, for example if the visitor is using a browser that does not support the `prefers-color-scheme` feature. +1. To make the image accessible for visitors who are using a screen reader, replace `YOUR-ALT-TEXT` with a description of the image. +1. To check the image has rendered correctly, click the **Preview** tab. + +For more information on using images in Markdown, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)." + +### Example + +{% data reusables.getting-started.picture-element-example %} + +### How it looks + +![Screenshot of the Preview tab in light mode, with an image of a smiling sun displayed](/assets/images/help/profile/lightmode-image-example.png) + +## Adding a table + +You can use Markdown tables to organize information. Here, you'll use a table to introduce yourself by ranking something, such as your most-used programming languages or frameworks, the things you're spending your time learning, or your favorite hobbies. When a table column contains numbers, it's useful to right-align the column by using the syntax `--:` below the header row. + +1. Return to the **Edit {% ifversion ghae %}new {% endif %}file** tab. +1. To introduce yourself, two lines below the `` tag, add an `## About me` header and a short paragraph about yourself, like the following. + + ```Markdown + ## About me + + Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotcom %}'s mascot. + ``` +1. Two lines below this paragraph, insert a table by copying and pasting the following markup. + + ```Markdown{:copy} + | Rank | THING-TO-RANK | + |-----:|---------------| + | 1| | + | 2| | + | 3| | + ``` +1. In the column on the right, replace `THING-TO-RANK` with "Languages," "Hobbies," or anything else, and fill in the column with your list of things. +1. To check the table has rendered correctly, click the **Preview** tab. + +For more information, see "[Organizing information with tables](/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables)." + +### Example + +```Markdown +## About me + +Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotcom %}'s mascot. + +| Rank | Languages | +|-----:|-----------| +| 1| Javascript| +| 2| Python | +| 3| SQL | +``` + +### How it looks + +![Screenshot of the Preview tab, showing an "About me" heading and a rendered table with a list of languages](/assets/images/help/profile/markdown-table-example.png) + +## Adding a collapsed section + +To keep your content tidy, you can use the `
` tag to create an expandible collapsed section. + +1. To create a collapsed section for the table you created, wrap your table in `
` tags like in the following example. + + ```HTML{:copy} +
+ My top THINGS-TO-RANK + + YOUR TABLE + +
+ ``` +1. Between the `` tags, replace `THINGS-TO-RANK` with whatever you ranked in your table. +1. Optionally, to make the section display as open by default, add the `open` attribute to the `
` tag. + + ```HTML +
+ ``` +1. To check the collapsed section has rendered correctly, click the **Preview** tab. + +### Example + +```HTML +
+My top languages + +| Rank | Languages | +|-----:|-----------| +| 1| Javascript| +| 2| Python | +| 3| SQL | + +
+``` + +### How it looks + +![Screenshot of the Preview tab, with a collapsed section called "My top languages" marked by a dropdown arrow](/assets/images/help/profile/collapsed-section-example.png) + +## Adding a quote + +Markdown has many other options for formatting your content. Here, you'll add a horizontal rule to divide your page and a blockquote to format your favorite quote. + +1. At the bottom of your file, two lines below the `
` tag, add a horizontal rule by typing three or more dashes. + + ```Markdown + --- + ``` +1. Below the `---` line, add a quote by typing markup like the following. + + ```Markdown + > QUOTE + ``` + + Replace `QUOTE` with a quote of your choice. Alternatively, copy the quote from our example below. +1. To check everything has rendered correctly, click the **Preview** tab. + +### Example + +```Markdown +--- +> If we pull together and commit ourselves, then we can push through anything. + +— Mona the Octocat +``` + +### How it looks + +![Screenshot of the Preview tab, with an indented quote below a thick horizontal line](/assets/images/help/profile/markdown-quote-example.png) + +## Adding a comment + +You can use HTML comment syntax to add a comment that will be hidden in the output. Here, you'll add a comment to remind yourself to update your {% ifversion ghae %}gist{% else %}README{% endif %} later. + +1. Two lines below the `## About me` header, insert a comment by using the following markup. + + 
+   <!-- COMMENT -->
+
+ + Replace `COMMENT` with a "to-do" item you remind yourself to do something later (for example, to add more items to the table). +1. To check your comment is hidden in the output, click the **Preview** tab. + +### Example + +
+## About me
+
+<!-- TO DO: add more details about me later -->
+
+ +## Saving your work + +When you're happy with your changes, save your {% ifversion ghae %}gist. + +- To keep your gist hidden from search engines but visible to anyone you share the URL with, click **Create secret gist** +- If you're happy for your gist to be visible to anyone on {% data variables.product.product_location %}, click **Create internal gist** + +{% else %}profile README by clicking **Commit changes**. + +Committing directly to the `main` branch will make your changes visible to any visitor on your profile. If you want to save your work but aren't ready to make it visible on your profile, you can select **Create a new branch for this commit and start a pull request**. + +![Screenshot of the "Commit changes" section](/assets/images/help/profile/readme-commit-changes.png) + +{% endif %} + +## Next steps + +- Continue to learn about advanced formatting features. For example, see {% ifversion fpt or ghec %}"[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams)" and {% endif %}"[Creating and highlighting codeblocks](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)." +- Use your new skills as you communicate across GitHub, in issues, pull requests, and discussions. For more information, see "[Communicating on {% data variables.product.prodname_dotcom %}](/get-started/quickstart/communicating-on-github)." diff --git a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md index aae7367309..adbebde7ee 100644 --- a/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md @@ -192,7 +192,7 @@ For pull requests, you can also use search to: - Filter pull requests by [reviewer](/articles/about-pull-request-reviews/): `state:open type:pr reviewed-by:octocat` - Filter pull requests by the specific user [requested for review](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review): `state:open type:pr review-requested:octocat`{% ifversion fpt or ghae or ghes > 3.2 or ghec %} - Filter pull requests that someone has asked you directly to review: `state:open type:pr user-review-requested:@me`{% endif %} -- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/atom` +- Filter pull requests by the team requested for review: `state:open type:pr team-review-requested:github/docs` - Filter for pull requests that are linked to an issue that the pull request may close: `linked:issue` ## Sorting issues and pull requests diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index dbd648bfc3..a53dcfa122 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -49,7 +49,7 @@ For example, if you and another person both edited the file _styleguide.md_ on t > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +4. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. 5. To see the beginning of the merge conflict in your file, search the file for the conflict marker `<<<<<<<`. When you open the file in your text editor, you'll see the changes from the HEAD or base branch after the line `<<<<<<< HEAD`. Next, you'll see `=======`, which divides your changes from the changes in the other branch, followed by `>>>>>>> BRANCH-NAME`. In this example, one person wrote "open an issue" in the base or HEAD branch and another person wrote "ask your question in IRC" in the compare branch or `branch-a`. ``` @@ -104,7 +104,7 @@ For example, if you edited a file, such as *README.md*, and another person remov > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. Open your favorite text editor, such as [Atom](https://atom.io/), and navigate to the file that has merge conflicts. +3. Open your favorite text editor, such as [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/), and navigate to the file that has merge conflicts. 6. Decide if you want keep the removed file. You may want to view the latest changes made to the removed file in your text editor. To add the removed file back to your repository: diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index dcf929a857..4e6d036ae3 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -268,7 +268,7 @@ You can filter pull requests based on their [review status](/pull-requests/colla | reviewed-by:USERNAME | [**type:pr reviewed-by:gjtorikian**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+reviewed-by%3Agjtorikian&type=Issues) matches pull requests reviewed by a particular person. | review-requested:USERNAME | [**type:pr review-requested:benbalter**](https://github.com/search?utf8=%E2%9C%93&q=type%3Apr+review-requested%3Abenbalter&type=Issues) matches pull requests where a specific person is requested for review. Requested reviewers are no longer listed in the search results after they review a pull request. If the requested person is on a team that is requested for review, then review requests for that team will also appear in the search results.{% ifversion fpt or ghae or ghes > 3.2 or ghec %} | user-review-requested:@me | [**type:pr user-review-requested:@me**](https://github.com/search?q=is%3Apr+user-review-requested%3A%40me+) matches pull requests that you have directly been asked to review.{% endif %} -| team-review-requested:TEAMNAME | [**type:pr team-review-requested:atom/design**](https://github.com/search?q=type%3Apr+team-review-requested%3Aatom%2Fdesign&type=Issues) matches pull requests that have review requests from the team `atom/design`. Requested reviewers are no longer listed in the search results after they review a pull request. +| team-review-requested:TEAMNAME | [**type:pr team-review-requested:github/docs**](https://github.com/search?q=type%3Apr+team-review-requested%3Agithub%2Fdocs&type=pullrequests) matches pull requests that have review requests from the team `github/docs`. Requested reviewers are no longer listed in the search results after they review a pull request. ## Search by when an issue or pull request was created or last updated diff --git a/content/support/learning-about-github-support/about-github-premium-support.md b/content/support/learning-about-github-support/about-github-premium-support.md index 24cd0845ff..444c81cb70 100644 --- a/content/support/learning-about-github-support/about-github-premium-support.md +++ b/content/support/learning-about-github-support/about-github-premium-support.md @@ -105,7 +105,7 @@ When you contact {% data variables.contact.premium_support %}, you can choose on | {% data variables.product.support_ticket_priority_urgent %} | Production workflows for your organization or enterprise on {% data variables.product.prodname_ghe_cloud %} are failing due to critical service errors or outages, and the failure directly impacts the operation of your business. |
  • Errors or outages on {% data variables.product.prodname_dotcom_the_website %} affect core Git or web application functionality for all members of your organization or enterprise
| | {% data variables.product.support_ticket_priority_high %} | Account or security issues with your organization or enterprise on {% data variables.product.prodname_ghe_cloud %} are causing limited impact to your business. |
  • An organization or enterprise owner has unintentionally deleted an organization
  • An organization or enterprise member has uploaded sensitive data in a commit, issue, pull request, or issue attachment
| | {% data variables.product.support_ticket_priority_normal %} | Members of your organization or enterprise on {% data variables.product.prodname_ghe_cloud %} are experiencing limited or moderate issues with {% data variables.product.prodname_dotcom_the_website %}, or you have general concerns or questions about your organization or enterprise. |
  • Questions about using APIs and features for your organization or enterprise
  • Issues with tools for organization data migration that {% data variables.product.company_short %} provides
  • Features related to your organization or enterprise not working as expected
  • General security questions about your organization or enterprise
| -| {% data variables.product.support_ticket_priority_low %} | You have a question or suggestion about your organization or enterprise on {% data variables.product.prodname_ghe_cloud %} that is not time-sensitive, or does not otherwise block the productivity of your team. |
  • Excessive resource usage for your organization or enterprise
  • Requests for health checks
  • Help with using Gists, notifications, wikis, {% data variables.product.prodname_pages %}, {% data variables.product.prodname_desktop %}, Atom, or other peripheral services or features with your organization or enterprise
  • Feature requests
  • Product feedback
| +| {% data variables.product.support_ticket_priority_low %} | You have a question or suggestion about your organization or enterprise on {% data variables.product.prodname_ghe_cloud %} that is not time-sensitive, or does not otherwise block the productivity of your team. |
  • Excessive resource usage for your organization or enterprise
  • Requests for health checks
  • Help with using Gists, notifications, wikis, {% data variables.product.prodname_pages %}, {% data variables.product.prodname_desktop %}, or other peripheral services or features with your organization or enterprise
  • Feature requests
  • Product feedback
| ### Ticket priorities for {% data variables.product.prodname_ghe_server %} diff --git a/data/reusables/getting-started/picture-element-example.md b/data/reusables/getting-started/picture-element-example.md new file mode 100644 index 0000000000..cc1bfdac06 --- /dev/null +++ b/data/reusables/getting-started/picture-element-example.md @@ -0,0 +1,7 @@ +```HTML + + + + Shows an illustrated sun in light mode and a moon with stars in dark mode. + +``` \ No newline at end of file diff --git a/data/reusables/profile/navigating-to-profile.md b/data/reusables/profile/navigating-to-profile.md new file mode 100644 index 0000000000..019925a783 --- /dev/null +++ b/data/reusables/profile/navigating-to-profile.md @@ -0,0 +1 @@ +1. In the upper-right corner of any {% data variables.product.product_name %} page, click your profile photo, then click **Your profile**. \ No newline at end of file