diff --git a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md index d8b96e1513..fb9de52b3e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-user-account/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md @@ -49,7 +49,7 @@ Repositories owned by an organization can grant more granular access. For more i 7. Select the collaborator's username from the drop-down menu. ![Collaborator list drop-down menu](/assets/images/help/repository/repo-settings-collab-autofill.png) 8. Click **Add collaborator**. - ![Add button](/assets/images/help/repository/repo-settings-collab-add.png) + !["Add collaborator" button](/assets/images/help/repository/repo-settings-collab-add.png) {% endif %} {% ifversion fpt %} 9. The user will receive an email inviting them to the repository. Once they accept your invitation, they will have collaborator access to your repository. diff --git a/content/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md b/content/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md index 352b09d737..a852a24517 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/customizing-user-messages-for-your-enterprise.md @@ -67,7 +67,7 @@ You can use Markdown to format your message. For more information, see "[About w {% ifversion ghes > 2.22 or ghae %} ## Creating a mandatory message -You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}. +You can create a mandatory message that {% data variables.product.product_name %} will show to all users the first time they sign in after you save the message. The message appears in a pop-up window that the user must dismiss before the user can use {% data variables.product.product_location %}. Mandatory messages have a variety of uses. @@ -89,9 +89,9 @@ Each time a user sees a mandatory message, an audit log event is created. The ev {% data reusables.enterprise-accounts.settings-tab %} {% data reusables.enterprise-accounts.messages-tab %} 1. To the right of "Mandatory message", click **Add message**. - ![Add message button](/assets/images/enterprise/site-admin-settings/add-mandatory-message-button.png) + ![Add mandatory message button](/assets/images/enterprise/site-admin-settings/add-mandatory-message-button.png) 1. Under "Mandatory message", in the text box, type your message. - ![Add message button](/assets/images/enterprise/site-admin-settings/mandatory-message-text-box.png) + ![Mandatory message text box](/assets/images/enterprise/site-admin-settings/mandatory-message-text-box.png) {% data reusables.enterprise_site_admin_settings.message-preview-save %} {% endif %} diff --git a/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md b/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md index b97e93461d..4ec4cbe801 100644 --- a/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md +++ b/content/billing/managing-billing-for-github-advanced-security/viewing-your-github-advanced-security-usage.md @@ -34,8 +34,8 @@ You can check how many seats your license includes and how many of them are curr {% data reusables.enterprise-accounts.license-tab %} The "{% data variables.product.prodname_GH_advanced_security %}" section shows details of the current usage. ![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas.png) - If you run out of seats, the section will be red. You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#getting-the-most-out-of-github-advanced-security)." - ![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png) + If you run out of seats, the section will be red and show "Limit exceeded". You should either reduce your use of {% data variables.product.prodname_GH_advanced_security %} or purchase more seats. For more information, see "[About billing for {% data variables.product.prodname_GH_advanced_security %}](/billing/managing-billing-for-github-advanced-security/about-billing-for-github-advanced-security#getting-the-most-out-of-github-advanced-security)." + ![{% data variables.product.prodname_GH_advanced_security %} in enterprise licensing settings showing "Limit exceeded"](/assets/images/help/enterprises/enterprise-licensing-tab-ghas-no-seats.png) 4. Optionally, to see a detailed breakdown of usage per organization, in the left sidebar, click **Billing**. ![Billing tab in the enterprise account settings sidebar](/assets/images/help/business-accounts/settings-billing-tab.png) In the "{% data variables.product.prodname_GH_advanced_security %}" section you can see the number of committers and unique committers for each organization. diff --git a/content/code-security/security-advisories/editing-a-security-advisory.md b/content/code-security/security-advisories/editing-a-security-advisory.md index 44971a8421..1e64956741 100644 --- a/content/code-security/security-advisories/editing-a-security-advisory.md +++ b/content/code-security/security-advisories/editing-a-security-advisory.md @@ -37,7 +37,7 @@ If you believe you should be credited for a security advisory, please contact th 11. Optionally, edit the "Credits" for the security advisory. ![Credits for a security advisory](/assets/images/help/security/security-advisory-credits.png) 12. Click **Update security advisory**. - ![Add button](/assets/images/help/security/update-advisory-button.png) + !["Update security advisory" button](/assets/images/help/security/update-advisory-button.png) 13. The people listed in the "Credits" section will receive an email or web notification inviting them to accept credit. If a person accepts, their username will be publicly visible once the security advisory is published. ## Further reading diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md index 1079d6a580..5b1d7ea0aa 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces.md @@ -12,13 +12,13 @@ topics: - Codespaces --- - + ## Introduction This guide shows you how to set up your C# (.NET) project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### Prerequisites +### Prerequisites - You should have an existing C# (.NET) project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/dotnet-quickstart. - You must have {% data variables.product.prodname_codespaces %} enabled for your organization. @@ -27,18 +27,18 @@ This guide shows you how to set up your C# (.NET) project in {% data variables.p 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. {% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## Step 2: Add a dev container to your codespace from a template +## Step 2: Add a dev container to your codespace from a template The default codespaces container comes with the latest .NET version and common tools preinstalled. However, we encourage you to set up a custom container so you can tailor the tools and scripts that run as part of codespace creation to your project's needs and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. @@ -71,7 +71,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr "name": "C# (.NET)", "build": { "dockerfile": "Dockerfile", - "args": { + "args": { // Update 'VARIANT' to pick a .NET Core version: 2.1, 3.1, 5.0 "VARIANT": "5.0", // Options @@ -101,7 +101,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr // dotnet dev-certs https --trust; dotnet dev-certs https -ep "$env:USERPROFILE/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" // * macOS/Linux terminal: // dotnet dev-certs https --trust; dotnet dev-certs https -ep "${HOME}/.aspnet/https/aspnetapp.pfx" -p "SecurePwdGoesHere" - // + // // 2. Uncomment these 'remoteEnv' lines: // "remoteEnv": { // "ASPNETCORE_Kestrel__Certificates__Default__Password": "SecurePwdGoesHere", @@ -166,17 +166,17 @@ RUN if [ "$INSTALL_AZURE_CLI" = "true" ]; then bash /tmp/library-scripts/azcli-d You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## Step 3: Modify your devcontainer.json file +## Step 3: Modify your devcontainer.json file With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and restore your project dependencies when your codespace launches. -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) + ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) 2. Update your the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} + + ```json{:copy} "extensions": [ "ms-dotnettools.csharp", "streetsidesoftware.code-spell-checker", @@ -185,7 +185,7 @@ With your dev container added and a basic understanding of what everything does, 3. Uncomment the `postCreateCommand` to restore dependencies as part of the codespace setup process. - ```json{:copy} + ```json{:copy} // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "dotnet restore", ``` @@ -195,22 +195,22 @@ With your dev container added and a basic understanding of what everything does, Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. 5. Check your changes were successfully applied by verifying the "Code Spell Checker" extension was installed. - - ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) - + + ![Extensions list](/assets/images/help/codespaces/dotnet-extensions.png) + ## Step 4: Run your application In the previous section, you used the `postCreateCommand` to install a set of packages via the `dotnet restore` command. With our dependencies now installed, we can run our application. 1. Run your application by pressing `F5` or entering `dotnet watch run` in your terminal. -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) ## Step 5: Commit your changes -{% data reusables.codespaces.committing-link-to-procedure %} +{% data reusables.codespaces.committing-link-to-procedure %} ## Next steps diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md index fcb04982c7..c86e2e3925 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces.md @@ -11,13 +11,13 @@ topics: - Codespaces --- - + ## Introduction This guide shows you how to set up your Java project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### Prerequisites +### Prerequisites - You should have an existing Java project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-java - You must have {% data variables.product.prodname_codespaces %} enabled for your organization. @@ -26,18 +26,18 @@ This guide shows you how to set up your Java project in {% data variables.produc 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. {% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## Step 2: Add a dev container to your codespace from a template +## Step 2: Add a dev container to your codespace from a template The default codespaces container comes with the latest Java version, package managers (Maven, Gradle), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. @@ -81,12 +81,12 @@ The newly added `devcontainer.json` file defines a few properties that are descr }, // Set *default* container specific settings.json values on container create. - "settings": { + "settings": { "terminal.integrated.shell.linux": "/bin/bash", "java.home": "/docker-java-home", "maven.executable.path": "/usr/local/sdkman/candidates/maven/current/bin/mvn" }, - + // Add the IDs of extensions you want installed when the container is created. "extensions": [ "vscjava.vscode-java-pack" @@ -146,13 +146,13 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "source /usr/local/shar You can use the Dockerfile to add additional container layers to specify OS packages, Java versions, or global packages we want included in our Dockerfile. -## Step 3: Modify your devcontainer.json file +## Step 3: Modify your devcontainer.json file With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. 1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) + ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) 2. Add the following lines to your `devcontainer.json` file after `extensions`. @@ -174,7 +174,7 @@ In the previous section, you used the `postCreateCommand` to install a set of pa 1. Run your application by pressing `F5`. -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md index c47f9331f9..d60b18ff3f 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces.md @@ -15,13 +15,13 @@ topics: - JavaScript --- - + ## Introduction This guide shows you how to set up your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### Prerequisites +### Prerequisites - You should have an existing JavaScript, Node.js, or TypeScript project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/microsoft/vscode-remote-try-node - You must have {% data variables.product.prodname_codespaces %} enabled for your organization. @@ -30,22 +30,22 @@ This guide shows you how to set up your JavaScript, Node.js, or TypeScript proje 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. {% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## Step 2: Add a dev container to your codespace from a template +## Step 2: Add a dev container to your codespace from a template The default codespaces container will support running Node.js projects like [vscode-remote-try-node](https://github.com/microsoft/vscode-remote-try-node) out of the box. By setting up a custom container you can customize the tools and scripts that run as part of codespace creation and ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)". {% data reusables.codespaces.command-palette-container %} 3. For this example, click **Node.js**. If you need additional features you can select any container that’s specific to Node or a combination of tools such as Node and MongoDB. @@ -77,7 +77,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr }, // Set *default* container specific settings.json values on container create. - "settings": { + "settings": { "terminal.integrated.shell.linux": "/bin/bash" }, @@ -131,13 +131,13 @@ FROM mcr.microsoft.com/vscode/devcontainers/javascript-node:0-${VARIANT} You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our Dockerfile. -## Step 3: Modify your devcontainer.json file +## Step 3: Modify your devcontainer.json file With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install npm when your codespace launches and make a list of ports inside the container available locally. 1. In the Explorer, select the `devcontainer.json` file from the tree to open it. You might have to expand the `.devcontainer` folder to see it. - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) + ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) 2. Add the following lines to your `devcontainer.json` file after `extensions`: @@ -161,13 +161,13 @@ In the previous section, you used the `postCreateCommand` to installing a set of ![npm start in terminal](/assets/images/help/codespaces/codespaces-npmstart.png) -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. ![Port forwarding toast](/assets/images/help/codespaces/codespaces-port-toast.png) ## Step 5: Commit your changes -{% data reusables.codespaces.committing-link-to-procedure %} +{% data reusables.codespaces.committing-link-to-procedure %} ## Next steps diff --git a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md index 704d568321..f7ed141017 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces.md @@ -14,13 +14,13 @@ topics: - Python --- - + ## Introduction This guide shows you how to set up your Python project in {% data variables.product.prodname_codespaces %}. It will take you through an example of opening your project in a codespace, and adding and modifying a dev container configuration from a template. -### Prerequisites +### Prerequisites - You should have an existing Python project in a repository on {% data variables.product.prodname_dotcom_the_website %}. If you don't have a project, you can try this tutorial with the following example: https://github.com/2percentsilk/python-quickstart. - You must have {% data variables.product.prodname_codespaces %} enabled for your organization. @@ -29,24 +29,24 @@ This guide shows you how to set up your Python project in {% data variables.prod 1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**. - ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) - + ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information. -When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. +When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano. -You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. +You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed. {% data variables.product.prodname_codespaces %} uses a file called `devcontainer.json` to store configurations. On launch {% data variables.product.prodname_codespaces %} uses the file to install any tools, dependencies, or other set up that might be needed for the project. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." -## Step 2: Add a dev container to your codespace from a template +## Step 2: Add a dev container to your codespace from a template The default codespaces container comes with the latest Python version, package managers (pip, Miniconda), and other common tools preinstalled. However, we recommend that you set up a custom container to define the tools and scripts that your project needs. This will ensure a fully reproducible environment for all {% data variables.product.prodname_codespaces %} users in your repository. -To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." +To set up your project with a custom container, you will need to use a `devcontainer.json` file to define the environment. In {% data variables.product.prodname_codespaces %} you can add this either from a template or you can create your own. For more information on dev containers, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)." {% data reusables.codespaces.command-palette-container %} @@ -75,7 +75,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr "build": { "dockerfile": "Dockerfile", "context": "..", - "args": { + "args": { // Update 'VARIANT' to pick a Python version: 3, 3.6, 3.7, 3.8, 3.9 "VARIANT": "3", // Options @@ -85,7 +85,7 @@ The newly added `devcontainer.json` file defines a few properties that are descr }, // Set *default* container specific settings.json values on container create. - "settings": { + "settings": { "terminal.integrated.shell.linux": "/bin/bash", "python.pythonPath": "/usr/local/bin/python", "python.linting.enabled": true, @@ -157,17 +157,17 @@ RUN if [ "${INSTALL_NODE}" = "true" ]; then su vscode -c "umask 0002 && . /usr/l You can use the Dockerfile to add additional container layers to specify OS packages, node versions, or global packages we want included in our container. -## Step 3: Modify your devcontainer.json file +## Step 3: Modify your devcontainer.json file With your dev container added and a basic understanding of what everything does, you can now make changes to configure it for your environment. In this example, you'll add properties to install extensions and your project dependencies when your codespace launches. -1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. +1. In the Explorer, expand the `.devcontainer` folder and select the `devcontainer.json` file from the tree to open it. - !["Codespaces: Rebuild Container" in the command palette](/assets/images/help/codespaces/devcontainers-options.png) + ![devcontainer.json file in the Explorer](/assets/images/help/codespaces/devcontainers-options.png) 2. Update the `extensions` list in your `devcontainer.json` file to add a few extensions that are useful when working with your project. - - ```json{:copy} + + ```json{:copy} "extensions": [ "ms-python.python", "cstrap.flask-snippets", @@ -177,7 +177,7 @@ With your dev container added and a basic understanding of what everything does, 3. Uncomment the `postCreateCommand` to auto-install requirements as part of the codespaces setup process. - ```json{:copy} + ```json{:copy} // Use 'postCreateCommand' to run commands after the container is created. "postCreateCommand": "pip3 install --user -r requirements.txt", ``` @@ -187,16 +187,16 @@ With your dev container added and a basic understanding of what everything does, Rebuilding inside your codespace ensures your changes work as expected before you commit the changes to the repository. If something does result in a failure, you’ll be placed in a codespace with a recovery container that you can rebuild from to keep adjusting your container. 5. Check your changes were successfully applied by verifying the Code Spell Checker and Flask Snippet extensions were installed. - - ![Extensions list](/assets/images/help/codespaces/python-extensions.png) - + + ![Extensions list](/assets/images/help/codespaces/python-extensions.png) + ## Step 4: Run your application In the previous section, you used the `postCreateCommand` to install a set of packages via pip3. With your dependencies now installed, you can run your application. 1. Run your application by pressing `F5` or entering `python -m flask run` in the codespace terminal. -2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. +2. When your project starts, you should see a toast in the bottom right corner with a prompt to connect to the port your project uses. ![Port forwarding toast](/assets/images/help/codespaces/python-port-forwarding.png) diff --git a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md index 48d16d9ef5..54532594b0 100644 --- a/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md +++ b/content/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository.md @@ -14,7 +14,7 @@ shortTitle: Manage discussions Organization owners can choose the permissions required to create a discussion for repositories owned by the organization. For more information, see "[Managing discussion creation for repositories in your organization](/organizations/managing-organization-settings/managing-discussion-creation-for-repositories-in-your-organization)." -As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." +As a discussions maintainer, you can create community resources to encourage discussions that are aligned with the overall project goal and maintain a friendly open forum for collaborators. Creating a code of conduct or contribution guidelines for collaborators to follow will help facilitate a collaborative and productive forum. For more information on creating community resources, see "[Adding a code of conduct to your project](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)," and "[Setting guidelines for repository contributors](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)." When a discussion yields an idea or bug that is ready to be worked on, you can create a new issue from a discussion. For more information, see "[Creating an issue](/issues/tracking-your-work-with-issues/creating-an-issue#creating-an-issue-from-a-discussion)." @@ -62,7 +62,7 @@ Editing a pinned discussion will not change the discussion's category. For more {% data reusables.discussions.discussions-tab %} {% data reusables.discussions.click-discussion-in-list %} 1. In the right sidebar, click {% octicon "pencil" aria-label="The pencil icon" %} **Edit pinned discussion**. - !["Pin discussion" in right sidebar for discussion](/assets/images/help/discussions/click-edit-pinned-discussion.png) + !["Edit pinned discussion" in right sidebar for discussion](/assets/images/help/discussions/click-edit-pinned-discussion.png) 1. Customize the look of the pinned discussion. ![Customization options for a pinned discussion](/assets/images/help/discussions/customize-pinned-discussion.png) 1. Click **Pin discussion**. diff --git a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md b/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md index f7ef05b11a..980d6377d2 100644 --- a/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md +++ b/content/github/administering-a-repository/managing-branches-in-your-repository/changing-the-default-branch.md @@ -56,7 +56,7 @@ To change the default branch, your repository must have more than one branch. Fo 1. Click **Update**. !["Update" button after choosing a new default branch](/assets/images/help/repository/repository-options-defaultbranch-update.png) 1. Read the warning, then click **I understand, update the default branch.** - !["Update" button after choosing a new default branch](/assets/images/help/repository/repository-options-defaultbranch-i-understand.png) + !["I understand, update the default branch." button to perform the update](/assets/images/help/repository/repository-options-defaultbranch-i-understand.png) {% else %} diff --git a/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md index 36bfcf43e0..d665f06d3d 100644 --- a/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/managing-users-in-your-enterprise/managing-support-entitlements-for-your-enterprise.md @@ -28,9 +28,9 @@ Enterprise owners and billing managers automatically have a support entitlement. 3. Under "Settings", click **Support**. ![Support menu item](/assets/images/help/enterprises/settings-support.png) 4. Under "Add support member", start typing the name or username of the person you want to give a support entitlement. Click their name in the list of matches. -![Add support entitlement](/assets/images/help/enterprises/settings-support-entitlement-search.png) +![Add support entitlement search](/assets/images/help/enterprises/settings-support-entitlement-search.png) 5. Click **Add support entitlement**. -![Add support entitlement](/assets/images/help/enterprises/settings-support-add-entitlement.png) +![Add support entitlement button](/assets/images/help/enterprises/settings-support-add-entitlement.png) ## Removing a support entitlement from an enterprise member diff --git a/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md b/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md index c5741ff461..ab651e3393 100644 --- a/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md +++ b/content/github/writing-on-github/working-with-saved-replies/creating-a-saved-reply.md @@ -18,7 +18,7 @@ versions: 5. To review your reply, click **Preview**. ![Add a saved reply](/assets/images/help/settings/saved-replies-preview.png) 6. Click **Add saved reply**. -![Add a saved reply](/assets/images/help/settings/saved-replies-add-button.png) +!["Add saved reply" button](/assets/images/help/settings/saved-replies-add-button.png) ## Further reading diff --git a/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md index 823f4bad3c..19c9f7eae0 100644 --- a/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization.md @@ -120,7 +120,7 @@ To allow {% data variables.product.prodname_dependabot %} to access a private {% 1. Under "{% data variables.product.prodname_dependabot %} private repository access", click **Add private repositories** or **Add internal and private repositories**. ![Add repositories button](/assets/images/help/organizations/dependabot-private-repository-access.png) 1. Start typing the name of the repository you want to allow. - ![Add repositories button](/assets/images/help/organizations/dependabot-private-repo-choose.png) + ![Repository search field with filtered dropdown](/assets/images/help/organizations/dependabot-private-repo-choose.png) 1. Click the repository you want to allow. 1. Optionally, to remove a repository from the list, to the right of the repository, click {% octicon "x" aria-label="The X icon" %}.