diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md index 7e1305c133de..32a51b6316ea 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/troubleshooting-commits-on-your-timeline.md @@ -42,11 +42,11 @@ Most often, the author date and commit date are the same but you may notice that You can use the `git show` command with the `--pretty=fuller` flag to check if the commit author date and commit date are different. ```shell -$ git show Your commit SHA number --pretty=fuller -commit Your commit SHA number -Author: octocat user email +$ git show YOUR_COMMIT_SHA_NUMBER --pretty=fuller +commit YOUR_COMMIT_SHA_NUMBER +Author: octocat USER_EMAIL AuthorDate: Tue Apr 03 02:02:30 2018 +0900 -Commit: Sally Johnson user email +Commit: Sally Johnson USER_EMAIL CommitDate: Tue Apr 10 06:25:08 2018 +0900 ``` diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md index 2d25c0f3c96c..607592a40288 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/remembering-your-github-username-or-email.md @@ -46,7 +46,7 @@ During set up, you may have [set your username in Git](/github/getting-started-w ```shell $ git config user.name # View the setting -YOUR_USERNAME +YOUR_USERNAME ``` ## Finding your username in the URL of remote repositories @@ -60,11 +60,11 @@ If you have any local copies of personal repositories you have created or forked {% endtip %} ```shell -$ cd YOUR_REPOSITORY +$ cd YOUR_REPOSITORY # Change directories to the initialized Git repository $ git remote -v -origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_REPOSITORY.git (fetch) -origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_REPOSITORY.git (push) +origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_REPOSITORY.git (fetch) +origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_REPOSITORY.git (push) ``` Your user name is what immediately follows the `https://{% data variables.command_line.backticks %}/`. diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md index 2a2c0f62849d..66e0967805d1 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/setting-your-commit-email-address.md @@ -51,7 +51,7 @@ To ensure that commits are attributed to you and appear in your contributions gr {% note %} -**Note:** If you created your account on {% data variables.product.product_location %} _after_ July 18, 2017, your `noreply` email address for {% data variables.product.product_name %} is a seven-digit ID number and your username in the form of ID+username@users.noreply.github.com. If you created your account on {% data variables.product.product_location %} _prior to_ July 18, 2017, your `noreply` email address from {% data variables.product.product_name %} is username@users.noreply.github.com. You can get an ID-based `noreply` email address for {% data variables.product.product_name %} by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings. +**Note:** If you created your account on {% data variables.product.product_location %} _after_ July 18, 2017, your `noreply` email address for {% data variables.product.product_name %} is a seven-digit ID number and your username in the form of ID+USERNAME@users.noreply.github.com. If you created your account on {% data variables.product.product_location %} _prior to_ July 18, 2017, your `noreply` email address from {% data variables.product.product_name %} is USERNAME@users.noreply.github.com. You can get an ID-based `noreply` email address for {% data variables.product.product_name %} by selecting (or deselecting and reselecting) **Keep my email address private** in your email settings. {% endnote %} @@ -76,7 +76,7 @@ You can use the `git config` command to change the email address you associate w {% data reusables.command_line.open_the_multi_os_terminal %} 2. {% data reusables.user-settings.set_your_email_address_in_git %} ```shell - $ git config --global user.email "email@example.com" + $ git config --global user.email "YOUR_EMAIL" ``` 3. {% data reusables.user-settings.confirm_git_email_address_correct %} ```shell @@ -95,7 +95,7 @@ You can change the email address associated with commits you make in a single re 2. Change the current working directory to the local repository where you want to configure the email address that you associate with your Git commits. 3. {% data reusables.user-settings.set_your_email_address_in_git %} ```shell - $ git config user.email "email@example.com" + $ git config user.email "YOUR_EMAIL" ``` 4. {% data reusables.user-settings.confirm_git_email_address_correct %} ```shell diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md index c0416753fc7b..d17bd90d2e0e 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-your-personal-account/best-practices-for-leaving-your-company.md @@ -39,5 +39,5 @@ If you've been collaborating professionally with another person on repositories - Delete local copies of your forks that may exist on your computer: ```shell -$ rm -rf work_directory +$ rm -rf WORK_DIRECTORY ``` diff --git a/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md b/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md index 69702e405a62..1459f98cd502 100644 --- a/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md +++ b/content/actions/deployment/deploying-xcode-applications/installing-an-apple-certificate-on-macos-runners-for-xcode-development.md @@ -49,7 +49,7 @@ Create secrets in your repository or organization for the following items: - Use the following command to convert your certificate to Base64 and copy it to your clipboard: ```shell - base64 build_certificate.p12 | pbcopy + base64 BUILD_CERTIFICATE.p12 | pbcopy ``` * The password for your Apple signing certificate. - In this example, the secret is named `P12_PASSWORD`. @@ -63,7 +63,7 @@ Create secrets in your repository or organization for the following items: - Use the following command to convert your provisioning profile to Base64 and copy it to your clipboard: ```shell - base64 provisioning_profile.mobileprovision | pbcopy + base64 PROVISIONING_PROFILE.mobileprovision | pbcopy ``` * A keychain password. diff --git a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 053f0e3d1eea..e2894b8fdda5 100644 --- a/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -63,7 +63,7 @@ By default, self-hosted runners will automatically perform a software update whe To turn off automatic software updates and install software updates yourself, specify the `--disableupdate` flag when registering your runner using `config.sh`. For example: ```shell -./config.sh --url https://github.com/octo-org --token example-token --disableupdate +./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate ``` If you disable automatic updates, you must still update your runner version regularly. New functionality in {% data variables.product.prodname_actions %} requires changes in both the {% data variables.product.prodname_actions %} service _and_ the runner software. The runner may not be able to correctly process jobs that take advantage of new features in {% data variables.product.prodname_actions %} without a software update. diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index f95896503ddf..7463d3c5df25 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -77,7 +77,7 @@ You can manage the runner service in the Windows **Services** application, or yo 1. Alternatively, the command takes an optional `user` argument to install the service as a different user. ```shell - ./svc.sh install USERNAME + ./svc.sh install USERNAME ``` {% endlinux %} diff --git a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md index cf4ef299dfca..02a70e8c2698 100644 --- a/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -59,7 +59,7 @@ For example: {% windows %} ```shell -run.cmd --check --url https://github.com/octo-org/octo-repo --pat ghp_abcd1234 +run.cmd --check --url https://github.com/YOUR-ORG/YOUR-REPO --pat GHP_ABCD1234 ``` {% endwindows %} @@ -79,7 +79,7 @@ To disable TLS certification verification in the self-hosted runner application, ```shell export GITHUB_ACTIONS_RUNNER_TLS_NO_VERIFY=1 -./config.sh --url https://github.com/octo-org/octo-repo --token +./config.sh --url https://github.com/YOUR-ORG/YOUR-REPO --token ./run.sh ``` diff --git a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md index 2d0cc5de2275..874af25df8a1 100644 --- a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md +++ b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md @@ -53,7 +53,7 @@ The disabled workflow is marked {% octicon "stop" aria-label="The stop icon" %} To disable a workflow, use the `workflow disable` subcommand. Replace `workflow` with either the name, ID, or file name of the workflow you want to disable. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. ```shell -gh workflow disable workflow +gh workflow disable WORKFLOW ``` {% endcli %} @@ -78,7 +78,7 @@ You can re-enable a workflow that was previously disabled. To enable a workflow, use the `workflow enable` subcommand. Replace `workflow` with either the name, ID, or file name of the workflow you want to enable. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. ```shell -gh workflow enable workflow +gh workflow enable WORKFLOW ``` {% endcli %} diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index bcb6ba75e9cc..8956cc166085 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -38,25 +38,25 @@ By default, {% data variables.product.product_name %} stores build logs and arti To download all artifacts generated by a workflow run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. ```shell -gh run download run-id +gh run download RUN_ID ``` To download a specific artifact from a run, use the `run download` subcommand. Replace `run-id` with the ID of the run that you want to download artifacts from. Replace `artifact-name` with the name of the artifact that you want to download. ```shell -gh run download run-id -n artifact-name +gh run download RUN_ID -n ARTIFACT_NAME ``` You can specify more than one artifact. ```shell -gh run download run-id -n artifact-name-1 -n artifact-name-2 +gh run download RUN_ID> -n ARTIFACT_NAME-1 -n ARTIFACT_NAME-2 ``` To download specific artifacts across all runs in a repository, use the `run download` subcommand. ```shell -gh run download -n artifact-name-1 -n artifact-name-2 +gh run download -n ARTIFACT_NAME-1 ARTIFACT_NAME-2 ``` {% endcli %} diff --git a/content/actions/managing-workflow-runs/manually-running-a-workflow.md b/content/actions/managing-workflow-runs/manually-running-a-workflow.md index c8fd986c665c..f574fca54c68 100644 --- a/content/actions/managing-workflow-runs/manually-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/manually-running-a-workflow.md @@ -40,7 +40,7 @@ To run a workflow manually, the workflow must be configured to run on the `workf To run a workflow, use the `workflow run` subcommand. Replace the `workflow` parameter with either the name, ID, or file name of the workflow you want to run. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. If you don't specify a workflow, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a workflow. ```shell -gh workflow run workflow +gh workflow run WORKFLOW ``` If your workflow accepts inputs, {% data variables.product.prodname_cli %} will prompt you to enter them. Alternatively, you can use `-f` or `-F` to add an input in `key=value` format. Use `-F` to read from a file. @@ -58,7 +58,7 @@ echo '{"name":"mona", "greeting":"hello"}' | gh workflow run greet.yml --json To run a workflow on a branch other than the repository's default branch, use the `--ref` flag. ```shell -gh workflow run workflow --ref branch-name +gh workflow run WORKFLOW --ref BRANCH ``` To view the progress of the workflow run, use the `run watch` subcommand and select the run from the interactive list. diff --git a/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index cc2359f7a547..a1d240e9c058 100644 --- a/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -48,14 +48,14 @@ Re-running a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif % To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id +gh run rerun RUN_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --debug +gh run rerun RUN_ID --debug ``` {% endif %} @@ -90,14 +90,14 @@ If any jobs in a workflow run failed, you can re-run just the jobs that failed. To re-run failed jobs in a workflow run, use the `run rerun` subcommand with the `--failed` flag. Replace `run-id` with the ID of the run for which you want to re-run failed jobs. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id --failed +gh run rerun RUN_ID --failed ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --failed --debug +gh run rerun RUN_ID --failed --debug ``` {% endif %} @@ -127,14 +127,14 @@ When you re-run a specific job in a workflow, a new workflow run will start for To re-run a specific job in a workflow run, use the `run rerun` subcommand with the `--job` flag. Replace `job-id` with the ID of the job that you want to re-run. ```shell -gh run rerun --job job-id +gh run rerun --job JOB_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun --job job-id --debug +gh run rerun --job JOB_ID --debug ``` {% endif %} diff --git a/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md b/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md index 2aee2b29f066..e246dcd3bb34 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/using-workflow-run-logs.md @@ -98,23 +98,23 @@ After deleting logs, the **Delete all logs** button is removed to indicate that To view the log for a specific job, use the `run view` subcommand. Replace `run-id` with the ID of run that you want to view logs for. {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a job from the run. If you don't specify `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run, and then returns another interactive menu for you to choose a job from the run. ```shell -gh run view run-id --log +gh run view RUN_ID --log ``` You can also use the `--job` flag to specify a job ID. Replace `job-id` with the ID of the job that you want to view logs for. ```shell -gh run view --job job-id --log +gh run view --job JOB_ID --log ``` You can use `grep` to search the log. For example, this command will return all log entries that contain the word `error`. ```shell -gh run view --job job-id --log | grep error +gh run view --job JOB_ID --log | grep error ``` To filter the logs for any failed steps, use `--log-failed` instead of `--log`. ```shell -gh run view --job job-id --log-failed +gh run view --job JOB_ID --log-failed ``` diff --git a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md b/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md index f1e7af9ec9c5..c73a4583ed5d 100644 --- a/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md +++ b/content/actions/monitoring-and-troubleshooting-workflows/viewing-workflow-run-history.md @@ -46,7 +46,7 @@ gh run list --limit 5 To only return runs for the specified workflow, you can use the `-w` or `--workflow` flag. Replace `workflow` with either the workflow name, workflow ID, or workflow file name. For example, `"Link Checker"`, `1234567`, or `"link-check-test.yml"`. ```shell -gh run list --workflow workflow +gh run list --workflow WORKFLOW ``` ### Viewing details for a specific workflow run @@ -54,25 +54,25 @@ gh run list --workflow workflow To display details for a specific workflow run, use the `run view` subcommand. Replace `run-id` with the ID of the run that you want to view. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent run. ```shell -gh run view run-id +gh run view RUN_ID ``` To include job steps in the output, use the `-v` or `--verbose` flag. ```shell -gh run view run-id --verbose +gh run view RUN_ID --verbose ``` To view details for a specific job in the run, use the `-j` or `--job` flag. Replace `job-id` with the ID of the job that you want to view. ```shell -gh run view --job job-id +gh run view --job JOB_ID ``` To view the full log for a job, use the `--log` flag. ```shell -gh run view --job job-id --log +gh run view --job JOB_ID --log ``` Use the `--exit-status` flag to exit with a non-zero status if the run failed. For example: diff --git a/content/actions/security-guides/encrypted-secrets.md b/content/actions/security-guides/encrypted-secrets.md index 9a60fda43d2f..e678c2474ce0 100644 --- a/content/actions/security-guides/encrypted-secrets.md +++ b/content/actions/security-guides/encrypted-secrets.md @@ -93,13 +93,13 @@ If your repository has environment secrets or can access secrets from the parent To add a repository secret, use the `gh secret set` subcommand. Replace `secret-name` with the name of your secret. ```shell -gh secret set secret-name +gh secret set SECRET_NAME ``` The CLI will prompt you to enter a secret value. Alternatively, you can read the value of the secret from a file. ```shell -gh secret set secret-name < secret.txt +gh secret set SECRET_NAME < secret.txt ``` To list all secrets for the repository, use the `gh secret list` subcommand. @@ -128,13 +128,13 @@ To list all secrets for the repository, use the `gh secret list` subcommand. To add a secret for an environment, use the `gh secret set` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret set --env environment-name secret-name +gh secret set --env ENV_NAME SECRET_NAME ``` To list all secrets for an environment, use the `gh secret list` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret list --env environment-name +gh secret list --env ENV_NAME ``` {% endcli %} @@ -173,25 +173,25 @@ gh auth login --scopes "admin:org" To add a secret for an organization, use the `gh secret set` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret set --org organization-name secret-name +gh secret set --org ORG_NAME SECRET_NAME ``` By default, the secret is only available to private repositories. To specify that the secret should be available to all repositories within the organization, use the `--visibility` or `-v` flag. ```shell -gh secret set --org organization-name secret-name --visibility all +gh secret set --org ORG_NAME SECRET_NAME --visibility all ``` To specify that the secret should be available to selected repositories within the organization, use the `--repos` or `-r` flag. ```shell -gh secret set --org organization-name secret-name --repos repo-name-1,repo-name-2" +gh secret set --org ORG_NAME SECRET_NAME --repos REPO-NAME-1, REPO-NAME-2" ``` To list all secrets for an organization, use the `gh secret list` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret list --org organization-name +gh secret list --org ORG_NAME ``` {% endcli %} diff --git a/content/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh.md b/content/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh.md index 4a9caa69d2f8..9cf7eeddc96d 100644 --- a/content/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh.md +++ b/content/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh.md @@ -58,13 +58,13 @@ If you encounter the `Permission denied (publickey)` error when you try to conne To specify a private SSH key using the command line, run `ssh` with the `-i` argument. ```shell -ssh -i /path/to/ghe_private_key -p 122 admin@hostname +ssh -i /path/to/ghe_private_key -p 122 admin@HOSTNAME ``` You can also specify a private SSH key using the SSH configuration file (`~/.ssh/config`). ```shell -Host hostname +Host HOSTNAME IdentityFile /path/to/ghe_private_key User admin Port 122 diff --git a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md index 5fa9384fb2de..6ce475f51194 100644 --- a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -69,11 +69,11 @@ With this command, you can also pause or resume jobs in the queue. ```shell $ ghe-aqueduct status # lists queues and the number of currently queued jobs for all queues -$ ghe-aqueduct queue_depth --queue QUEUE +$ ghe-aqueduct queue_depth --queue QUEUE # lists the number of currently queued jobs for the specified queue -$ ghe-aqueduct pause --queue QUEUE +$ ghe-aqueduct pause --queue QUEUE # pauses the specified queue -$ ghe-aqueduct resume --queue QUEUE +$ ghe-aqueduct resume --queue QUEUE # resumes the specified queue ``` {% endif %} @@ -112,24 +112,24 @@ ghe-cleanup-settings With this utility, you can both retrieve and modify the configuration settings of {% data variables.product.product_location %}. ```shell -$ ghe-config core.github-hostname +$ ghe-config core.github-hostname # Gets the configuration value of `core.github-hostname` -$ ghe-config core.github-hostname 'example.com' -# Sets the configuration value of `core.github-hostname` to `example.com` +$ ghe-config core.github-hostname URL +# Sets the configuration value of `core.github-hostname` to the specified URL $ ghe-config -l # Lists all the configuration values ``` Allows you to find the universally unique identifier (UUID) of your node in `cluster.conf`. ```shell - $ ghe-config HOSTNAME.uuid + $ ghe-config HOSTNAME.uuid ``` {% ifversion ghes %} Allows you to exempt a list of users from REST API rate limits. A hard limit of 120,000 requests will still apply to these users. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)." ``` shell -$ ghe-config app.github.rate-limiting-exempt-users "hubot github-actions" +$ ghe-config app.github.rate-limiting-exempt-users "HUBOT GITHUB-ACTIONS" # Exempts the users hubot and github-actions from rate limits ``` {% endif %} @@ -240,7 +240,7 @@ ghe-motd This utility returns a repository's name and owner based on the repository ID. ```shell -ghe-nwo REPOSITORY_ID +ghe-nwo REPOSITORY_ID ``` ### ghe-org-admin-promote @@ -259,19 +259,19 @@ This utility cannot promote a non-site admin to be an owner of all organizations Give organization owner privileges in a specific organization to a specific site admin ```shell -ghe-org-admin-promote -u USERNAME -o ORGANIZATION +ghe-org-admin-promote -u USERNAME -o ORGANIZATION ``` Give organization owner privileges in all organizations to a specific site admin ```shell -ghe-org-admin-promote -u USERNAME +ghe-org-admin-promote -u USERNAME ``` Give organization owner privileges in a specific organization to all site admins ```shell -ghe-org-admin-promote -o ORGANIZATION +ghe-org-admin-promote -o ORGANIZATION ``` Give organization owner privileges in all organizations to all site admins @@ -452,7 +452,7 @@ You can use these additional options with the utility: - The `-h` flag displays more usage information. ```shell -ghe-ssl-ca-certificate-install -c /path/to/certificate +ghe-ssl-ca-certificate-install -c CERTIFICATE_PATH ``` ### ghe-ssl-certificate-setup @@ -502,24 +502,24 @@ ghe-webhook-logs To show all failed hook deliveries in the past day: {% ifversion ghes %} ```shell -ghe-webhook-logs -f -a YYYY-MM-DD +ghe-webhook-logs -f -a YYYY-MM-DD ``` The date format should be `YYYY-MM-DD`, `YYYY-MM-DD HH:MM:SS`, or `YYYY-MM-DD HH:MM:SS (+/-) HH:M`. {% else %} ```shell -ghe-webhook-logs -f -a YYYYMMDD +ghe-webhook-logs -f -a YYYYMMDD ``` {% endif %} To show the full hook payload, result, and any exceptions for the delivery: {% ifversion ghes %} ```shell -ghe-webhook-logs -g delivery-guid +ghe-webhook-logs -g DELIVERY_GUID ``` {% else %} ```shell -ghe-webhook-logs -g delivery-guid -v +ghe-webhook-logs -g DELIVERY_GUID -v ``` {% endif %} @@ -541,22 +541,22 @@ By default, the command creates the tarball in */tmp*, but you can also have it To create a standard bundle: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz +$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -o' > cluster-support-bundle.tgz ``` To create an extended bundle: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz +$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -x -o' > cluster-support-bundle.tgz ``` To send a bundle to {% data variables.contact.github_support %}: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -u' +$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -u' ``` To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-cluster-support-bundle -t ticket-id' +$ ssh -p 122 admin@HOSTNAME -- 'ghe-cluster-support-bundle -t TICKET_ID' ``` {% ifversion ghes %} @@ -584,7 +584,7 @@ ghe-dpages status To evacuate a {% data variables.product.prodname_pages %} storage service before evacuating a cluster node: ```shell -ghe-dpages evacuate pages-server-UUID +ghe-dpages evacuate pages-server-UUID ``` ### ghe-spokes @@ -610,7 +610,7 @@ ghe-spokes route To evacuate storage services on a cluster node: ```shell -ghe-spokes server evacuate git-server-UUID +ghe-spokes server evacuate git-server-UUID ``` ### ghe-storage @@ -618,7 +618,7 @@ ghe-spokes server evacuate git-server-UUID This utility allows you to evacuate all storage services before evacuating a cluster node. ```shell -ghe-storage evacuate storage-server-UUID +ghe-storage evacuate storage-server-UUID ``` ## Git @@ -661,7 +661,7 @@ Try ghe-governor --help for more information on the arguments each This utility allows you to change to a repository's directory and open an interactive shell as the `git` user. You can perform manual inspection or maintenance of a repository via commands like `git-*` or `git-nw-*`. ```shell -ghe-repo username/reponame +ghe-repo USERNAME/REPONAME ``` ### ghe-repo-gc @@ -677,7 +677,7 @@ You can add the optional `--prune` argument to remove unreachable Git objects th {% endwarning %} ```shell -ghe-repo-gc username/reponame +ghe-repo-gc USERNAME/REPONAME ``` ## {% data variables.product.prodname_actions %} @@ -697,7 +697,7 @@ This utility tests the blob storage configuration for {% data variables.product. For more information about the configuration of {% data variables.product.prodname_actions %}, see "[Getting started with {% data variables.product.prodname_actions %} for {% data variables.product.product_name %}](/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-github-actions-for-github-enterprise-server)." ```shell -ghe-actions-precheck -p [provider] -cs ["connectionstring"] +ghe-actions-precheck -p [PROVIDER] -cs ["CONNECTION-STRING"] ``` If your storage system is configured correctly, you'll see the following output. @@ -784,23 +784,23 @@ By default, the command creates the tarball in */tmp*, but you can also have it To create a standard bundle: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz +$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz ``` To create an extended bundle: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -x -o' > support-bundle.tgz +$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -x -o' > support-bundle.tgz ``` To send a bundle to {% data variables.contact.github_support %}: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -u' +$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -u' ``` To send a bundle to {% data variables.contact.github_support %} and associate the bundle with a ticket: ```shell -$ ssh -p 122 admin@hostname -- 'ghe-support-bundle -t ticket-id' +$ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -t TICKET_ID' ``` ### ghe-support-upload @@ -809,12 +809,12 @@ This utility sends information from your appliance to {% data variables.product. To send a file to {% data variables.contact.github_support %} and associate the file with a ticket: ```shell -ghe-support-upload -f path/to/your/file -t ticket-id +ghe-support-upload -f FILE_PATH -t TICKET_ID ``` To upload data via `STDIN` and associating the data with a ticket: ```shell -ghe-repl-status -vv | ghe-support-upload -t ticket-id -d "Verbose Replication Status" +ghe-repl-status -vv | ghe-support-upload -t TICKET_ID -d "Verbose Replication Status" ``` In this example, `ghe-repl-status -vv` sends verbose status information from a replica appliance. You should replace `ghe-repl-status -vv` with the specific data you'd like to stream to `STDIN`, and `Verbose Replication Status` with a brief description of the data. {% data reusables.enterprise_enterprise_support.support_will_ask_you_to_run_command %} @@ -827,12 +827,12 @@ This utility installs or verifies an upgrade package. You can also use this util To verify an upgrade package: ```shell -ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME +ghe-upgrade --verify UPGRADE-PACKAGE-FILENAME ``` To install an upgrade package: ```shell -ghe-upgrade UPGRADE-PACKAGE-FILENAME +ghe-upgrade UPGRADE-PACKAGE-FILENAME ``` {% data reusables.enterprise_installation.command-line-utilities-ghe-upgrade-rollback %} @@ -843,18 +843,18 @@ This utility manages scheduled installation of upgrade packages. You can show, c To schedule a new installation for a package: ```shell -$ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME +$ ghe-upgrade-scheduler -c "0 2 15 12 *" UPGRADE-PACKAGE-FILENAME ``` To show scheduled installations for a package: ```shell -$ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME -> 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1 +$ ghe-upgrade-scheduler -s UPGRADE PACKAGE FILENAME +> 0 2 15 12 * /usr/local/bin/ghe-upgrade -y -s UPGRADE-PACKAGE-FILENAME > /data/user/common/UPGRADE-PACKAGE-FILENAME.log 2>&1 ``` To remove scheduled installations for a package: ```shell -$ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME +$ ghe-upgrade-scheduler -r UPGRADE PACKAGE FILENAME ``` ### ghe-update-check @@ -866,7 +866,7 @@ A file containing the status of the download is available at */var/lib/ghe-updat To check for the latest {% data variables.product.prodname_enterprise %} release, use the `-i` switch. ```shell -$ ssh -p 122 admin@hostname -- 'ghe-update-check' +$ ssh -p 122 admin@HOSTNAME -- 'ghe-update-check' ``` ## User management @@ -886,7 +886,7 @@ ghe-license-usage This utility will enforce the default organization membership visibility setting on all members in your instance. For more information, see "[Configuring visibility for organization membership](/enterprise/admin/guides/user-management/configuring-visibility-for-organization-membership)." Setting options are `public` or `private`. ```shell -ghe-org-membership-update --visibility=SETTING +ghe-org-membership-update --visibility=SETTING ``` ### `ghe-user-csv` @@ -902,7 +902,7 @@ ghe-user-csv -o > users.csv This utility demotes the specified user from admin status to that of a regular user. We recommend using the web UI to perform this action, but provide this utility in case the `ghe-user-promote` utility is run in error and you need to demote a user again from the CLI. ```shell -ghe-user-demote some-user-name +ghe-user-demote USERNAME ``` ### ghe-user-promote @@ -910,7 +910,7 @@ ghe-user-demote some-user-name This utility promotes the specified user account to a site administrator. ```shell -ghe-user-promote some-user-name +ghe-user-promote USERNAME ``` ### ghe-user-suspend @@ -918,7 +918,7 @@ ghe-user-promote some-user-name This utility suspends the specified user, preventing them from logging in, pushing, or pulling from your repositories. ```shell -ghe-user-suspend some-user-name +ghe-user-suspend USERNAME ``` ### ghe-user-unsuspend @@ -926,5 +926,5 @@ ghe-user-suspend some-user-name This utility unsuspends the specified user, granting them access to login, push, and pull from your repositories. ```shell -ghe-user-unsuspend some-user-name +ghe-user-unsuspend USERNAME ``` diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 26c878bfaa04..6f6735949d9d 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -93,7 +93,7 @@ By default, the rate limit for {% data variables.product.prodname_actions %} is ```shell ghe-config actions-rate-limiting.enabled true - ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE ``` 1. To disable the rate limit after it's been enabled, run the following command. diff --git a/content/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance.md b/content/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance.md index c87cbf91dfd2..650620169766 100644 --- a/content/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance.md +++ b/content/admin/configuration/configuring-your-enterprise/configuring-ssh-connections-to-your-instance.md @@ -42,7 +42,7 @@ For more information, see [{% data variables.product.prodname_blog %}](https://g 1. To configure a cutoff date after which {% data variables.product.product_location %} will deny connections from clients that use an RSA key uploaded after the date if the connection is signed by the SHA-1 hash function, enter the following command. Replace _**RFC-3399-UTC-TIMESTAMP**_ with a valid RFC 3399 UTC timestamp. For example, the default value, August 1, 2022, would be represented as `2022-08-01T00:00:00Z`. For more information, see [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339) on the IETF website. 
-   $ ghe-config app.gitauth.rsa-sha1 RFC-3339-UTC-TIMESTAMP
+   $ ghe-config app.gitauth.rsa-sha1 RFC-3339-UTC-TIMESTAMP
1. Alternatively, to completely disable SSH connections using RSA keys that are signed with the SHA-1 hash function, enter the following command. diff --git a/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 5bd322dcae97..ea742e0fc5ea 100644 --- a/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -67,7 +67,7 @@ You can also access these reports programmatically via standard HTTP authenticat For example, here is how you would download the "all users" report using cURL: ```shell -curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv +curl -L -u USERNAME:TOKEN http(s)://HOSTNAME/stafftools/reports/all_users.csv ``` To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. diff --git a/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md b/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md index ef85e216291d..2e6628067727 100644 --- a/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md +++ b/content/admin/configuration/configuring-your-enterprise/verifying-or-approving-a-domain-for-your-enterprise.md @@ -64,7 +64,7 @@ To verify your enterprise account's domain, you must have access to modify domai {% data reusables.organizations.add-dns-txt-record %} 1. Wait for your DNS configuration to change, which may take up to 72 hours. You can confirm your DNS configuration has changed by running the `dig` command on the command line, replacing `ENTERPRISE-ACCOUNT` with the name of your enterprise account, and `example.com` with the domain you'd like to verify. You should see your new TXT record listed in the command output. ```shell - dig _github-challenge-ENTERPRISE-ACCOUNT.example.com +nostats +nocomments +nocmd TXT + dig _github-challenge-ENTERPRISE-ACCOUNT.DOMAIN-NAME +nostats +nocomments +nocmd TXT ``` 1. After confirming your TXT record is added to your DNS, follow steps one through four above to navigate to your enterprise account's approved and verified domains. {% data reusables.enterprise-accounts.continue-verifying-domain %} diff --git a/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md b/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md index ca4f7f0bfdd9..708967668a9c 100644 --- a/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md +++ b/content/admin/enterprise-management/caching-repositories/configuring-a-repository-cache.md @@ -45,7 +45,7 @@ Then, when told to fetch `https://github.example.com/myorg/myrepo`, Git will ins 1. Connect to the repository cache's IP address using SSH. ```shell - $ ssh -p 122 admin@REPLICA IP + $ ssh -p 122 admin@REPLICA-IP ``` {%- ifversion ghes = 3.3 %} 1. On your cache replica, enable the feature flag for repository caching. @@ -59,13 +59,13 @@ Then, when told to fetch `https://github.example.com/myorg/myrepo`, Git will ins 1. To verify the connection to the primary and enable replica mode for the repository cache, run `ghe-repl-setup` again. ```shell - $ ghe-repl-setup PRIMARY IP + $ ghe-repl-setup PRIMARY-IP ``` 1. Set a `cache_location` for the repository cache, replacing *CACHE-LOCATION* with an alphanumeric identifier, such as the region where the cache is deployed. Also set a datacenter name for this cache; new caches will attempt to seed from another cache in the same datacenter. ```shell - $ ghe-repl-node --cache CACHE-LOCATION --datacenter REPLICA-DC-NAME + $ ghe-repl-node --cache CACHE-LOCATION --datacenter REPLICA-DC-NAME ``` {% data reusables.enterprise_installation.replication-command %} diff --git a/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md b/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md index d7ffe82391af..1291e253e1c4 100644 --- a/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/configuring-high-availability-replication-for-a-cluster.md @@ -61,8 +61,8 @@ Before you define a secondary datacenter for your passive nodes, ensure that you ```shell [cluster] - mysql-master = HOSTNAME - redis-master = HOSTNAME + mysql-master = HOSTNAME + redis-master = HOSTNAME primary-datacenter = default ``` @@ -77,10 +77,10 @@ Before you define a secondary datacenter for your passive nodes, ensure that you When you're done, the section for each node in the cluster configuration file should look like the following example. {% data reusables.enterprise_clustering.key-value-pair-order-irrelevant %} ```shell - [cluster "HOSTNAME"] + [cluster "HOSTNAME"] datacenter = default - hostname = HOSTNAME - ipv4 = IP ADDRESS + hostname = HOSTNAME + ipv4 = IP-ADDRESS ... ... ``` @@ -143,7 +143,7 @@ For an example configuration, see "[Example configuration](#example-configuratio 6. Decide on a name for the secondary datacenter where you provisioned your passive nodes, then update the temporary cluster configuration file with the new datacenter name. Replace `SECONDARY` with the name you choose. ```shell - sed -i 's/datacenter = default/datacenter = SECONDARY/g' ~/cluster-passive.conf + sed -i 's/datacenter = default/datacenter = SECONDARY/g' ~/cluster-passive.conf ``` 7. Decide on a pattern for the passive nodes' hostnames. @@ -167,10 +167,10 @@ For an example configuration, see "[Example configuration](#example-configuratio - Add a new key-value pair, `replica = enabled`. ```shell - [cluster "NEW PASSIVE NODE HOSTNAME"] + [cluster "NEW PASSIVE NODE HOSTNAME"] ... - hostname = NEW PASSIVE NODE HOSTNAME - ipv4 = NEW PASSIVE NODE IPV4 ADDRESS + hostname = NEW PASSIVE NODE HOSTNAME + ipv4 = NEW PASSIVE NODE IPV4 ADDRESS replica = enabled ... ... @@ -185,8 +185,8 @@ For an example configuration, see "[Example configuration](#example-configuratio 11. Designate the primary MySQL and Redis nodes in the secondary datacenter. Replace `REPLICA MYSQL PRIMARY HOSTNAME` and `REPLICA REDIS PRIMARY HOSTNAME` with the hostnames of the passives node that you provisioned to match your existing MySQL and Redis primaries. ```shell - git config -f /data/user/common/cluster.conf cluster.mysql-master-replica REPLICA MYSQL PRIMARY HOSTNAME - git config -f /data/user/common/cluster.conf cluster.redis-master-replica REPLICA REDIS PRIMARY HOSTNAME + git config -f /data/user/common/cluster.conf cluster.mysql-master-replica REPLICA-MYSQL-PRIMARY-HOSTNAME + git config -f /data/user/common/cluster.conf cluster.redis-master-replica REPLICA-REDIS-PRIMARY-HOSTNAME ``` {% warning %} @@ -194,7 +194,7 @@ For an example configuration, see "[Example configuration](#example-configuratio **Warning**: Review your cluster configuration file before proceeding. - In the top-level `[cluster]` section, ensure that the values for `mysql-master-replica` and `redis-master-replica` are the correct hostnames for the passive nodes in the secondary datacenter that will serve as the MySQL and Redis primaries after a failover. - - In each section for an active node named [cluster "ACTIVE NODE HOSTNAME"], double-check the following key-value pairs. + - In each section for an active node named [cluster "ACTIVE NODE HOSTNAME"], double-check the following key-value pairs. - `datacenter` should match the value of `primary-datacenter` in the top-level `[cluster]` section. - `consul-datacenter` should match the value of `datacenter`, which should be the same as the value for `primary-datacenter` in the top-level `[cluster]` section. - Ensure that for each active node, the configuration has **one** corresponding section for **one** passive node with the same roles. In each section for a passive node, double-check each key-value pair. @@ -235,11 +235,11 @@ The top-level `[cluster]` configuration should look like the following example. ```shell [cluster] - mysql-master = HOSTNAME OF ACTIVE MYSQL MASTER - redis-master = HOSTNAME OF ACTIVE REDIS MASTER - primary-datacenter = PRIMARY DATACENTER NAME - mysql-master-replica = HOSTNAME OF PASSIVE MYSQL MASTER - redis-master-replica = HOSTNAME OF PASSIVE REDIS MASTER + mysql-master = HOSTNAME-OF-ACTIVE-MYSQL-MASTER + redis-master = HOSTNAME-OF-ACTIVE-REDIS-MASTER + primary-datacenter = PRIMARY-DATACENTER-NAME + mysql-master-replica = HOSTNAME-OF-PASSIVE-MYSQL-MASTER + redis-master-replica = HOSTNAME-OF-PASSIVE-REDIS-MASTER mysql-auto-failover = false ... ``` @@ -248,10 +248,10 @@ The configuration for an active node in your cluster's storage tier should look ```shell ... -[cluster "UNIQUE ACTIVE NODE HOSTNAME"] +[cluster "UNIQUE ACTIVE NODE HOSTNAME"] datacenter = default - hostname = UNIQUE ACTIVE NODE HOSTNAME - ipv4 = IPV4 ADDRESS + hostname = UNIQUE-ACTIVE-NODE-HOSTNAME + ipv4 = IPV4-ADDRESS consul-datacenter = default consul-server = true git-server = true @@ -262,9 +262,9 @@ The configuration for an active node in your cluster's storage tier should look memcache-server = true metrics-server = true storage-server = true - vpn = IPV4 ADDRESS SET AUTOMATICALLY - uuid = UUID SET AUTOMATICALLY - wireguard-pubkey = PUBLIC KEY SET AUTOMATICALLY + vpn = IPV4 ADDRESS SET AUTOMATICALLY + uuid = UUID SET AUTOMATICALLY + wireguard-pubkey = PUBLIC KEY SET AUTOMATICALLY ... ``` @@ -276,12 +276,12 @@ The configuration for the corresponding passive node in the storage tier should ```shell ... -[cluster "UNIQUE PASSIVE NODE HOSTNAME"] +[cluster "UNIQUE PASSIVE NODE HOSTNAME"] replica = enabled - ipv4 = IPV4 ADDRESS OF NEW VM WITH IDENTICAL RESOURCES - datacenter = SECONDARY DATACENTER NAME - hostname = UNIQUE PASSIVE NODE HOSTNAME - consul-datacenter = SECONDARY DATACENTER NAME + ipv4 = IPV4 ADDRESS OF NEW VM WITH IDENTICAL RESOURCES + datacenter = SECONDARY DATACENTER NAME + hostname = UNIQUE PASSIVE NODE HOSTNAME + consul-datacenter = SECONDARY DATACENTER NAME consul-server = true git-server = true pages-server = true @@ -291,9 +291,9 @@ The configuration for the corresponding passive node in the storage tier should memcache-server = true metrics-server = true storage-server = true - vpn = DO NOT DEFINE - uuid = DO NOT DEFINE - wireguard-pubkey = DO NOT DEFINE + vpn = DO NOT DEFINE + uuid = DO NOT DEFINE + wireguard-pubkey = DO NOT DEFINE ... ``` diff --git a/content/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node.md b/content/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node.md index 8eda99929945..21bb5a51dc8b 100644 --- a/content/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node.md +++ b/content/admin/enterprise-management/configuring-clustering/evacuating-a-cluster-node.md @@ -37,49 +37,49 @@ If you plan to take a node offline and the node runs a data service role like `g 1. To find the UUID of the node to evacuate, run the following command. Replace `HOSTNAME` with the node's hostname. ```shell - $ ghe-config cluster.HOSTNAME.uuid + $ ghe-config cluster.HOSTNAME.uuid ``` 1. Monitor the node's status while {% data variables.product.product_name %} copies the data. Don't take the node offline until the copy is complete. To monitor the status of your node, run any of the following commands, replacing `UUID` with the UUID from step 2. - **Git**: ```shell - $ ghe-spokes evac-status git-server-UUID + $ ghe-spokes evac-status git-server-UUID ``` - **{% data variables.product.prodname_pages %}**: ```shell - $ echo "select count(*) from pages_replicas where host = 'pages-server-UUID'" | ghe-dbconsole -y + $ echo "select count(*) from pages_replicas where host = 'pages-server-UUID'" | ghe-dbconsole -y ``` - **Storage**: ```shell - $ ghe-storage evacuation-status storage-server-UUID + $ ghe-storage evacuation-status storage-server-UUID ``` 1. After the copy is complete, you can evacuate the node by running any of the following commands, replacing `UUID` with the UUID from step 2. - **Git**: ```shell - $ ghe-spokes server evacuate git-server-UUID \'REASON FOR EVACUATION\' + $ ghe-spokes server evacuate git-server-UUID \'REASON FOR EVACUATION\' ``` - **{% data variables.product.prodname_pages %}**: ```shell - $ ghe-dpages evacuate pages-server-UUID + $ ghe-dpages evacuate pages-server-UUID ``` - For **storage**, first take the node offline by running the following command. ```shell - $ ghe-storage offline storage-server-UUID + $ ghe-storage offline storage-server-UUID ``` After the storage node is offline, you can evacuate the node by running the following command. ```shell - $ ghe-storage evacuate storage-server-UUID + $ ghe-storage evacuate storage-server-UUID ``` diff --git a/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md b/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md index db08c5ea1911..15dc0e2fa234 100644 --- a/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md +++ b/content/admin/enterprise-management/configuring-clustering/monitoring-cluster-nodes.md @@ -21,7 +21,7 @@ topics: {% data variables.product.prodname_ghe_server %} has a built-in command line utility for monitoring the health of the cluster. From the administrative shell, running the `ghe-cluster-status` command executes a series of health checks on each node including verification of connectivity and service status. The output shows all test results including the text `ok` or `error`. For example, to only display failing tests, run: ```shell -admin@ghe-data-node-0:~$ ghe-cluster-status | grep error +admin@ghe-data-node-0:~$ ghe-cluster-status | grep error > mysql-replication ghe-data-node-0: error Stopped > mysql cluster: error ``` @@ -42,11 +42,11 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables ### Configuring the Nagios host 1. Generate an SSH key with a blank passphrase. Nagios uses this to authenticate to the {% data variables.product.prodname_ghe_server %} cluster. ```shell - nagiosuser@nagios:~$ ssh-keygen -t ed25519 + nagiosuser@nagios:~$ ssh-keygen -t ed25519 > Generating public/private ed25519 key pair. > Enter file in which to save the key (/home/nagiosuser/.ssh/id_ed25519): - > Enter passphrase (empty for no passphrase): leave blank by pressing enter - > Enter same passphrase again: press enter again + > Enter passphrase (empty for no passphrase): LEAVE BLANK BY PRESSING ENTER + > Enter same passphrase again: PRESS ENTER AGAIN > Your identification has been saved in /home/nagiosuser/.ssh/id_ed25519. > Your public key has been saved in /home/nagiosuser/.ssh/id_ed25519.pub. ``` @@ -65,8 +65,8 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables {% endnote %} 2. Copy the private key (`id_ed25519`) to the `nagios` home folder and set the appropriate ownership. ```shell - nagiosuser@nagios:~$ sudo cp .ssh/id_ed25519 /var/lib/nagios/.ssh/ - nagiosuser@nagios:~$ sudo chown nagios:nagios /var/lib/nagios/.ssh/id_ed25519 + nagiosuser@nagios:~$ sudo cp .ssh/id_ed25519 /var/lib/nagios/.ssh/ + nagiosuser@nagios:~$ sudo chown nagios:nagios /var/lib/nagios/.ssh/id_ed25519 ``` 3. To authorize the public key to run *only* the `ghe-cluster-status -n` command, use a `command=` prefix in the `/data/user/common/authorized_keys` file. From the administrative shell on any node, modify this file to add the public key generated in step 1. For example: `command="/usr/local/bin/ghe-cluster-status -n" ssh-ed25519 AAAA....` @@ -74,7 +74,7 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables 4. Validate and copy the configuration to each node in the cluster by running `ghe-cluster-config-apply` on the node where you modified the `/data/user/common/authorized_keys` file. ```shell - admin@ghe-data-node-0:~$ ghe-cluster-config-apply + admin@ghe-data-node-0:~$ ghe-cluster-config-apply > Validating configuration > ... > Finished cluster configuration @@ -82,7 +82,7 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables 5. To test that the Nagios plugin can successfully execute the command, run it interactively from Nagios host. ```shell - nagiosuser@nagios:~$ /usr/lib/nagios/plugins/check_by_ssh -l admin -p 122 -H hostname -C "ghe-cluster-status -n" -t 30 + nagiosuser@nagios:~$ /usr/lib/nagios/plugins/check_by_ssh -l admin -p 122 -H HOSTNAME -C "ghe-cluster-status -n" -t 30 > OK - No errors detected ``` diff --git a/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md b/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md index 2bb8daaeba69..557aa8988d77 100644 --- a/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md @@ -19,7 +19,7 @@ topics: 1. Back up your data with [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). 2. From the administrative shell of any node, use the `ghe-cluster-hotpatch` command to install the latest hotpatch. You can provide a URL for a hotpatch, or manually download the hotpatch and specify a local filename. ```shell - $ ghe-cluster-hotpatch https://HOTPATCH-URL/FILENAME.hpkg + $ ghe-cluster-hotpatch https://HOTPATCH-URL/FILENAME.hpkg ``` ## Upgrading with an upgrade package @@ -33,7 +33,7 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve 4. On the [{% data variables.product.prodname_ghe_server %} Download Page](https://enterprise.github.com/download), copy the URL for the upgrade *.pkg* file to the clipboard. 5. From the administrative shell of any node, use the `ghe-cluster-each` command combined with `curl` to download the release package to each node in a single step. Use the URL you copied in the previous step as an argument. ```shell - $ ghe-cluster-each -- "cd /home/admin && curl -L -O https://PACKAGE-URL.pkg" + $ ghe-cluster-each -- "cd /home/admin && curl -L -O https://PACKAGE-URL.pkg" > ghe-app-node-1: % Total % Received % Xferd Average Speed Time Time Time Current > ghe-app-node-1: Dload Upload Total Spent Left Speed > 100 496M 100 496M 0 0 24.2M 0 0:00:20 0:00:20 --:--:-- 27.4M @@ -58,7 +58,7 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve 2. **With the exception of the primary MySQL node**, connect to the administrative shell of each of the {% data variables.product.prodname_ghe_server %} nodes. Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade): ```shell - $ ghe-upgrade PACKAGE-FILENAME.pkg + $ ghe-upgrade PACKAGE-FILENAME.pkg > *** verifying upgrade package signature... > 497MB 0:00:04 [ 117MB/s] [==========================================>] 100% > gpg: Signature made Fri 19 Feb 2016 02:33:50 PM UTC using RSA key ID 0D65D57A @@ -70,7 +70,7 @@ Run the `ghe-upgrade` command, providing the package file name you downloaded in 3. The upgrade process will reboot the node once it completes. Verify that you can `ping` each node after it reboots. 4. Connect to the administrative shell of the primary MySQL node. Run the `ghe-upgrade` command, providing the package file name you downloaded in Step 4 of [Preparing to upgrade](#preparing-to-upgrade): ```shell - $ ghe-upgrade PACKAGE-FILENAME.pkg + $ ghe-upgrade PACKAGE-FILENAME.pkg > *** verifying upgrade package signature... > 497MB 0:00:04 [ 117MB/s] [==========================================>] 100% > gpg: Signature made Fri 19 Feb 2016 02:33:50 PM UTC using RSA key ID 0D65D57A diff --git a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md index c210522595de..0f2952586c43 100644 --- a/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md +++ b/content/admin/enterprise-management/configuring-high-availability/creating-a-high-availability-replica.md @@ -24,13 +24,13 @@ shortTitle: Create HA replica {% data reusables.enterprise_installation.replica-steps %} 1. Connect to the replica appliance's IP address using SSH. ```shell - $ ssh -p 122 admin@REPLICA IP + $ ssh -p 122 admin@REPLICA_IP ``` {% data reusables.enterprise_installation.generate-replication-key-pair %} {% data reusables.enterprise_installation.add-ssh-key-to-primary %} 1. To verify the connection to the primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell - $ ghe-repl-setup PRIMARY IP + $ ghe-repl-setup PRIMARY_IP ``` {% data reusables.enterprise_installation.replication-command %} {% data reusables.enterprise_installation.verify-replication-channel %} @@ -41,27 +41,27 @@ This example configuration uses a primary and two replicas, which are located in 1. Create the first replica the same way you would for a standard two node configuration by running `ghe-repl-setup` on the first replica. ```shell - (replica1)$ ghe-repl-setup PRIMARY IP + (replica1)$ ghe-repl-setup PRIMARY_IP (replica1)$ ghe-repl-start ``` 2. Create a second replica and use the `ghe-repl-setup --add` command. The `--add` flag prevents it from overwriting the existing replication configuration and adds the new replica to the configuration. ```shell - (replica2)$ ghe-repl-setup --add PRIMARY IP + (replica2)$ ghe-repl-setup --add PRIMARY_IP (replica2)$ ghe-repl-start ``` 3. By default, replicas are configured to the same datacenter, and will now attempt to seed from an existing node in the same datacenter. Configure the replicas for different datacenters by setting a different value for the datacenter option. The specific values can be anything you would like as long as they are different from each other. Run the `ghe-repl-node` command on each node and specify the datacenter. On the primary: ```shell - (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME] + (primary)$ ghe-repl-node --datacenter [PRIMARY DC NAME] ``` On the first replica: ```shell - (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME] + (replica1)$ ghe-repl-node --datacenter [FIRST REPLICA DC NAME] ``` On the second replica: ```shell - (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME] + (replica2)$ ghe-repl-node --datacenter [SECOND REPLICA DC NAME] ``` {% tip %} @@ -90,9 +90,9 @@ Configure Geo DNS using the IP addresses of the primary and replica nodes. You c For testing, you can add entries to the local workstation's `hosts` file (for example, `/etc/hosts`). These example entries will resolve requests for `HOSTNAME` to `replica2`. You can target specific hosts by commenting out different lines. ``` -# HOSTNAME -# HOSTNAME - HOSTNAME +# HOSTNAME +# HOSTNAME + HOSTNAME ``` ## Further reading diff --git a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md index f96aca87a588..9fd842961599 100644 --- a/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md +++ b/content/admin/enterprise-management/configuring-high-availability/initiating-a-failover-to-your-replica-appliance.md @@ -57,7 +57,7 @@ The time required to failover depends on how long it takes to manually promote t ``` - On the new primary, remove the UUIDs using `ghe-repl-teardown`. Please replace *`UUID`* with a UUID you retrieved in the previous step. ```shell - $ ghe-repl-teardown -u UUID + $ ghe-repl-teardown -u UUID ``` ## Further reading diff --git a/content/admin/enterprise-management/configuring-high-availability/recovering-a-high-availability-configuration.md b/content/admin/enterprise-management/configuring-high-availability/recovering-a-high-availability-configuration.md index a9c5eb633b56..8b3d31a44a50 100644 --- a/content/admin/enterprise-management/configuring-high-availability/recovering-a-high-availability-configuration.md +++ b/content/admin/enterprise-management/configuring-high-availability/recovering-a-high-availability-configuration.md @@ -29,16 +29,16 @@ You can use the former primary appliance as the new replica appliance if the fai 1. Connect to the former primary appliance's IP address using SSH. ```shell - $ ssh -p 122 admin@FORMER PRIMARY IP + $ ssh -p 122 admin@ FORMER_PRIMARY_IP ``` 1. Enable maintenance mode on the former primary appliance. For more information, see "[Enabling and scheduling maintenance mode](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." 1. On the former primary appliance, run `ghe-repl-setup` with the IP address of the former replica. ```shell - $ ghe-repl-setup FORMER REPLICA IP + $ ghe-repl-setup FORMER_REPLICA_IP ``` {% data reusables.enterprise_installation.add-ssh-key-to-primary %} 1. To verify the connection to the new primary and enable replica mode for the new replica, run `ghe-repl-setup` again. ```shell - $ ghe-repl-setup FORMER REPLICA IP + $ ghe-repl-setup FORMER_REPLICA_IP ``` {% data reusables.enterprise_installation.replication-command %} diff --git a/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md b/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md index a4a2896b608b..6d1ee8d6f67b 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md +++ b/content/admin/enterprise-management/monitoring-your-appliance/monitoring-using-snmp.md @@ -32,7 +32,7 @@ SNMP is a common standard for monitoring devices over a network. We strongly rec ```shell # community-string is your community string # hostname is the IP or domain of your Enterprise instance - $ snmpget -v 2c -c community-string -O e hostname hrSystemDate.0 + $ snmpget -v 2c -c COMMUNITY-STRING -O e HOSTNAME hrSystemDate.0 ``` This should return the system time on {% data variables.product.product_location %} host. @@ -79,7 +79,7 @@ With SNMP v2c, only hardware-level information about your appliance is available ```shell # community-string is your community string # hostname is the IP or domain of your Enterprise instance -$ snmpwalk -v 2c -c community-string -O e hostname +$ snmpwalk -v 2c -c COMMUNITY-STRING -O e HOSTNAME ``` Of the available MIBs for SNMP, the most useful is `HOST-RESOURCES-MIB` (1.3.6.1.2.1.25). See the table below for some important objects in this MIB: @@ -99,17 +99,17 @@ For example, to query for `hrMemorySize` with SNMP v3, run the following command # auth password is the authentication password # privacy password is the privacy password # hostname is the IP or domain of your Enterprise instance -$ snmpget -v 3 -u username -l authPriv \ - -A "auth password" -a SHA \ - -X "privacy password" -x AES \ - -O e hostname HOST-RESOURCES-MIB::hrMemorySize.0 +$ snmpget -v 3 -u USERNAME -l authPriv \ + -A "AUTH PASSWORD" -a SHA \ + -X "PRIVACY PASSWORD" -x AES \ + -O e HOSTNAME HOST-RESOURCES-MIB::hrMemorySize.0 ``` With SNMP v2c, to query for `hrMemorySize`, run the following command on a separate workstation with SNMP support in your network: ```shell # community-string is your community string # hostname is the IP or domain of your Enterprise instance -snmpget -v 2c -c community-string hostname HOST-RESOURCES-MIB::hrMemorySize.0 +snmpget -v 2c -c COMMUNITY-STRING HOSTNAME HOST-RESOURCES-MIB::hrMemorySize.0 ``` {% tip %} diff --git a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 2fabe7244ad5..590bf709b2c3 100644 --- a/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -118,7 +118,7 @@ If the upgrade target you're presented with is a feature release instead of a pa {% data reusables.enterprise_installation.download-package %} 4. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg *** verifying upgrade package signature... ``` 5. If a reboot is required for updates for kernel, MySQL, Elasticsearch or other programs, the hotpatch upgrade script notifies you. @@ -170,14 +170,14 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea 5. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg *** verifying upgrade package signature... ``` 6. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode: ```shell *** applying update... - This package will upgrade your installation to version version-number - Current root partition: /dev/xvda1 [version-number] + This package will upgrade your installation to version VERSION-NUMBER + Current root partition: /dev/xvda1 [VERSION-NUMBER] Target root partition: /dev/xvda2 Proceed with installation? [y/N] ``` diff --git a/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md b/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md index 673c08e87f00..80e128920e44 100644 --- a/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md +++ b/content/admin/github-actions/advanced-configuration-and-troubleshooting/using-a-staging-environment.md @@ -48,5 +48,5 @@ To more accurately mirror your production environment, you can optionally copy f * For Amazon S3 buckets, you can use [`aws s3 sync`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/s3/sync.html). For example: ```shell - aws s3 sync s3://SOURCE-BUCKET s3://DESTINATION-BUCKET + aws s3 sync s3://SOURCE-BUCKET s3://DESTINATION-BUCKET ``` diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md index 3f5f8729685c..ef7ce0c911c5 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/manually-syncing-actions-from-githubcom.md @@ -56,7 +56,7 @@ The `actions-sync` tool can only download actions from {% data variables.product Site administrators can use the `ghe-org-admin-promote` command in the administrative shell to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." ```shell - ghe-org-admin-promote -u USERNAME -o actions + ghe-org-admin-promote -u USERNAME -o actions ```{% endif %} ## Example: Using the `actions-sync` tool diff --git a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md index 53e9571e6307..c1547181f86e 100644 --- a/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md +++ b/content/admin/identity-and-access-management/using-saml-for-enterprise-iam/troubleshooting-saml-authentication.md @@ -56,7 +56,7 @@ You can configure {% data variables.product.product_name %} to write verbose deb Some output in _auth.log_ may be Base64-encoded. You can access the administrative shell and use the `base64` utility on {% data variables.product.product_location %} to decode these responses. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/configuring-your-enterprise/accessing-the-administrative-shell-ssh)." ```shell -$ base64 --decode ENCODED OUTPUT +$ base64 --decode ENCODED_OUTPUT ``` ## Error: "Another user already owns the account" diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md index c680e16f4ef1..b241ff8178f3 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-aws.md @@ -70,7 +70,7 @@ AMIs for {% data variables.product.prodname_ghe_server %} are available in the A 1. Using the AWS CLI, get a list of {% data variables.product.prodname_ghe_server %} images published by {% data variables.product.prodname_dotcom %}'s AWS owner IDs (`025577942450` for GovCloud, and `895557238572` for other regions). For more information, see "[describe-images](http://docs.aws.amazon.com/cli/latest/reference/ec2/describe-images.html)" in the AWS documentation. ```shell aws ec2 describe-images \ - --owners OWNER ID \ + --owners OWNER_ID \ --query 'sort_by(Images,&Name)[*].{Name:Name,ImageID:ImageId}' \ --output=text ``` @@ -82,14 +82,14 @@ If you're setting up your AMI for the first time, you will need to create a secu 1. Using the AWS CLI, create a new security group. For more information, see "[create-security-group](http://docs.aws.amazon.com/cli/latest/reference/ec2/create-security-group.html)" in the AWS documentation. ```shell - $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" + $ aws ec2 create-security-group --group-name SECURITY_GROUP_NAME --description "SECURITY GROUP DESCRIPTION" ``` 2. Take note of the security group ID (`sg-xxxxxxxx`) of your newly created security group. 3. Create a security group rule for each of the ports in the table below. For more information, see "[authorize-security-group-ingress](http://docs.aws.amazon.com/cli/latest/reference/ec2/authorize-security-group-ingress.html)" in the AWS documentation. ```shell - $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE + $ aws ec2 authorize-security-group-ingress --group-id SECURITY_GROUP_ID --protocol PROTOCOL --port PORT_NUMBER --cidr SOURCE IP RANGE ``` This table identifies what each port is used for. @@ -118,11 +118,11 @@ In the AWS CLI, launch an EC2 instance using your AMI and the security group you ```shell aws ec2 run-instances \ - --security-group-ids SECURITY_GROUP_ID \ - --instance-type INSTANCE_TYPE \ - --image-id AMI_ID \ - --block-device-mappings '[{"DeviceName":"/dev/xvdf","Ebs":{"VolumeSize":SIZE,"VolumeType":"TYPE"}}]' \ - --region REGION \ + --security-group-ids SECURITY_GROUP_ID \ + --instance-type INSTANCE_TYPE \ + --image-id AMI_ID \ + --block-device-mappings '[{"DeviceName":"/dev/xvdf","Ebs":{"VolumeSize":SIZE,"VolumeType":"TYPE"}}]' \ + --region REGION \ --ebs-optimized ``` diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md index 44c202dd021c..d852202880e8 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-azure.md @@ -50,13 +50,13 @@ Before launching {% data variables.product.product_location %} on Azure, you'll Pass in options for the name of your VM, the resource group, the size of your VM, the name of your preferred Azure region, the name of the appliance image VM you listed in the previous step, and the storage SKU for premium storage. For more information about resource groups, see "[Resource groups](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-overview#resource-groups)" in the Microsoft documentation. ```shell - $ az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS + $ az vm create -n VM_NAME -g RESOURCE_GROUP --size VM_SIZE -l REGION --image APPLIANCE_IMAGE_NAME --storage-sku Premium_LRS ``` 3. Configure the security settings on your VM to open up required ports. For more information, see "[`az vm open-port`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_open_port)" in the Microsoft documentation. See the table below for a description of each port to determine what ports you need to open. ```shell - $ az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER + $ az vm open-port -n VM_NAME -g RESOURCE_GROUP --port PORT_NUMBER ``` This table identifies what each port is used for. @@ -68,7 +68,7 @@ Before launching {% data variables.product.product_location %} on Azure, you'll Pass in options for the name of your VM (for example, `ghe-acme-corp`), the resource group, the premium storage SKU, the size of the disk (for example, `100`), and a name for the resulting VHD. ```shell - $ az vm disk attach --vm-name VM_NAME -g RESOURCE_GROUP --sku Premium_LRS --new -z SIZE_IN_GB --name ghe-data.vhd --caching ReadWrite + $ az vm disk attach --vm-name VM_NAME -g RESOURCE_GROUP --sku Premium_LRS --new -z SIZE_IN_GB --name ghe-data.vhd --caching ReadWrite ``` {% note %} @@ -81,7 +81,7 @@ Before launching {% data variables.product.product_location %} on Azure, you'll 1. Before configuring the VM, you must wait for it to enter ReadyRole status. Check the status of the VM with the `vm list` command. For more information, see "[`az vm list`](https://docs.microsoft.com/cli/azure/vm?view=azure-cli-latest#az_vm_list)" in the Microsoft documentation. ```shell - $ az vm list -d -g RESOURCE_GROUP -o table + $ az vm list -d -g RESOURCE_GROUP -o table > Name ResourceGroup PowerState PublicIps Fqdns Location Zones > ------ --------------- ------------ ------------ ------- ---------- ------- > VM_NAME RESOURCE_GROUP VM running 40.76.79.202 eastus diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md index e8d6a0059eb0..421d13199ab6 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-google-cloud-platform.md @@ -48,12 +48,12 @@ GCE virtual machines are created as a member of a network, which has a firewall. 1. Using the gcloud compute command-line tool, create the network. For more information, see "[gcloud compute networks create](https://cloud.google.com/sdk/gcloud/reference/compute/networks/create)" in the Google documentation. ```shell - $ gcloud compute networks create NETWORK-NAME --subnet-mode auto + $ gcloud compute networks create NETWORK-NAME --subnet-mode auto ``` 2. Create a firewall rule for each of the ports in the table below. For more information, see "[gcloud compute firewall-rules](https://cloud.google.com/sdk/gcloud/reference/compute/firewall-rules/)" in the Google documentation. ```shell - $ gcloud compute firewall-rules create RULE-NAME \ - --network NETWORK-NAME \ + $ gcloud compute firewall-rules create RULE-NAME \ + --network NETWORK-NAME \ --allow tcp:22,tcp:25,tcp:80,tcp:122,udp:161,tcp:443,udp:1194,tcp:8080,tcp:8443,tcp:9418,icmp ``` This table identifies the required ports and what each port is used for. @@ -72,18 +72,18 @@ To create the {% data variables.product.prodname_ghe_server %} instance, you'll 1. Using the gcloud compute command-line tool, create a data disk to use as an attached storage volume for your instance data, and configure the size based on your user license count. For more information, see "[gcloud compute disks create](https://cloud.google.com/sdk/gcloud/reference/compute/disks/create)" in the Google documentation. ```shell - $ gcloud compute disks create DATA-DISK-NAME --size DATA-DISK-SIZE --type DATA-DISK-TYPE --zone ZONE + $ gcloud compute disks create DATA-DISK-NAME --size DATA-DISK-SIZE --type DATA-DISK-TYPE --zone ZONE ``` 2. Then create an instance using the name of the {% data variables.product.prodname_ghe_server %} image you selected, and attach the data disk. For more information, see "[gcloud compute instances create](https://cloud.google.com/sdk/gcloud/reference/compute/instances/create)" in the Google documentation. ```shell - $ gcloud compute instances create INSTANCE-NAME \ + $ gcloud compute instances create INSTANCE-NAME \ --machine-type n1-standard-8 \ - --image GITHUB-ENTERPRISE-IMAGE-NAME \ - --disk name=DATA-DISK-NAME \ + --image GITHUB-ENTERPRISE-IMAGE-NAME \ + --disk name=DATA-DISK-NAME \ --metadata serial-port-enable=1 \ - --zone ZONE \ - --network NETWORK-NAME \ + --zone ZONE \ + --network NETWORK-NAME \ --image-project github-enterprise-public ``` diff --git a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md index 50f177838c9c..d1e063c828df 100644 --- a/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md +++ b/content/admin/installation/setting-up-a-github-enterprise-server-instance/installing-github-enterprise-server-on-hyper-v.md @@ -38,23 +38,23 @@ shortTitle: Install on Hyper-V 1. In PowerShell, create a new Generation 1 virtual machine, configure the size based on your user license count, and attach the {% data variables.product.prodname_ghe_server %} image you downloaded. For more information, see "[New-VM](https://docs.microsoft.com/powershell/module/hyper-v/new-vm?view=win10-ps)" in the Microsoft documentation. ```shell - PS C:\> New-VM -Generation 1 -Name VM_NAME -MemoryStartupBytes MEMORY_SIZE -BootDevice VHD -VHDPath PATH_TO_VHD + PS C:\> New-VM -Generation 1 -Name VM_NAME -MemoryStartupBytes MEMORY_SIZE -BootDevice VHD -VHDPath PATH_TO_VHD ``` {% data reusables.enterprise_installation.create-attached-storage-volume %} Replace `PATH_TO_DATA_DISK` with the path to the location where you create the disk. For more information, see "[New-VHD](https://docs.microsoft.com/powershell/module/hyper-v/new-vhd?view=win10-ps)" in the Microsoft documentation. ```shell - PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE + PS C:\> New-VHD -Path PATH_TO_DATA_DISK -SizeBytes DISK_SIZE ``` 3. Attach the data disk to your instance. For more information, see "[Add-VMHardDiskDrive](https://docs.microsoft.com/powershell/module/hyper-v/add-vmharddiskdrive?view=win10-ps)" in the Microsoft documentation. ```shell - PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK + PS C:\> Add-VMHardDiskDrive -VMName VM_NAME -Path PATH_TO_DATA_DISK ``` 4. Start the VM. For more information, see "[Start-VM](https://docs.microsoft.com/powershell/module/hyper-v/start-vm?view=win10-ps)" in the Microsoft documentation. ```shell - PS C:\> Start-VM -Name VM_NAME + PS C:\> Start-VM -Name VM_NAME ``` 5. Get the IP address of your VM. For more information, see "[Get-VMNetworkAdapter](https://docs.microsoft.com/powershell/module/hyper-v/get-vmnetworkadapter?view=win10-ps)" in the Microsoft documentation. ```shell - PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses + PS C:\> (Get-VMNetworkAdapter -VMName VM_NAME).IpAddresses ``` 6. Copy the VM's IP address and paste it into a web browser. diff --git a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md index b8301bed386c..f59cbd659dcc 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md +++ b/content/admin/monitoring-activity-in-your-enterprise/exploring-user-activity/viewing-push-logs.md @@ -43,6 +43,6 @@ Push log entries show: {% data reusables.enterprise_installation.ssh-into-instance %} 1. In the appropriate Git repository, open the audit log file: ```shell - ghe-repo owner/repository -c "cat audit_log" + ghe-repo OWNER/REPOSITORY -c "cat audit_log" ``` {% endif %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index fe9cb82ebb5a..eb7ca4cae4cb 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md index a08d317d7555..562a02d1596d 100644 --- a/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md +++ b/content/admin/packages/quickstart-for-configuring-your-minio-storage-bucket-for-github-packages.md @@ -121,7 +121,7 @@ Other modes of MinIO remain available with standard support. ```shell $ export MC_HOST_minio="http://${MINIO_ACCESS_KEY}:${MINIO_SECRET_KEY} @localhost:9000" - $ docker run minio/mc BUCKET-NAME + $ docker run minio/mc BUCKET-NAME ``` This example can be used for MinIO standalone or MinIO as a NAS gateway. diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md index 07184c429967..ff1340ce664e 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script.md @@ -69,7 +69,7 @@ The following variables are always available in the pre-receive hook environment | :- | :- | :- | | 
$GIT_DIR
| Path to the remote repository on the instance | /data/user/repositories/a/ab/
a1/b2/34/100001234/1234.git | | 
$GIT_PUSH_OPTION_COUNT
| The number of push options that were sent by the client with `--push-option`. For more information, see "[git-push](https://git-scm.com/docs/git-push#Documentation/git-push.txt---push-optionltoptiongt)" in the Git documentation. | 1 | -| 
$GIT\_PUSH\_OPTION\_N
| Where _N_ is an integer starting at 0, this variable contains the push option string that was sent by the client. The first option that was sent is stored in `GIT_PUSH_OPTION_0`, the second option that was sent is stored in `GIT_PUSH_OPTION_1`, and so on. For more information about push options, see "[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)" in the Git documentation. | abcd |{% ifversion ghes %} +| 
$GIT\_PUSH\_OPTION\_N
| Where _N_ is an integer starting at 0, this variable contains the push option string that was sent by the client. The first option that was sent is stored in `GIT_PUSH_OPTION_0`, the second option that was sent is stored in `GIT_PUSH_OPTION_1`, and so on. For more information about push options, see "[git-push](https://git-scm.com/docs/git-push#git-push---push-optionltoptiongt)" in the Git documentation. | abcd |{% ifversion ghes %} | 
$GIT_USER_AGENT
| User-agent string sent by the Git client that pushed the changes | git/2.0.0{% endif %} | 
$GITHUB_REPO_NAME
| Name of the repository being updated in _NAME_/_OWNER_ format | octo-org/hello-enterprise | | 
$GITHUB_REPO_PUBLIC
| Boolean representing whether the repository being updated is public |
  • true: Repository's visibility is public
  • false: Repository's visibility is private or internal
@@ -102,7 +102,7 @@ The `$GITHUB_VIA` variable is available in the pre-receive hook environment when | 
releases delete button
| Deletion of a release | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#deleting-a-release)" | | 
stafftools branch restore
| Restoration of a branch from the site admin dashboard | "[Site admin dashboard](/admin/configuration/site-admin-dashboard#repositories)" | | 
tag create api
| Creation of a tag via the API | "[Git database](/rest/reference/git#create-a-tag-object)" in the REST API documentation | -| 
slumlord (#SHA)
| Commit via Subversion | "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | +| 
slumlord (#SHA)
| Commit via Subversion | "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients#making-commits-to-subversion)" | | 
web branch create
| Creation of a branch via the web interface | "[Creating and deleting branches within your repository](/github/collaborating-with-issues-and-pull-requests/creating-and-deleting-branches-within-your-repository#creating-a-branch)" | #### Available for pull request merges @@ -130,18 +130,18 @@ We recommend consolidating hooks to a single repository. If the consolidated hoo 1. For Mac users, ensure the scripts have execute permissions: ```shell - $ sudo chmod +x SCRIPT_FILE.sh + $ sudo chmod +x SCRIPT_FILE.sh ``` For Windows users, ensure the scripts have execute permissions: ```shell - git update-index --chmod=+x SCRIPT_FILE.sh + git update-index --chmod=+x SCRIPT_FILE.sh ``` 2. Commit and push to the designated repository for pre-receive hooks on {% data variables.product.product_location %}. ```shell - $ git commit -m "YOUR COMMIT MESSAGE" + $ git commit -m "YOUR COMMIT MESSAGE" $ git push ``` diff --git a/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md b/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md index 96c09af59419..8bb124b1e64a 100644 --- a/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md +++ b/content/admin/user-management/managing-repositories-in-your-enterprise/configuring-git-large-file-storage-for-your-enterprise.md @@ -82,20 +82,20 @@ For more information, see "[About {% data variables.large_files.product_name_lon > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) > git version 2.7.4 (Apple Git-66)   - > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic) + > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic)   # Create .lfsconfig that points to third party server. - $ git config -f .lfsconfig remote.origin.lfsurl https://THIRD-PARTY-LFS-SERVER/path/to/repo + $ git config -f .lfsconfig remote.origin.lfsurl https://THIRD-PARTY-LFS-SERVER/path/to/repo $ git lfs env > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) > git version 2.7.4 (Apple Git-66)   - > Endpoint=https://THIRD-PARTY-LFS-SERVER/path/to/repo/info/lfs (auth=none) + > Endpoint=https://THIRD-PARTY-LFS-SERVER/path/to/repo/info/lfs (auth=none)   # Show the contents of .lfsconfig $ cat .lfsconfig [remote "origin"] - lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo + lfsurl = https://THIRD-PARTY-LFS-SERVER/path/to/repo ``` 3. To keep the same {% data variables.large_files.product_name_short %} configuration for each user, commit a custom `.lfsconfig` file to the repository. @@ -111,14 +111,14 @@ Before migrating to a different {% data variables.large_files.product_name_long 1. Configure the repository with a second remote. ```shell - $ git remote add NEW-REMOTE https://NEW-REMOTE-HOSTNAME/path/to/repo + $ git remote add NEW-REMOTE https://NEW-REMOTE-HOSTNAME/path/to/repo   $ git lfs env > git-lfs/1.1.0 (GitHub; darwin amd64; go 1.5.1; git 94d356c) > git version 2.7.4 (Apple Git-66)   - > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic) - > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) + > Endpoint=https://GITHUB-ENTERPRISE-HOST/path/to/repo/info/lfs (auth=basic) + > Endpoint (NEW-REMOTE)=https://NEW-REMOTE-HOSTNAME/path/to/repo/info/lfs (auth=none) ``` 2. Fetch all objects from the old remote. @@ -132,7 +132,7 @@ Before migrating to a different {% data variables.large_files.product_name_long 3. Push all objects to the new remote. ```shell - $ git lfs push NEW-REMOTE --all + $ git lfs push NEW-REMOTE --all > Scanning for all objects ever referenced... > ✔ 16 objects found > Pushing objects... diff --git a/content/admin/user-management/managing-users-in-your-enterprise/auditing-ssh-keys.md b/content/admin/user-management/managing-users-in-your-enterprise/auditing-ssh-keys.md index a97d601b64ae..8659abaad81a 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/auditing-ssh-keys.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/auditing-ssh-keys.md @@ -34,8 +34,8 @@ After you click the "Begin audit" button, all SSH keys are invalidated and will If a user attempts to perform any git operation over SSH, it will fail and provide them with the following message: ```shell -ERROR: Hi username. We're doing an SSH key audit. -Please visit http(s)://hostname/settings/ssh/audit/2 +ERROR: Hi USERNAME. We're doing an SSH key audit. +Please visit http(s)://HOSTNAME/settings/ssh/audit/2 to approve this key so we know it's safe. Fingerprint: ed:21:60:64:c0:dc:2b:16:0f:54:5f:2b:35:2a:94:91 fatal: The remote end hung up unexpectedly diff --git a/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md b/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md index 2ca2fcfec525..2d9780c082db 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/promoting-or-demoting-a-site-administrator.md @@ -50,7 +50,7 @@ For information about promoting a user to an organization owner, see the `ghe-or 1. [SSH](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. 2. Run [ghe-user-promote](/enterprise/admin/guides/installation/command-line-utilities#ghe-user-promote) with the username to promote. ```shell - $ ghe-user-promote username + $ ghe-user-promote USERNAME ``` ## Demoting a site administrator from the command line @@ -58,5 +58,5 @@ For information about promoting a user to an organization owner, see the `ghe-or 1. [SSH](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/) into your appliance. 2. Run [ghe-user-demote](/enterprise/admin/guides/installation/command-line-utilities#ghe-user-demote) with the username to demote. ```shell - $ ghe-user-demote username + $ ghe-user-demote USERNAME ``` diff --git a/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md b/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md index eee374e9ef34..d40afec9e0e2 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/suspending-and-unsuspending-users.md @@ -71,7 +71,7 @@ As when suspending a user, unsuspending a user takes effect immediately. The use {% data reusables.enterprise_installation.ssh-into-instance %} 2. Run [ghe-user-suspend](/enterprise/admin/guides/installation/command-line-utilities#ghe-user-suspend) with the username to suspend. ```shell - $ ghe-user-suspend username + $ ghe-user-suspend USERNAME ``` ## Creating a custom message for suspended users @@ -96,7 +96,7 @@ You can create a custom message that suspended users will see when attempting to {% data reusables.enterprise_installation.ssh-into-instance %} 2. Run [ghe-user-unsuspend](/enterprise/admin/guides/installation/command-line-utilities#ghe-user-unsuspend) with the username to unsuspend. ```shell - $ ghe-user-unsuspend username + $ ghe-user-unsuspend USERNAME ``` ## Further reading diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md index d3757186dbe4..26fcb214f2bf 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-githubcom.md @@ -44,11 +44,11 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * A [list of the repositories](/free-pro-team@latest/rest/repos#list-organization-repositories) you want to migrate: ```shell - curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X POST \ -H "Accept: application/vnd.github+json" \ - -d'{"lock_repositories":true,"repositories":["orgname/reponame", "orgname/reponame"]}' \ - https://api.github.com/orgs/orgname/migrations + -d'{"lock_repositories":true,"repositories":["ORG_NAME/REPO_NAME", "ORG_NAME/REPO_NAME"]}' \ + https://api.github.com/orgs/ORG_NAME/migrations ``` * If you want to lock the repositories before migrating them, make sure `lock_repositories` is set to `true`. This is highly recommended. * You can exclude file attachments by passing `exclude_attachments: true` to the endpoint. {% data reusables.enterprise_migrations.exclude-file-attachments %} The final archive size must be less than 20 GB. @@ -59,9 +59,9 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ - https://api.github.com/orgs/orgname/migrations/id + https://api.github.com/orgs/ORG_NAME/migrations/ID ``` A migration can be in one of the following states: @@ -74,19 +74,19 @@ The Migrations API is currently in a preview period, which means that the endpoi * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -H "Accept: application/vnd.github+json" \ -L -o migration_archive.tar.gz \ - https://api.github.com/orgs/orgname/migrations/id/archive + https://api.github.com/orgs/ORG_NAME/migrations/ID/archive ``` 5. The migration archive is automatically deleted after seven days. If you would prefer to delete it sooner, you can send a `DELETE` request to [the migration archive delete endpoint](/free-pro-team@latest/rest/migrations#delete-an-organization-migration-archive). You'll need: * Your access token for authentication. * The unique `id` of the migration: ```shell - curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ + curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" \ -X DELETE \ -H "Accept: application/vnd.github+json" \ - https://api.github.com/orgs/orgname/migrations/id/archive + https://api.github.com/orgs/ORG_NAME/migrations/ID/archive ``` {% data reusables.enterprise_migrations.ready-to-import-migrations %} diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md index 689660934fa0..bb0d2cde0604 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/exporting-migration-data-from-your-enterprise.md @@ -35,12 +35,12 @@ shortTitle: Export from your enterprise 2. To prepare a repository for export, use the `ghe-migrator add` command with the repository's URL: * If you're locking the repository, append the command with `--lock`. If you're performing a trial run, `--lock` is not needed. ```shell - $ ghe-migrator add https://hostname/username/reponame --lock + $ ghe-migrator add https://HOSTNAME/USERNAME/REPO-NAME --lock ``` * You can exclude file attachments by appending `--exclude_attachments` to the command. {% data reusables.enterprise_migrations.exclude-file-attachments %} * To prepare multiple repositories at once for export, create a text file listing each repository URL on a separate line, and run the `ghe-migrator add` command with the `-i` flag and the path to your text file. ```shell - $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URLS.txt + $ ghe-migrator add -i PATH/TO/YOUR/REPOSITORY_URL.txt ``` 3. When prompted, enter your {% data variables.product.prodname_ghe_server %} username: @@ -54,7 +54,7 @@ shortTitle: Export from your enterprise 5. When `ghe-migrator add` has finished it will print the unique "Migration GUID" that it generated to identify this export as well as a list of the resources that were added to the export. You will use the Migration GUID that it generated in subsequent `ghe-migrator add` and `ghe-migrator export` steps to tell `ghe-migrator` to continue operating on the same export. ```shell > 101 models added to export - > Migration GUID: example-migration-guid + > Migration GUID: EXAMPLE-MIGRATION-GUID > Number of records in this migration: > users | 5 > organizations | 1 @@ -78,17 +78,17 @@ shortTitle: Export from your enterprise 3. If you locked the source repository, you can use the `ghe-migrator target_url` command to set a custom lock message on the repository page that links to the repository's new location. Pass the source repository URL, the target repository URL, and the Migration GUID from Step 5: ```shell - $ ghe-migrator target_url https://hostname/username/reponame https://target_hostname/target_username/target_reponame -g MIGRATION_GUID + $ ghe-migrator target_url https://HOSTNAME/USERNAME/REPO-NAME https://TARGET-HOSTNAME/TARGET-USER-NAME/TARGET-REPO-NAME -g MIGRATION-GUID ``` 6. To add more repositories to the same export, use the `ghe-migrator add` command with the `-g` flag. You'll pass in the new repository URL and the Migration GUID from Step 5: ```shell - $ ghe-migrator add https://hostname/username/other_reponame -g MIGRATION_GUID --lock + $ ghe-migrator add https://HOSTNAME/USERNAME/OTHER-REPO-NAME -g MIGRATION-GUID --lock ``` 7. When you've finished adding repositories, generate the migration archive using the `ghe-migrator export` command with the `-g` flag and the Migration GUID from Step 5: ```shell - $ ghe-migrator export -g MIGRATION_GUID - > Archive saved to: /data/github/current/tmp/MIGRATION_GUID.tar.gz + $ ghe-migrator export -g MIGRATION-GUID + > Archive saved to: /data/github/current/tmp/MIGRATION-GUID.tar.gz ``` * {% data reusables.enterprise_migrations.specify-staging-path %} @@ -96,10 +96,10 @@ shortTitle: Export from your enterprise ```shell $ exit > logout - > Connection to hostname closed. + > Connection to HOSTNAME closed. ``` 9. Copy the migration archive to your computer using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command. The archive file will be named with the Migration GUID: ```shell - $ scp -P 122 admin@hostname:/data/github/current/tmp/MIGRATION_GUID.tar.gz ~/Desktop + $ scp -P 122 admin@HOSTNAME:/data/github/current/tmp/MIGRATION-GUID.tar.gz ~/Desktop ``` {% data reusables.enterprise_migrations.ready-to-import-migrations %} diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/importing-data-from-third-party-version-control-systems.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/importing-data-from-third-party-version-control-systems.md index 8dc295655566..7810210a3a3f 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/importing-data-from-third-party-version-control-systems.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/importing-data-from-third-party-version-control-systems.md @@ -18,19 +18,19 @@ shortTitle: Import from another VCS {% data reusables.enterprise_installation.ssh-into-instance %} 2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell - $ git-import-hg-raw HG-CLONE-URL /PATH/REPO-NAME.git + $ git-import-hg-raw HG-CLONE-URL/PATH/REPO-NAME.git # Creates a new repository with one or more Git refs in "refs/import/" in the specified path. ``` {% data reusables.enterprise_migrations.review-the-import-csv %} 4. Rewrite the authors and branches using the CSV file: ```shell - $ git-import-rewrite --flavor hg --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git + $ git-import-rewrite --flavor hg --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git ``` 5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/enterprise/user/articles/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} 7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell - $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE + $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE ``` ## Importing projects from Subversion @@ -38,19 +38,19 @@ shortTitle: Import from another VCS {% data reusables.enterprise_installation.ssh-into-instance %} 2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell - $ git-import-svn-raw SVN-CLONE-URL /PATH/REPO-NAME.git + $ git-import-svn-raw SVN-CLONE-URL /PATH/REPO-NAME.git # Creates a new repository with one or more Git refs in "refs/import/" in the specified path. ``` {% data reusables.enterprise_migrations.review-the-import-csv %} 4. Rewrite the authors and branches using the CSV file: ```shell - $ git-import-rewrite --flavor svn --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git + $ git-import-rewrite --flavor svn --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git ``` 5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/enterprise/user/articles/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} 7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell - $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE + $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE ``` ## Importing projects from Team Foundation Version Control @@ -58,19 +58,19 @@ shortTitle: Import from another VCS {% data reusables.enterprise_installation.ssh-into-instance %} 2. Make a raw clone of the project using the command below, specifying the URL of the source project, and a path to a temporary repository: ```shell - $ git-import-tfs-raw TEAM-FOUNDATION-CLONE-URL /PATH/REPO-NAME.git + $ git-import-tfs-raw TEAM-FOUNDATION-CLONE-URL /PATH/REPO-NAME.git # Creates a new repository with one or more Git refs in "refs/import/" in the specified path. ``` {% data reusables.enterprise_migrations.review-the-import-csv %} 4. Rewrite the authors and branches using the CSV file: ```shell - $ git-import-rewrite --flavor tfs --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO-NAME.git + $ git-import-rewrite --flavor tfs --authors /PATH/AUTHORS-MAP-FILE.csv /PATH/REPO_NAME.git ``` 5. If you haven't yet, [create a new empty repository on {% data variables.product.prodname_ghe_server %}](/enterprise/user/articles/creating-a-new-repository). {% data reusables.command_line.switching_directories_procedural %} 7. Push the imported repository to {% data variables.product.prodname_ghe_server %}: ```shell - $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE + $ git push --mirror PUSH-URL-ON-GITHUB-ENTERPRISE ``` ## Further reading diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md index c614ef94ce37..753a7fae6640 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/migrating-data-to-your-enterprise.md @@ -33,7 +33,7 @@ After you prepare the data and resolve conflicts, you can apply the imported dat * Your personal access token for authentication. The personal access token that you use is only for authentication as a site administrator, and does not require any specific scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." ```shell - $ ghe-migrator import /home/admin/MIGRATION_GUID.tar.gz -g MIGRATION_GUID -u username -p TOKEN + $ ghe-migrator import /home/admin/MIGRATION-GUID.tar.gz -g MIGRATION-GUID -u USERNAME -p TOKEN > Starting GitHub::Migrator > Import 100% complete / @@ -95,19 +95,19 @@ The record types match those found in the [migrated data](/enterprise/admin/guid With the `ghe-migrator audit` command, you can filter based on the record type using the `-m` flag. Similarly, you can filter on the import state using the `-s` flag. The command looks like this: ```shell -$ ghe-migrator audit -m RECORD_TYPE -s STATE -g MIGRATION_GUID +$ ghe-migrator audit -m RECORD_TYPE -s STATE -g MIGRATION-GUID ``` For example, to view every successfully imported organization and team, you would enter: ```shell -$ ghe-migrator audit -m organization,team -s mapped,renamed -g MIGRATION_GUID +$ ghe-migrator audit -m organization,team -s mapped,renamed -g MIGRATION-GUID > model_name,source_url,target_url,state > organization,https://gh.source/octo-org/,https://ghe.target/octo-org/,renamed ``` **We strongly recommend auditing every import that failed.** To do that, you will enter: ```shell -$ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g MIGRATION_GUID +$ ghe-migrator audit -s failed_import,failed_map,failed_rename,failed_merge -g MIGRATION-GUID > model_name,source_url,target_url,state > user,https://gh.source/octocat,https://gh.target/octocat,failed > repository,https://gh.source/octo-org/octo-project,https://ghe.target/octo-org/octo-project,failed @@ -132,18 +132,19 @@ To unlock the repositories on a {% data variables.product.prodname_dotcom_the_we * Your access token for authentication * The unique `id` of the migration * The name of the repository to unlock + ```shell -curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ -H "Accept: application/vnd.github.wyandotte-preview+json" \ - https://api.github.com/orgs/orgname/migrations/id/repos/repo_name/lock + https://api.github.com/orgs/ORG-NAME/migrations/ID/repos/REPO_NAME/lock ``` ### Deleting repositories from an organization on {% data variables.product.prodname_dotcom_the_website %} After unlocking the {% data variables.product.prodname_dotcom_the_website %} organization's repositories, you should delete every repository you previously migrated using [the repository delete endpoint](/rest/repos/#delete-a-repository). You'll need your access token for authentication: ```shell -curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ - https://api.github.com/repos/orgname/repo_name +curl -H "Authorization: Bearer GITHUB_ACCESS_TOKEN" -X DELETE \ + https://api.github.com/repos/ORG-NAME/REPO_NAME ``` ### Unlocking repositories from a {% data variables.product.prodname_ghe_server %} instance diff --git a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/preparing-to-migrate-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/preparing-to-migrate-data-to-your-enterprise.md index 177d878409a6..2e743d65b5a2 100644 --- a/content/admin/user-management/migrating-data-to-and-from-your-enterprise/preparing-to-migrate-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-and-from-your-enterprise/preparing-to-migrate-data-to-your-enterprise.md @@ -22,7 +22,7 @@ shortTitle: Prepare to migrate data 1. Using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command, copy the migration archive generated from your source instance or organization to your {% data variables.product.prodname_ghe_server %} target: ```shell - $ scp -P 122 /path/to/archive/MIGRATION_GUID.tar.gz admin@hostname:/home/admin/ + $ scp -P 122 PATH-TO-MIGRATION-GUID.tar.gz admin@HOSTNAME:/home/admin/ ``` {% data reusables.enterprise_installation.ssh-into-target-instance %} @@ -30,7 +30,7 @@ shortTitle: Prepare to migrate data 3. Use the `ghe-migrator prepare` command to prepare the archive for import on the target instance and generate a new Migration GUID for you to use in subsequent steps: ```shell - ghe-migrator prepare /home/admin/MIGRATION_GUID.tar.gz + ghe-migrator prepare /home/admin/MIGRATION-GUID.tar.gz ``` * To start a new import attempt, run `ghe-migrator prepare` again and get a new Migration GUID. @@ -40,12 +40,12 @@ shortTitle: Prepare to migrate data 1. Using the `ghe-migrator conflicts` command with the Migration GUID, generate a *conflicts.csv* file: ```shell - $ ghe-migrator conflicts -g MIGRATION_GUID > conflicts.csv + $ ghe-migrator conflicts -g MIGRATION-GUID > conflicts.csv ``` - If no conflicts are reported, you can safely import the data by following the steps in "[Migrating data to your enterprise](/enterprise/admin/guides/migrations/applying-the-imported-data-on-github-enterprise-server/)". 2. If there are conflicts, using the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command, copy *conflicts.csv* to your local computer: ```shell - $ scp -P 122 admin@hostname:conflicts.csv ~/Desktop + $ scp -P 122 admin@HOSTNAME:conflicts.csv ~/Desktop ``` 3. Continue to "[Resolving migration conflicts or setting up custom mappings](#resolving-migration-conflicts-or-setting-up-custom-mappings)". @@ -118,7 +118,7 @@ Given a list of usernames from the source and a list of usernames on the target, You can quickly generate a CSV of users being migrated in the CSV format needed to apply custom mappings by using the [`ghe-migrator audit`](/enterprise/admin/guides/migrations/reviewing-migration-data) command: ```shell -$ ghe-migrator audit -m user -g MIGRATION_GUID > users.csv +$ ghe-migrator audit -m user -g MIGRATION-GUID > users.csv ``` Now, you can edit that CSV and enter the new URL for each user you would like to map or rename, and then update the fourth column to have `map` or `rename` as appropriate. @@ -136,13 +136,13 @@ The same process can be used to create mappings for each record that supports cu 1. After making changes, use the [`scp`](https://acloudguru.com/blog/engineering/ssh-and-scp-howto-tips-tricks#scp) command to apply your modified *conflicts.csv* (or any other mapping *.csv* file in the correct format) to the target instance: ```shell - $ scp -P 122 ~/Desktop/conflicts.csv admin@hostname:/home/admin/ + $ scp -P 122 ~/Desktop/conflicts.csv admin@HOSTNAME:/home/admin/ ``` 2. Re-map the migration data using the `ghe-migrator map` command, passing in the path to your modified *.csv* file and the Migration GUID: ```shell - $ ghe-migrator map -i conflicts.csv -g MIGRATION_GUID + $ ghe-migrator map -i conflicts.csv -g MIGRATION-GUID ``` -3. If the `ghe-migrator map -i conflicts.csv -g MIGRATION_GUID` command reports that conflicts still exist, run through the migration conflict resolution process again. +3. If the `ghe-migrator map -i conflicts.csv -g MIGRATION-GUID` command reports that conflicts still exist, run through the migration conflict resolution process again. diff --git a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md index a4569d589d78..eabcedfe38d1 100644 --- a/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account.md @@ -74,13 +74,13 @@ Before you can use the {% data variables.product.prodname_cli %} to add an SSH k To add an SSH authentication key to your GitHub account, use the `ssh-key add` subcommand, specifying your public key. ```shell -gh ssh-key add key-file +gh ssh-key add KEY-FILE ``` To include a title for the new key, use the `-t` or `--title` flag. ```shell -gh ssh-key add key-file --title "personal laptop" +gh ssh-key add KEY-FILE --title "personal laptop" ``` If you generated your SSH key by following the instructions in "[Generating a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)", you can add the key to your account with this command. diff --git a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 9d0033a39f75..92fa29e8a531 100644 --- a/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -44,17 +44,19 @@ If you are a site administrator for {% data variables.product.product_location % {%- ifversion ghae %} ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + ``` {%- else %} ```shell - $ ssh-keygen -t ed25519 -C "your_email@example.com" + $ ssh-keygen -t ed25519 -C "your_email@example.com" ``` {% note %} **Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use: ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" ``` {% endnote %} @@ -62,14 +64,14 @@ If you are a site administrator for {% data variables.product.product_location % This creates a new SSH key, using the provided email as a label. ```shell - > Generating public/private algorithm key pair. + > Generating public/private ALGORITHM key pair. ``` 3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location. {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_algorithm): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_ALGORITHM: [Press enter] ``` {% endmac %} @@ -77,7 +79,7 @@ If you are a site administrator for {% data variables.product.product_location % {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_algorithm):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_ALGORITHM):[Press enter] ``` {% endwindows %} @@ -85,15 +87,15 @@ If you are a site administrator for {% data variables.product.product_location % {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/algorithm): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/ALGORITHM):[Press enter] ``` {% endlinux %} 4. At the prompt, type a secure passphrase. For more information, see ["Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` ## Adding your SSH key to the ssh-agent @@ -110,7 +112,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav ```shell $ open ~/.ssh/config - > The file /Users/you/.ssh/config does not exist. + > The file /Users/YOU/.ssh/config does not exist. ``` * If the file doesn't exist, create the file. @@ -198,7 +200,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% data reusables.command_line.open_the_multi_os_terminal %} 3. Paste the text below, substituting in the email address for your account on {% data variables.product.product_name %}. ```shell - $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "YOUR_EMAIL" ``` {%- ifversion not ghae %} @@ -217,7 +219,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] ``` {% endmac %} @@ -225,7 +227,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endwindows %} @@ -233,14 +235,14 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endlinux %} 6. When you are prompted to type a passphrase, press **Enter**. ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` 7. Add the SSH key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." diff --git a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md index 23ba5f9d057e..b5cfcc8a3f35 100644 --- a/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md +++ b/content/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection.md @@ -38,7 +38,7 @@ When you test your connection, you'll need to authenticate this action using you 3. Verify that the fingerprint in the message you see matches {% ifversion fpt or ghec %}[{% data variables.product.prodname_dotcom %}'s public key fingerprint](/github/authenticating-to-github/githubs-ssh-key-fingerprints){% else %} your enterprise's public key fingerprint{% endif %}. If it does, then type `yes`: ```shell - > Hi username! You've successfully authenticated, but GitHub does not + > Hi USERNAME! You've successfully authenticated, but GitHub does not > provide shell access. ``` diff --git a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md index 4368919675e1..516200a5b097 100644 --- a/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md +++ b/content/authentication/connecting-to-github-with-ssh/working-with-ssh-key-passphrases.md @@ -27,10 +27,10 @@ You can change the passphrase for an existing private key without regenerating t ```shell $ ssh-keygen -p -f ~/.ssh/id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %} -> Enter old passphrase: [Type old passphrase] -> Key has comment 'your_email@example.com' -> Enter new passphrase (empty for no passphrase): [Type new passphrase] -> Enter same passphrase again: [Repeat the new passphrase] +> Enter old passphrase: [Type old passphrase] +> Key has comment 'your_email@example.com' +> Enter new passphrase (empty for no passphrase): [Type new passphrase] +> Enter same passphrase again: [Repeat the new passphrase] > Your identification has been saved with the new passphrase. ``` @@ -79,9 +79,9 @@ Now, when you first run Git Bash, you are prompted for your passphrase: ```shell > Initializing new SSH agent... > succeeded -> Enter passphrase for /c/Users/you/.ssh/id_rsa: -> Identity added: /c/Users/you/.ssh/id_rsa (/c/Users/you/.ssh/id_rsa) -> Welcome to Git (version 1.6.0.2-preview20080923) +> Enter passphrase for /c/Users/YOU/.ssh/id_rsa: +> Identity added: /c/Users/YOU/.ssh/id_rsa (/c/Users/YOU/.ssh/id_rsa) +> Welcome to Git (version 1.6.0.2-preview20080923) > > Run 'git help git' to display the help index. > Run 'git help ' to display help for specific commands. diff --git a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md index fec22fcf4ac5..4fcc7c1c63c8 100644 --- a/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md +++ b/content/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository.md @@ -45,7 +45,7 @@ The [BFG Repo-Cleaner](https://rtyley.github.io/bfg-repo-cleaner/) is a tool tha For example, to remove your file with sensitive data and leave your latest commit untouched, run: ```shell -$ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA +$ bfg --delete-files YOUR-FILE-WITH-SENSITIVE-DATA ``` To replace all text listed in `passwords.txt` wherever it can be found in your repository's history, run: @@ -80,8 +80,8 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil 2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/articles/cloning-a-repository/) to your local computer. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY - > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/ + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY + > Initialized empty Git repository in /Users/YOUR-FILE-PATH/YOUR-REPOSITORY/.git/ > remote: Counting objects: 1301, done. > remote: Compressing objects: 100% (769/769), done. > remote: Total 1301 (delta 724), reused 910 (delta 522) @@ -90,7 +90,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil ``` 3. Navigate into the repository's working directory. ```shell - $ cd YOUR-REPOSITORY + $ cd YOUR-REPOSITORY ``` 4. Run the following command, replacing `PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA` with the **path to the file you want to remove, not just its filename**. These arguments will: - Force Git to process, but not check out, the entire history of every branch and tag @@ -121,10 +121,10 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil 5. Add your file with sensitive data to `.gitignore` to ensure that you don't accidentally commit it again. ```shell - $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore + $ echo "YOUR-FILE-WITH-SENSITIVE-DATA" >> .gitignore $ git add .gitignore - $ git commit -m "Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore" - > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore + $ git commit -m "Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore" + > [main 051452f] Add YOUR-FILE-WITH-SENSITIVE-DATA to .gitignore > 1 files changed, 1 insertions(+), 0 deletions(-) ``` 6. Double-check that you've removed everything you wanted to from your repository's history, and that all of your branches are checked out. @@ -136,7 +136,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > Compressing objects: 100% (677/677), done. > Writing objects: 100% (1058/1058), 148.85 KiB, done. > Total 1058 (delta 590), reused 602 (delta 378) - > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git + > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME.YOUR-REPOSITORY.git > + 48dc599...051452f main -> main (forced update) ``` 8. In order to remove the sensitive file from [your tagged releases](/articles/about-releases), you'll also need to force-push against your Git tags: @@ -147,7 +147,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil > Compressing objects: 100% (166/166), done. > Writing objects: 100% (321/321), 331.74 KiB | 0 bytes/s, done. > Total 321 (delta 124), reused 269 (delta 108) - > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git + > To https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY.git > + 48dc599...051452f main -> main (forced update) ``` diff --git a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md index 9a579574e895..52ee56a2d12b 100644 --- a/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md +++ b/content/authentication/keeping-your-account-and-data-secure/reviewing-your-ssh-keys.md @@ -38,7 +38,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an 6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` 7. The SSH keys on {% data variables.product.product_name %} *should* match the same keys on your computer. @@ -67,7 +67,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an 6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` 7. The SSH keys on {% data variables.product.product_name %} *should* match the same keys on your computer. @@ -94,7 +94,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an 6. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` 7. The SSH keys on {% data variables.product.product_name %} *should* match the same keys on your computer. diff --git a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md index 21813267dc71..b8394eca60f0 100644 --- a/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md +++ b/content/authentication/managing-commit-signature-verification/associating-an-email-with-your-gpg-key.md @@ -26,7 +26,7 @@ If you're using a GPG key that matches your committer identity and your verified {% data reusables.gpg.copy-gpg-key-id %} 4. Enter `gpg --edit-key GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: ```shell - $ gpg --edit-key 3AA5C34371567BD2 + $ gpg --edit-key 3AA5C34371567BD2 ``` 5. Enter `gpg> adduid` to add the user ID details. ```shell @@ -34,9 +34,9 @@ If you're using a GPG key that matches your committer identity and your verified ``` 6. Follow the prompts to supply your real name, email address, and any comments. You can modify your entries by choosing `N`, `C`, or `E`. {% data reusables.gpg.private-email %} {% ifversion fpt or ghec %} For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)."{% endif %} ```shell - Real Name: Octocat - Email address: octocat@github.com - Comment: GitHub key + Real Name: OCTOCAT + Email address: "octocat@github.com" + Comment: GITHUB-KEY Change (N)ame, (C)omment, (E)mail or (O)kay/(Q)uit? ``` 7. Enter `O` to confirm your selections. @@ -47,7 +47,7 @@ If you're using a GPG key that matches your committer identity and your verified ``` 10. Enter `gpg --armor --export GPG key ID`, substituting in the GPG key ID you'd like to use. In the following example, the GPG key ID is `3AA5C34371567BD2`: ```shell - $ gpg --armor --export 3AA5C34371567BD2 + $ gpg --armor --export 3AA5C34371567BD2 # Prints the GPG key, in ASCII armor format ``` 11. Upload the GPG key by [adding it to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md index 6b2b46697999..ff7662595cfc 100644 --- a/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md +++ b/content/authentication/managing-commit-signature-verification/checking-for-existing-gpg-keys.md @@ -29,7 +29,7 @@ shortTitle: Existing GPG keys * If there are no GPG key pairs or you don't want to use any that are available for signing commits and tags, then [generate a new GPG key](/articles/generating-a-new-gpg-key). * If there's an existing GPG key pair and you want to use it to sign commits and tags, you can display the public key using the following command, substituting in the GPG key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: ```shell - $ gpg --armor --export 3AA5C34371567BD2 + $ gpg --armor --export 3AA5C34371567BD2 # Prints the GPG key ID, in ASCII armor format ``` You can then [add your GPG key to your GitHub account](/articles/adding-a-gpg-key-to-your-github-account). diff --git a/content/authentication/managing-commit-signature-verification/signing-commits.md b/content/authentication/managing-commit-signature-verification/signing-commits.md index cf7d05904237..e9b3200e360c 100644 --- a/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -36,7 +36,7 @@ If you have multiple keys or are attempting to sign commits or tags with a key t 1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m "your commit message" + $ git commit -S -m "YOUR_COMMIT_MESSAGE" # Creates a signed commit ``` 2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). diff --git a/content/authentication/managing-commit-signature-verification/signing-tags.md b/content/authentication/managing-commit-signature-verification/signing-tags.md index fac18fab40a6..e5371adbc68c 100644 --- a/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -19,12 +19,12 @@ topics: 1. To sign a tag, add `-s` to your `git tag` command. ```shell - $ git tag -s mytag + $ git tag -s MYTAG # Creates a signed tag ``` 2. Verify your signed tag by running `git tag -v [tag-name]`. ```shell - $ git tag -v mytag + $ git tag -v MYTAG # Verifies the signed tag ``` diff --git a/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md b/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md index 1f852e1bcf7a..2f300729e337 100644 --- a/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md +++ b/content/authentication/troubleshooting-ssh/error-agent-admitted-failure-to-sign.md @@ -36,8 +36,8 @@ You should be able to fix this error by loading your keys into your SSH agent wi $ eval "$(ssh-agent -s)" > Agent pid 59566 $ ssh-add -> Enter passphrase for /home/you/.ssh/id_rsa: [tippy tap] -> Identity added: /home/you/.ssh/id_rsa (/home/you/.ssh/id_rsa) +> Enter passphrase for /home/YOU/.ssh/id_rsa: [tippy tap] +> Identity added: /home/YOU/.ssh/id_rsa (/home/YOU/.ssh/id_rsa) ``` If your key does not have the default filename (`/.ssh/id_rsa`), you'll have to pass that path to `ssh-add`: @@ -47,6 +47,6 @@ If your key does not have the default filename (`/.ssh/id_rsa`), you'll have to $ eval "$(ssh-agent -s)" > Agent pid 59566 $ ssh-add ~/.ssh/my_other_key -> Enter passphrase for /home/you/.ssh/my_other_key: [tappity tap tap] -> Identity added: /home/you/.ssh/my_other_key (/home/you/.ssh/my_other_key) +> Enter passphrase for /home/YOU/.ssh/my_other_key: [tappity tap tap] +> Identity added: /home/YOU/.ssh/my_other_key (/home/YOU/.ssh/my_other_key) ``` diff --git a/content/authentication/troubleshooting-ssh/error-bad-file-number.md b/content/authentication/troubleshooting-ssh/error-bad-file-number.md index 5232b994dc32..2e65c8b6e49a 100644 --- a/content/authentication/troubleshooting-ssh/error-bad-file-number.md +++ b/content/authentication/troubleshooting-ssh/error-bad-file-number.md @@ -31,7 +31,7 @@ $ ssh -vT git@{% data variables.command_line.codeblock %} Often, the simplest solution is to simply avoid SSH entirely. Most firewalls and proxies allow HTTPS traffic without issue. To take advantage of this, change [the remote URL](/github/getting-started-with-github/about-remote-repositories) you're using: ```shell -$ git clone https://{% data variables.command_line.codeblock %}/username/reponame.git +$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPO-NAME.git > Cloning into 'reponame'... > remote: Counting objects: 84, done. > remote: Compressing objects: 100% (45/45), done. diff --git a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md index 90df343c3c5e..cc1ace2c7096 100644 --- a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md +++ b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md @@ -18,9 +18,9 @@ topics: To determine where the key has already been used, open a terminal and type the `ssh` command. Use the `-i` flag to provide the path to the key you want to check: ```shell -$ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} +$ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} # Connect to {% data variables.product.product_location %} using a specific ssh key -> Hi username! You've successfully authenticated, but GitHub does not +> Hi USERNAME! You've successfully authenticated, but GitHub does not > provide shell access. ``` @@ -30,7 +30,7 @@ The *username* in the response is the account on {% ifversion ghae %}{% data var To force SSH to use only the key provided on the command line, use `-o` to add the `IdentitiesOnly=yes` option: ```shell -$ ssh -v -o "IdentitiesOnly=yes" -i ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} +$ ssh -v -o "IdentitiesOnly=yes" -i ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} ``` ## Fixing the issue diff --git a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md index 7c01367bc9ea..3d5aad0bd17e 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md +++ b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md @@ -27,7 +27,7 @@ To make sure you are connecting to the right domain, you can enter the following ```shell $ ssh -vT git@{% data variables.command_line.codeblock %} > OpenSSH_8.1p1, LibreSSL 2.7.3 -> debug1: Reading configuration data /Users/you/.ssh/config +> debug1: Reading configuration data /Users/YOU/.ssh/config > debug1: Reading configuration data /etc/ssh/ssh_config > debug1: /etc/ssh/ssh_config line 47: Applying options for * > debug1: Connecting to {% data variables.command_line.codeblock %} port 22. @@ -40,7 +40,7 @@ The connection should be made on port 22{% ifversion fpt or ghec %}, unless you' All connections, including those for remote URLs, must be made as the "git" user. If you try to connect with your {% data variables.product.product_name %} username, it will fail: ```shell -$ ssh -T GITHUB-USERNAME@{% data variables.command_line.codeblock %} +$ ssh -T GITHUB-USERNAME@{% data variables.command_line.codeblock %} > Permission denied (publickey). ``` If your connection failed and you're using a remote URL with your {% data variables.product.product_name %} username, you can [change the remote URL to use the "git" user](/github/getting-started-with-github/managing-remote-repositories). @@ -49,7 +49,7 @@ You should verify your connection by typing: ```shell $ ssh -T git@{% data variables.command_line.codeblock %} -> Hi username! You've successfully authenticated... +> Hi USERNAME! You've successfully authenticated... ``` ## Make sure you have a key that is being used @@ -63,7 +63,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} $ eval "$(ssh-agent -s)" > Agent pid 59566 $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` {% endmac %} @@ -78,7 +78,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} 2. Verify that you have a private key generated and loaded into SSH. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` {% endwindows %} @@ -110,15 +110,15 @@ You can also check that the key is being used by trying to connect to `git@{% da ```shell $ ssh -vT git@{% data variables.command_line.codeblock %} > ... -> debug1: identity file /Users/you/.ssh/id_rsa type -1 -> debug1: identity file /Users/you/.ssh/id_rsa-cert type -1 -> debug1: identity file /Users/you/.ssh/id_dsa type -1 -> debug1: identity file /Users/you/.ssh/id_dsa-cert type -1 +> debug1: identity file /Users/YOU/.ssh/id_rsa type -1 +> debug1: identity file /Users/YOU/.ssh/id_rsa-cert type -1 +> debug1: identity file /Users/YOU/.ssh/id_dsa type -1 +> debug1: identity file /Users/YOU/.ssh/id_dsa-cert type -1 > ... > debug1: Authentications that can continue: publickey > debug1: Next authentication method: publickey -> debug1: Trying private key: /Users/you/.ssh/id_rsa -> debug1: Trying private key: /Users/you/.ssh/id_dsa +> debug1: Trying private key: /Users/YOU/.ssh/id_rsa +> debug1: Trying private key: /Users/YOU/.ssh/id_dsa > debug1: No more authentication methods to try. > Permission denied (publickey). ``` @@ -128,11 +128,11 @@ In that example, we did not have any keys for SSH to use. The "-1" at the end of ```shell $ ssh -vT git@{% data variables.command_line.codeblock %} > ... -> debug1: identity file /Users/you/.ssh/id_rsa type 1 +> debug1: identity file /Users/YOU/.ssh/id_rsa type 1 > ... > debug1: Authentications that can continue: publickey > debug1: Next authentication method: publickey -> debug1: Offering RSA public key: /Users/you/.ssh/id_rsa +> debug1: Offering RSA public key: /Users/YOU/.ssh/id_rsa ``` ## Verify the public key is attached to your account @@ -150,7 +150,7 @@ You must provide your public key to {% data variables.product.product_name %} to 3. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` {% data reusables.user-settings.access_settings %} @@ -171,7 +171,7 @@ You must provide your public key to {% data variables.product.product_name %} to 3. Find and take a note of your public key fingerprint. ```shell $ ssh-add -l -E sha256 - > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 SHA256:274ffWxgaxq/tSINAykStUL7XWyRNcRTlcST1Ei7gBQ /Users/USERNAME/.ssh/id_rsa (RSA) ``` {% data reusables.user-settings.access_settings %} @@ -192,13 +192,13 @@ You must provide your public key to {% data variables.product.product_name %} to 3. Find and take a note of your public key fingerprint. If you're using OpenSSH 6.7 or older: ```shell $ ssh-add -l - > 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA) ``` If you're using OpenSSH 6.8 or newer: ```shell $ ssh-add -l -E md5 - > 2048 MD5:a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA) + > 2048 MD5:a0:dd:42:3c:5a:9d:e4:2a:21:52:4e:78:07:6e:c8:4d /Users/USERNAME/.ssh/id_rsa (RSA) ``` {% data reusables.user-settings.access_settings %} diff --git a/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md b/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md index 9b50fabb3a61..aac4adfcdd68 100644 --- a/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md +++ b/content/authentication/troubleshooting-ssh/using-ssh-over-the-https-port.md @@ -22,7 +22,7 @@ To test if SSH over the HTTPS port is possible, run this SSH command: ```shell $ ssh -T -p 443 git@ssh.github.com -> Hi username! You've successfully authenticated, but GitHub does not +> Hi USERNAME! You've successfully authenticated, but GitHub does not > provide shell access. ``` @@ -45,6 +45,6 @@ You can test that this works by connecting once more to {% data variables.produc ```shell $ ssh -T git@{% data variables.command_line.codeblock %} -> Hi username! You've successfully authenticated, but GitHub does not +> Hi USERNAME! You've successfully authenticated, but GitHub does not > provide shell access. ``` diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md index 38ef4ef62bfa..499c7609853a 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/running-codeql-runner-in-your-ci-system.md @@ -60,7 +60,7 @@ For more information, see "[{% data variables.product.prodname_codeql_cli %}](ht ## Downloading the {% data variables.product.prodname_codeql_runner %} -You can download the {% data variables.product.prodname_codeql_runner %} from https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. On Linux: @@ -82,7 +82,7 @@ On Windows, the `codeql-runner-win.exe` file usually requires no change to permi Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell -wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux +wget https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` @@ -93,7 +93,7 @@ In addition to this, each CI server also needs: The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Allow the CI servers access to https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +1. Allow the CI servers access to https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. 1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. ## Calling the {% data variables.product.prodname_codeql_runner %} diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/content/codespaces/developing-in-codespaces/creating-a-codespace.md index e1b9972f033c..559ed6dc3834 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -138,7 +138,7 @@ You are prompted to choose a repository. If codespaces for this repository are b Alternatively, you can use flags to specify some or all of the options: ```shell -gh codespace create -r owner/repo -b branch --devcontainer-path path -m machine-type +gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE ``` In this example, replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. diff --git a/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md index eee506d1f6db..c5cea6210c7d 100644 --- a/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ b/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md @@ -78,7 +78,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por To forward a port use the `gh codespace ports forward` subcommand. Replace `codespace-port:local-port` with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports forward codespace-port:local-port +gh codespace ports forward CODESPACE-PORT:LOCAL-PORT ``` For more information about this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_ports_forward). @@ -132,7 +132,7 @@ To change the visibility of a forwarded port, use the `gh codespace ports visibi Replace `codespace-port` with the forwarded port number. Replace `setting` with `private`, `org`, or `public`. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports visibility codespace-port:setting +gh codespace ports visibility CODESPACE-PORT:SETTINGS ``` You can set the visibility for multiple ports with one command. For example: diff --git a/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index b296745717e4..e27f565ffc95 100644 --- a/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -50,7 +50,7 @@ Changing the display name of a codespace can be useful if you have multiple code To rename a codespace, use the `gh codespace edit` subcommand: ```shell -gh codespace edit -c permanent name of the codespace -d new display name +gh codespace edit -c PERMANENT-NAME-OF-CODESPACE -d NEW-DISPLAY-NAME ``` In this example, replace `permanent name of the codespace` with the permanent name of the codespace. Replace `new display name` with the desired display name. \ No newline at end of file diff --git a/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md b/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md index 0a582c1557e5..14283811fcb1 100644 --- a/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md +++ b/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md @@ -62,7 +62,7 @@ For a complete reference of `gh` commands for {% data variables.product.prodname {% note %} -**Note**: The `-c codespace-name` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. +**Note**: The `-c CODESPACE_NAME` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. {% endnote %} @@ -77,7 +77,7 @@ The list includes the unique name of each codespace, which you can use in other ### Create a new codespace ```shell -gh codespace create -r owner/repository [-b branch] +gh codespace create -r OWNER/REPO_NAME [-b BRANCH] ``` For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." @@ -85,7 +85,7 @@ For more information, see "[Creating a codespace](/codespaces/developing-in-code ### Stop a codespace ```shell -gh codespace stop -c codespace-name +gh codespace stop -c CODESPACE-NAME ``` For more information, see "[Deep dive into {% data variables.product.prodname_github_codespaces %}](/codespaces/getting-started/deep-dive#closing-or-stopping-your-codespace)." @@ -93,7 +93,7 @@ For more information, see "[Deep dive into {% data variables.product.prodname_gi ### Delete a codespace ```shell -gh codespace delete -c codespace-name +gh codespace delete -c CODESPACE-NAME ``` For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." @@ -103,7 +103,7 @@ For more information, see "[Deleting a codespace](/codespaces/developing-in-code To run commands on the remote codespace machine, from your terminal, you can SSH into the codespace. ```shell -gh codespace ssh -c codespace-name +gh codespace ssh -c CODESPACE-NAME ``` {% data variables.product.prodname_github_codespaces %} copies your GitHub SSH keys into the codespace on creation for a seamless authentication experience. You may be asked to enter the passphrase for your SSH key, after which you will get a command prompt from the remote codespace machine. @@ -113,7 +113,7 @@ If you don't have any SSH keys, follow the instructions in "[Generating a new SS ### Open a codespace in {% data variables.product.prodname_vscode %} ```shell -gh codespace code -c codespace-name +gh codespace code -c CODESPACE-NAME ``` For more information, see "[Using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code)." @@ -121,13 +121,13 @@ For more information, see "[Using {% data variables.product.prodname_github_code ### Open a codespace in JupyterLab ```shell -gh codespace jupyter -c codespace-name +gh codespace jupyter -c CODESPACE-NAME ``` ### Copy a file to/from a codespace ```shell -gh codespace cp [-r] source(s) destination +gh codespace cp [-r] SOURCE(S) DESTINATION ``` Use the prefix `remote:` on a file or directory name to indicate that it's on the codespace. As with the UNIX `cp` command, the first argument specifies the source and the last specifies the destination. If the destination is a directory, you can specify multiple sources. Use the `-r` (recursive) flag if any of the sources is a directory. @@ -171,7 +171,7 @@ For more information about the `gh codespace cp` command, including additional f You can forward a port on a codespace to a local port. The port remains forwarded as long as the process is running. To stop forwarding the port, press Control+C. ```shell -gh codespace ports forward codespace-port-number:local-port-number -c codespace-name +gh codespace ports forward CODESPACE-PORT_NAME:LOCAL-PORT-NAME -c CODESPACE-NAME ``` To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. @@ -179,13 +179,13 @@ To see details of forwarded ports enter `gh codespace ports` and then choose a c You can set the visibility of a forwarded port. {% data reusables.codespaces.port-visibility-settings %} ```shell -gh codespace ports visibility codespace-port:private|org|public -c codespace-name +gh codespace ports visibility CODESPACE-PORT:private|org|public -c CODESPACE-NAME ``` You can set the visibility for multiple ports with one command. For example: ```shell -gh codespace ports visibility 80:private 3000:public 3306:org -c codespace-name +gh codespace ports visibility 80:private 3000:public 3306:org -c CODESPACE-NAME ``` For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." @@ -195,7 +195,7 @@ For more information, see "[Forwarding ports in your codespace](/codespaces/deve You can see the creation log for a codespace. After entering this command you will be asked to enter the passphrase for your SSH key. ```shell -gh codespace logs -c codespace-name +gh codespace logs -c CODESPACE-NAME ``` For more information about the creation log, see "[{% data variables.product.prodname_github_codespaces %} logs](/codespaces/troubleshooting/github-codespaces-logs#creation-logs)." diff --git a/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md b/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md index 82a0d99505a1..88fb8ca013ab 100644 --- a/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md +++ b/content/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages.md @@ -55,7 +55,7 @@ Every wiki provides an easy way to clone its contents down to your computer. Once you've created an initial page on {% data variables.product.product_name %}, you can clone the repository to your computer with the provided URL: ```shell -$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git +$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git # Clones the wiki locally ``` diff --git a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md index 4130690cea4b..0bda3e62d64d 100644 --- a/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md +++ b/content/desktop/installing-and-configuring-github-desktop/installing-and-authenticating-to-github-desktop/authenticating-to-github.md @@ -113,7 +113,7 @@ To troubleshoot, sign out of your account on {% data variables.product.prodname_ ### Empty token ```shell -info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - (empty token) +info: [ui] [AppStore.withAuthenticatingUser] account found for repository: node - USERNAME (empty token) ``` This error means that {% data variables.product.prodname_desktop %} is unable to find the access token that it created in the system keychain. diff --git a/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md b/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md index c0f1fec25764..edcbbd090041 100644 --- a/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md +++ b/content/desktop/installing-and-configuring-github-desktop/overview/launching-github-desktop-from-the-command-line.md @@ -16,13 +16,13 @@ versions: 3. {% data reusables.desktop.launch-desktop-from-command-line %} ```shell - $ github /path/to/repo + $ github /PATH/TO/REPO ``` You can also change to your repository path and then type `github .` to open that repository. ```shell - $ cd /path/to/repo + $ cd /PATH/TO/REPO [repo]$ github . ``` @@ -34,13 +34,13 @@ versions: 2. {% data reusables.desktop.launch-desktop-from-command-line %} ```shell - C:\Users\octocat> github path\to\repo + C:\Users\octocat> github PATH\TO\REPO ``` You can also change to your repository path and then type `github .` to open that repository. ```shell - C:\Users\octocat> cd repo\myrepo + C:\Users\octocat> cd REPO\MY-REPO C:\Users\octocat\repo\myrepo> github . ``` diff --git a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index e25b98006d25..a8274a92fa32 100644 --- a/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -48,7 +48,7 @@ To verify a private key: ![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) 2. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell - $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 + $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 ``` 3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. diff --git a/content/developers/overview/using-ssh-agent-forwarding.md b/content/developers/overview/using-ssh-agent-forwarding.md index cb7a2ce91231..7921be217c47 100644 --- a/content/developers/overview/using-ssh-agent-forwarding.md +++ b/content/developers/overview/using-ssh-agent-forwarding.md @@ -32,7 +32,7 @@ You can test that your local key works by entering `ssh -T git@{% ifversion ghes ```shell $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} # Attempt to SSH in to github -> Hi username! You've successfully authenticated, but GitHub does not provide +> Hi USERNAME! You've successfully authenticated, but GitHub does not provide > shell access. ``` @@ -68,7 +68,7 @@ If the variable is not set, it means that agent forwarding is not working: ```shell $ echo "$SSH_AUTH_SOCK" # Print out the SSH_AUTH_SOCK variable -> [No output] +> [No output] $ ssh -T git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %} # Try to SSH to github > Permission denied (publickey). @@ -84,7 +84,7 @@ SSH forwarding only works with SSH URLs, not HTTP(s) URLs. Check the `.git/confi ```shell [remote "origin"] - url = git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}:yourAccount/yourProject.git + url = git@{% ifversion ghes or ghae %}hostname{% else %}github.com{% endif %}:YOUR_ACCOUNT/YOUR_PROJECT.git fetch = +refs/heads/*:refs/remotes/origin/* ``` @@ -97,10 +97,10 @@ Before you can make your keys work through agent forwarding, they must work loca Sometimes, system configurations disallow SSH agent forwarding. You can check if a system configuration file is being used by entering the following command in the terminal: ```shell -$ ssh -v example.com -# Connect to example.com with verbose debug output +$ ssh -v URL +# Connect to the specified URL with verbose debug output > OpenSSH_8.1p1, LibreSSL 2.7.3 -> debug1: Reading configuration data /Users/you/.ssh/config +> debug1: Reading configuration data /Users/YOU/.ssh/config > debug1: Applying options for example.com > debug1: Reading configuration data /etc/ssh_config > debug1: Applying options for * @@ -147,7 +147,7 @@ ssh-add -L If the command says that no identity is available, you'll need to add your key: ```shell -$ ssh-add yourkey +$ ssh-add YOUR-KEY ``` {% tip %} @@ -155,7 +155,7 @@ $ ssh-add yourkey On macOS, `ssh-agent` will "forget" this key, once it gets restarted during reboots. But you can import your SSH keys into Keychain using this command: ```shell -$ ssh-add -K yourkey +$ ssh-add -K YOUR-KEY ``` {% endtip %} diff --git a/content/developers/webhooks-and-events/webhooks/creating-webhooks.md b/content/developers/webhooks-and-events/webhooks/creating-webhooks.md index 4a2fc2da6750..4891b1b67699 100644 --- a/content/developers/webhooks-and-events/webhooks/creating-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/creating-webhooks.md @@ -26,7 +26,7 @@ For the purposes of this tutorial, we're going to use a local server to receive After installing `ngrok`, you can expose your localhost by running `./ngrok http 4567` on the command line. 4567 is the port number on which our server will listen for messages. You should see a line that looks something like this: ```shell -$ Forwarding http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567 +$ Forwarding http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567 ``` Make a note of the `*.ngrok.io` URL. We'll use it to set up our webhook. diff --git a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md index 4bfb12f6f5b6..d4828309cdf7 100644 --- a/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md +++ b/content/developers/webhooks-and-events/webhooks/securing-your-webhooks.md @@ -30,7 +30,7 @@ To set your token on GitHub: Next, set up an environment variable on your server that stores this token. Typically, this is as simple as running: ```shell -$ export SECRET_TOKEN=your_token +$ export SECRET_TOKEN=YOUR-TOKEN ``` **Never** hardcode the token into your app! diff --git a/content/get-started/getting-started-with-git/about-remote-repositories.md b/content/get-started/getting-started-with-git/about-remote-repositories.md index fa1440f73c8c..174a8d2db3be 100644 --- a/content/get-started/getting-started-with-git/about-remote-repositories.md +++ b/content/get-started/getting-started-with-git/about-remote-repositories.md @@ -34,7 +34,7 @@ You can use the `git remote add` command to match a remote URL with a name. For example, you'd type the following in the command line: ```shell -git remote add origin <REMOTE_URL> +git remote add origin <REMOTE_URL> ``` This associates the name `origin` with the `REMOTE_URL`. diff --git a/content/get-started/getting-started-with-git/ignoring-files.md b/content/get-started/getting-started-with-git/ignoring-files.md index 72d4b8d66897..6e098c14d2a7 100644 --- a/content/get-started/getting-started-with-git/ignoring-files.md +++ b/content/get-started/getting-started-with-git/ignoring-files.md @@ -35,7 +35,7 @@ For an example *.gitignore* file, see "[Some common .gitignore configurations](h If you want to ignore a file that is already checked in, you must untrack the file before you add a rule to ignore it. From your terminal, untrack the file. ```shell -$ git rm --cached FILENAME +$ git rm --cached FILENAME ``` ## Configuring ignored files for all repositories on your computer diff --git a/content/get-started/getting-started-with-git/managing-remote-repositories.md b/content/get-started/getting-started-with-git/managing-remote-repositories.md index 57047746e8aa..3799d2d88a8f 100644 --- a/content/get-started/getting-started-with-git/managing-remote-repositories.md +++ b/content/get-started/getting-started-with-git/managing-remote-repositories.md @@ -36,13 +36,13 @@ The `git remote add` command takes two arguments: For example: ```shell -$ git remote add origin https://{% data variables.command_line.codeblock %}/user/repo.git +$ git remote add origin https://{% data variables.command_line.codeblock %}/USER/REPO>.git # Set a new remote $ git remote -v # Verify new remote -> origin https://{% data variables.command_line.codeblock %}/user/repo.git (fetch) -> origin https://{% data variables.command_line.codeblock %}/user/repo.git (push) +> origin https://{% data variables.command_line.codeblock %}/USER/REPO.git (fetch) +> origin https://{% data variables.command_line.codeblock %}/USER/REPO.git (push) ``` For more information on which URL to use, see "[About remote repositories](/github/getting-started-with-github/about-remote-repositories)." @@ -77,11 +77,11 @@ The `git remote set-url` command takes two arguments: * A new URL for the remote. For example: * If you're updating to use HTTPS, your URL might look like: ```shell -https://{% data variables.command_line.backticks %}/USERNAME/REPOSITORY.git +https://{% data variables.command_line.backticks %}/USERNAME/REPOSITORY.git ``` * If you're updating to use SSH, your URL might look like: ```shell -git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git +git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git ``` ### Switching remote URLs from SSH to HTTPS @@ -91,19 +91,19 @@ git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY 3. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v - > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (fetch) - > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (push) + > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (fetch) + > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (push) ``` 4. Change your remote's URL from SSH to HTTPS with the `git remote set-url` command. ```shell - $ git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git + $ git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git ``` 5. Verify that the remote URL has changed. ```shell $ git remote -v # Verify new remote URL - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) ``` The next time you `git fetch`, `git pull`, or `git push` to the remote repository, you'll be asked for your GitHub username and password. {% data reusables.user-settings.password-authentication-deprecation %} @@ -117,19 +117,19 @@ You can [use a credential helper](/github/getting-started-with-github/caching-yo 3. List your existing remotes in order to get the name of the remote you want to change. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git (push) ``` 4. Change your remote's URL from HTTPS to SSH with the `git remote set-url` command. ```shell - $ git remote set-url origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git + $ git remote set-url origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git ``` 5. Verify that the remote URL has changed. ```shell $ git remote -v # Verify new remote URL - > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (fetch) - > origin git@{% data variables.command_line.codeblock %}:USERNAME/REPOSITORY.git (push) + > origin git@{% data variables.command_line.codeblock %}: USERNAME/REPOSITORY.git (fetch) + > origin git@{% data variables.command_line.codeblock %}: USERNAME/REPOSITORY.git (push) ``` ### Troubleshooting: No such remote '[name]' @@ -158,16 +158,16 @@ These examples assume you're [cloning using HTTPS](/github/getting-started-with- ```shell $ git remote -v # View existing remotes -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) $ git remote rename origin destination # Change remote name from 'origin' to 'destination' $ git remote -v # Verify remote's new name -> destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) -> destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) +> destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) +> destination https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` ### Troubleshooting: Could not rename config section 'remote.[old name]' to 'remote.[new name]' @@ -179,8 +179,8 @@ You can check which remotes currently exist with the `git remote -v` command: ```shell $ git remote -v # View existing remotes -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) ``` ### Troubleshooting: Remote [new name] already exists @@ -203,22 +203,22 @@ These examples assume you're [cloning using HTTPS](/github/getting-started-with- ```shell $ git remote -v # View current remotes -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) -> destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (fetch) -> destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (push) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) +> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) +> destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (fetch) +> destination https://{% data variables.command_line.codeblock %}/FORKER/REPOSITORY.git (push) $ git remote rm destination # Remove remote $ git remote -v # Verify it's gone -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (fetch) -> origin https://{% data variables.command_line.codeblock %}/OWNER/REPOSITORY.git (push) +> origin https://{% data variables.command_line.codeblock %}/ OWNER/REPOSITORY.git (fetch) +> origin https://{% data variables.command_line.codeblock %}/ OWNER/REPOSITORY.git (push) ``` {% warning %} -**Note**: `git remote rm` does not delete the remote repository from the server. It simply +**Note**: `git remote rm` does not delete the remote repository from the server. It simply removes the remote and its references from your local repository. {% endwarning %} diff --git a/content/get-started/getting-started-with-git/setting-your-username-in-git.md b/content/get-started/getting-started-with-git/setting-your-username-in-git.md index 76e3656c322a..d4c7186cadb9 100644 --- a/content/get-started/getting-started-with-git/setting-your-username-in-git.md +++ b/content/get-started/getting-started-with-git/setting-your-username-in-git.md @@ -24,7 +24,7 @@ Changing the name associated with your Git commits using `git config` will only 2. {% data reusables.user-settings.set_your_git_username %} ```shell - $ git config --global user.name "Mona Lisa" + $ git config --global user.name "Mona Lisa" ``` 3. {% data reusables.user-settings.confirm_git_username_correct %} @@ -41,7 +41,7 @@ Changing the name associated with your Git commits using `git config` will only 3. {% data reusables.user-settings.set_your_git_username %} ```shell - $ git config user.name "Mona Lisa" + $ git config user.name "Mona Lisa" ``` 3. {% data reusables.user-settings.confirm_git_username_correct %} diff --git a/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md b/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md index e206e73052ac..38ccb5ee1c4f 100644 --- a/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md +++ b/content/get-started/getting-started-with-git/updating-credentials-from-the-macos-keychain.md @@ -40,7 +40,7 @@ Through the command line, you can use the credential helper directly to erase th $ git credential-osxkeychain erase host={% data variables.command_line.codeblock %} protocol=https -> [Press Return] +> [Press Return] ``` If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md index eb649b3f6c28..2e04cd85a880 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/adding-locally-hosted-code-to-github.md @@ -86,7 +86,7 @@ If you have existing source code or repositories stored locally on your computer ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell - $ git remote add origin <REMOTE_URL> + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL @@ -132,7 +132,7 @@ If you have existing source code or repositories stored locally on your computer ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In the Command prompt, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell - $ git remote add origin <REMOTE_URL> + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL @@ -178,7 +178,7 @@ If you have existing source code or repositories stored locally on your computer ![Copy remote repository URL field](/assets/images/help/repository/copy-remote-repository-url-quick-setup.png) 8. In Terminal, [add the URL for the remote repository](/github/getting-started-with-github/managing-remote-repositories) where your local repository will be pushed. ```shell - $ git remote add origin <REMOTE_URL> + $ git remote add origin <REMOTE_URL> # Sets the new remote $ git remote -v # Verifies the new remote URL diff --git a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md index 1ded6370dcc8..e570aed9dc1d 100644 --- a/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md +++ b/content/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-git-repository-using-the-command-line.md @@ -31,17 +31,17 @@ For purposes of demonstration, we'll use: 1. [Create a new repository on {% data variables.product.product_name %}](/articles/creating-a-new-repository). You'll import your external Git repository to this new repository. 2. On the command line, make a "bare" clone of the repository using the external clone URL. This creates a full copy of the data, but without a working directory for editing files, and ensures a clean, fresh export of all the old data. ```shell - $ git clone --bare https://external-host.com/extuser/repo.git + $ git clone --bare https://external-host.com/EXTUSER/REPO.git # Makes a bare clone of the external repository in a local directory ``` 3. Push the locally cloned repository to {% data variables.product.product_name %} using the "mirror" option, which ensures that all references, such as branches and tags, are copied to the imported repository. ```shell - $ cd repo.git - $ git push --mirror https://{% data variables.command_line.codeblock %}/ghuser/repo.git + $ cd REPO.git + $ git push --mirror https://{% data variables.command_line.codeblock %}/USER/REPO.git # Pushes the mirror to the new repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} ``` 4. Remove the temporary local repository. ```shell $ cd .. - $ rm -rf repo.git + $ rm -rf REPO.git ``` diff --git a/content/get-started/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients.md b/content/get-started/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients.md index 2192e4a51ba5..de2b2a248918 100644 --- a/content/get-started/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients.md +++ b/content/get-started/importing-your-projects-to-github/working-with-subversion-on-github/support-for-subversion-clients.md @@ -26,9 +26,9 @@ Subversion checkouts are different: they mix the repository data in the working 3. Make an empty checkout of the repository: ```shell - $ svn co --depth empty https://github.com/user/repo + $ svn co --depth empty https://github.com/USER/REPO > Checked out revision 1. - $ cd repo + $ cd REPO ``` 4. Get the `trunk` branch. The Subversion bridge maps trunk to the Git HEAD branch. @@ -74,7 +74,7 @@ You can also confirm the new branch via the command line: ```shell $ git fetch -> From https://github.com/user/repo/ +> From https://github.com/USER/REPO/ > * [new branch] more_awesome -> origin/more_awesome ``` @@ -107,13 +107,13 @@ $ svn commit -m 'Test coverage for problems' To switch between branches, you'll probably want to start with a checkout of `trunk`: ```shell -$ svn co --depth empty https://github.com/user/repo/trunk +$ svn co --depth empty https://github.com/USER/REPO/trunk ``` Then, you can switch to another branch: ```shell -$ svn switch https://github.com/user/repo/branches/more_awesome +$ svn switch https://github.com/USER/REPO/branches/more_awesome ``` ## Finding the Git commit SHA for a Subversion commit @@ -123,7 +123,7 @@ GitHub's Subversion server exposes the Git commit sha for each Subversion commit To see the commit SHA, you should ask for the `git-commit` unversioned remote property. ```shell -$ svn propget git-commit --revprop -r HEAD https://github.com/user/repo +$ svn propget git-commit --revprop -r HEAD https://github.com/USER/REPO 05fcc584ed53d7b0c92e116cb7e64d198b13c4e3 ``` diff --git a/content/get-started/quickstart/contributing-to-projects.md b/content/get-started/quickstart/contributing-to-projects.md index 3e9ad2b29801..70a08fbc3a38 100644 --- a/content/get-started/quickstart/contributing-to-projects.md +++ b/content/get-started/quickstart/contributing-to-projects.md @@ -58,12 +58,12 @@ You can clone your fork with the command line, {% data variables.product.prodnam {% data reusables.command_line.change-current-directory-clone %} 4. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife ``` 5. Press **Enter**. Your local clone will be created. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. @@ -80,7 +80,7 @@ You can clone your fork with the command line, {% data variables.product.prodnam To create a clone of your fork, use the `--clone` flag. ```shell -gh repo fork repository --clone=true +gh repo fork REPOSITORY --clone=true ``` {% endcli %} diff --git a/content/get-started/quickstart/fork-a-repo.md b/content/get-started/quickstart/fork-a-repo.md index 9d3c9526b65c..52f7e2ba2613 100644 --- a/content/get-started/quickstart/fork-a-repo.md +++ b/content/get-started/quickstart/fork-a-repo.md @@ -83,13 +83,13 @@ You might fork a project to propose changes to the upstream, or original, reposi To create a fork of a repository, use the `gh repo fork` subcommand. ```shell -gh repo fork repository +gh repo fork REPOSITORY ``` To create the fork in an organization, use the `--org` flag. ```shell -gh repo fork repository --org "octo-org" +gh repo fork REPOSITORY --org "octo-org" ``` {% endcli %} @@ -109,12 +109,12 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th {% data reusables.command_line.change-current-directory-clone %} 4. Type `git clone`, and then paste the URL you copied earlier. It will look like this, with your {% data variables.product.product_name %} username instead of `YOUR-USERNAME`: ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife ``` 5. Press **Enter**. Your local clone will be created. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/Spoon-Knife > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. @@ -131,7 +131,7 @@ Right now, you have a fork of the Spoon-Knife repository, but you do not have th To create a clone of your fork, use the `--clone` flag. ```shell -gh repo fork repository --clone=true +gh repo fork REPOSITORY --clone=true ``` {% endcli %} @@ -163,8 +163,8 @@ When you fork a project in order to propose changes to the original repository, 5. Type `git remote -v` and press **Enter**. You will see the current configured remote repository for your fork. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) ``` 6. Type `git remote add upstream`, and then paste the URL you copied in Step 3 and press **Enter**. It will look like this: @@ -175,10 +175,10 @@ When you fork a project in order to propose changes to the original repository, 7. To verify the new upstream repository you have specified for your fork, type `git remote -v` again. You should see the URL for your fork as `origin`, and the URL for the original repository as `upstream`. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) - > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) - > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/ YOUR_FORK.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) + > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ ORIGINAL_REPOSITORY.git (fetch) + > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ ORIGINAL_REPOSITORY.git (push) ``` Now, you can keep your fork synced with the upstream repository with a few Git commands. For more information, see "[Syncing a fork](/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork)." @@ -192,13 +192,13 @@ Now, you can keep your fork synced with the upstream repository with a few Git c To configure a remote repository for the forked repository, use the `--remote` flag. ```shell -gh repo fork repository --remote=true +gh repo fork REPOSITORY --remote=true ``` To specify the remote repository's name, use the `--remote-name` flag. ```shell -gh repo fork repository --remote-name "main-remote-repo" +gh repo fork REPOSITORY --remote-name "main-remote-repo" ``` {% endcli %} diff --git a/content/get-started/using-git/about-git-rebase.md b/content/get-started/using-git/about-git-rebase.md index 008dcea289c2..8c091ebe3b22 100644 --- a/content/get-started/using-git/about-git-rebase.md +++ b/content/get-started/using-git/about-git-rebase.md @@ -31,7 +31,7 @@ Typically, you would use `git rebase` to: To rebase all the commits between another branch and the current branch state, you can enter the following command in your shell (either the command prompt for Windows, or the terminal for Mac and Linux): ```shell -$ git rebase --interactive other_branch_name +$ git rebase --interactive OTHER-BRANCH-NAME ``` ## Rebasing commits against a point in time diff --git a/content/get-started/using-git/about-git-subtree-merges.md b/content/get-started/using-git/about-git-subtree-merges.md index 3fdd7bdf1d2c..fc56e8aadb80 100644 --- a/content/get-started/using-git/about-git-subtree-merges.md +++ b/content/get-started/using-git/about-git-subtree-merges.md @@ -99,7 +99,7 @@ Although we've only added one subproject, any number of subprojects can be incor When a subproject is added, it is not automatically kept in sync with the upstream changes. You will need to update the subproject with the following command: ```shell -$ git pull -s subtree remotename branchname +$ git pull -s subtree REMOTE-NAME BRANCH-NAME ``` For the example above, this would be: diff --git a/content/get-started/using-git/dealing-with-non-fast-forward-errors.md b/content/get-started/using-git/dealing-with-non-fast-forward-errors.md index 46e0c1673eab..9852f9064a02 100644 --- a/content/get-started/using-git/dealing-with-non-fast-forward-errors.md +++ b/content/get-started/using-git/dealing-with-non-fast-forward-errors.md @@ -17,7 +17,7 @@ If another person has pushed to the same branch as you, Git won't be able to pus ```shell $ git push origin main -> To https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git +> To https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git > ! [rejected] main -> main (non-fast-forward) > error: failed to push some refs to 'https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git' > To prevent you from losing history, non-fast-forward updates were rejected @@ -30,13 +30,13 @@ You can fix this by [fetching and merging](/github/getting-started-with-github/g ```shell $ git fetch origin # Fetches updates made to an online repository -$ git merge origin YOUR_BRANCH_NAME +$ git merge origin YOUR_BRANCH_NAME # Merges updates made online with your local work ``` Or, you can simply use `git pull` to perform both commands at once: ```shell -$ git pull origin YOUR_BRANCH_NAME +$ git pull origin YOUR_BRANCH_NAME # Grabs online updates and merges them with your local work ``` diff --git a/content/get-started/using-git/getting-changes-from-a-remote-repository.md b/content/get-started/using-git/getting-changes-from-a-remote-repository.md index 63fa47a4cd0a..a37185cd69d4 100644 --- a/content/get-started/using-git/getting-changes-from-a-remote-repository.md +++ b/content/get-started/using-git/getting-changes-from-a-remote-repository.md @@ -23,7 +23,7 @@ These commands are very useful when interacting with [a remote repository](/gith To grab a complete copy of another user's repository, use `git clone` like this: ```shell -$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git +$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git # Clones a repository to your computer ``` @@ -49,7 +49,7 @@ Use `git fetch` to retrieve new work done by other people. Fetching from a repos If you already have a local repository with a remote URL set up for the desired project, you can grab all the new information by using `git fetch *remotename*` in the terminal: ```shell -$ git fetch remotename +$ git fetch REMOTE-NAME # Fetches updates made to a remote repository ``` @@ -62,7 +62,7 @@ Merging combines your local changes with changes made by others. Typically, you'd merge a remote-tracking branch (i.e., a branch fetched from a remote repository) with your local branch: ```shell -$ git merge remotename/branchname +$ git merge REMOTE-NAME/BRANCH-NAME # Merges updates made online with your local work ``` @@ -71,7 +71,7 @@ $ git merge remotename/branchname `git pull` is a convenient shortcut for completing both `git fetch` and `git merge `in the same command: ```shell -$ git pull remotename branchname +$ git pull REMOTE-NAME BRANCH-NAME # Grabs online updates and merges them with your local work ``` diff --git a/content/get-started/using-git/pushing-commits-to-a-remote-repository.md b/content/get-started/using-git/pushing-commits-to-a-remote-repository.md index b5c8c332626c..fdf805447f9b 100644 --- a/content/get-started/using-git/pushing-commits-to-a-remote-repository.md +++ b/content/get-started/using-git/pushing-commits-to-a-remote-repository.md @@ -23,7 +23,7 @@ The `git push` command takes two arguments: For example: ```shell -git push <REMOTENAME> <BRANCHNAME> +git push REMOTE-NAME BRANCH-NAME ``` As an example, you usually run `git push origin main` to push your local changes @@ -35,10 +35,10 @@ To rename a branch, you'd use the same `git push` command, but you would add one more argument: the name of the new branch. For example: ```shell -git push <REMOTENAME> <LOCALBRANCHNAME>:<REMOTEBRANCHNAME> +git push REMOTE-NAME LOCAL-BRANCH-NAME:REMOTE-BRANCH-NAME ``` -This pushes the `LOCALBRANCHNAME` to your `REMOTENAME`, but it is renamed to `REMOTEBRANCHNAME`. +This pushes the `LOCAL-BRANCH-NAME` to your `REMOTE-NAME`, but it is renamed to `REMOTE-BRANCH-NAME`. ## Dealing with "non-fast-forward" errors @@ -57,13 +57,13 @@ that have the same names as remote branches. To push a single tag, you can issue the same command as pushing a branch: ```shell -git push <REMOTENAME> <TAGNAME> +git push REMOTE-NAME TAG-NAME ``` To push all your tags, you can type the command: ```shell -git push <REMOTENAME> --tags +git push REMOTE-NAME --tags ``` ## Deleting a remote branch or tag @@ -71,12 +71,12 @@ git push <REMOTENAME> --tags The syntax to delete a branch is a bit arcane at first glance: ```shell -git push <REMOTENAME> :<BRANCHNAME> +git push REMOTE-NAME:BRANCH-NAME ``` Note that there is a space before the colon. The command resembles the same steps you'd take to rename a branch. However, here, you're telling Git to push _nothing_ -into `BRANCHNAME` on `REMOTENAME`. Because of this, `git push` deletes the branch +into `BRANCH-NAME` on `REMOTE-NAME`. Because of this, `git push` deletes the branch on the remote repository. ## Remotes and forks @@ -89,7 +89,7 @@ repository, you'd add a new remote URL, typically called `upstream`, to your local Git clone: ```shell -git remote add upstream <THEIR_REMOTE_URL> +git remote add upstream THEIR_REMOTE_URL ``` Now, you can fetch updates and branches from *their* fork: @@ -101,7 +101,7 @@ git fetch upstream > remote: Compressing objects: 100% (53/53), done. > remote: Total 62 (delta 27), reused 44 (delta 9) > Unpacking objects: 100% (62/62), done. -> From https://{% data variables.command_line.codeblock %}/octocat/repo +> From https://{% data variables.command_line.codeblock %}/OCTOCAT/REPO > * [new branch] main -> upstream/main ``` diff --git a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md index 49eef30c382c..53ae26156a8c 100644 --- a/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md +++ b/content/get-started/using-git/splitting-a-subfolder-out-into-a-new-repository.md @@ -22,12 +22,12 @@ If you create a new clone of the repository, you won't lose any of your Git hist 4. Clone the repository that contains the subfolder. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME ``` 4. Change the current working directory to your cloned repository. ```shell - $ cd REPOSITORY-NAME + $ cd REPOSITORY-NAME ``` 5. To filter out the subfolder from the rest of the files in the repository, run [`git filter-repo`](https://github.com/newren/git-filter-repo), supplying this information: @@ -47,7 +47,7 @@ If you create a new clone of the repository, you won't lose any of your Git hist $ git filter-repo --path FOLDER-NAME1/ --path FOLDER-NAME2/ # Filter the specified branch in your directory and remove empty commits > Rewrite 48dc599c80e20527ed902928085e7861e6b3cbe6 (89/89) - > Ref 'refs/heads/BRANCH-NAME' was rewritten + > Ref 'refs/heads/BRANCH-NAME' was rewritten ``` The repository should now only contain the files that were in your subfolder(s). @@ -67,24 +67,24 @@ If you create a new clone of the repository, you won't lose any of your Git hist 8. Check the existing remote name for your repository. For example, `origin` or `upstream` are two common choices. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY-NAME.git (push) ``` 9. Set up a new remote URL for your new repository using the existing remote name and the remote repository URL you copied in step 7. ```shell - git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git + git remote set-url origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git ``` 10. Verify that the remote URL has changed with your new repository name. ```shell $ git remote -v # Verify new remote URL - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/USERNAME/NEW-REPOSITORY-NAME.git (push) ``` 11. Push your changes to the new repository on {% data variables.product.product_name %}. ```shell - git push -u origin BRANCH-NAME + git push -u origin BRANCH-NAME ``` diff --git a/content/github-cli/github-cli/creating-github-cli-extensions.md b/content/github-cli/github-cli/creating-github-cli-extensions.md index e51a8bd6a9bb..7c0a984b0e91 100644 --- a/content/github-cli/github-cli/creating-github-cli-extensions.md +++ b/content/github-cli/github-cli/creating-github-cli-extensions.md @@ -35,7 +35,7 @@ You can use the `gh extension create` command to create a project for your exten 1. Set up a new extension by using the `gh extension create` subcommand. Replace `EXTENSION-NAME` with the name of your extension. ```shell - gh extension create EXTENSION-NAME + gh extension create EXTENSION-NAME ``` 1. Follow the printed instructions to finalize and optionally publish your extension. @@ -47,7 +47,7 @@ You can use the `--precompiled=go` argument to create a Go-based project for you 1. Set up a new extension by using the `gh extension create` subcommand. Replace `EXTENSION-NAME` with the name of your extension and specify `--precompiled=go`. ```shell - gh extension create --precompiled=go EXTENSION-NAME + gh extension create --precompiled=go EXTENSION-NAME ``` 1. Follow the printed instructions to finalize and optionally publish your extension. @@ -59,7 +59,7 @@ You can use the `--precompiled=other` argument to create a project for your non- 1. Set up a new extension by using the `gh extension create` subcommand. Replace `EXTENSION-NAME` with the name of your extension and specify `--precompiled=other`. ```shell - gh extension create --precompiled=other EXTENSION-NAME + gh extension create --precompiled=other EXTENSION-NAME ``` 1. Add some initial code for your extension in your compiled language of choice. @@ -97,7 +97,7 @@ You can use the `--precompiled=other` argument to create a project for your non- 1. Verify that your extension works. Replace `EXTENSION-NAME` with the name of your extension. For example, `whoami`. ```shell - gh EXTENSION-NAME + gh EXTENSION-NAME ``` 1. From your directory, create a repository to publish your extension. Replace `EXTENSION-NAME` with the name of your extension. @@ -105,7 +105,7 @@ You can use the `--precompiled=other` argument to create a project for your non- ```shell git init -b main git add . && git commit -m "initial commit" - gh repo create gh-EXTENSION-NAME --source=. --public --push + gh repo create gh-EXTENSION-NAME --source=. --public --push ``` 1. Optionally, to help other users discover your extension, add the repository topic `gh-extension`. This will make the extension appear on the [`gh-extension` topic page](https://github.com/topics/gh-extension). For more information about how to add a repository topic, see "[Classifying your repository with topics](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)." @@ -217,7 +217,7 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g 1. Build your code. For example, with Go, replacing `YOUR-USERNAME` with your GitHub username: ```shell - go mod init github.com/YOUR-USERNAME/gh-whoami + go mod init github.com/YOUR-USERNAME/gh-whoami go mod tidy go build ``` @@ -225,7 +225,7 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g 1. Verify that your extension works. Replace `EXTENSION-NAME` with the name of your extension. For example, `whoami`. ```shell - gh EXTENSION-NAME + gh EXTENSION-NAME ``` 1. From your directory, create a repository to publish your extension. Replace `EXTENSION-NAME` with the name of your extension. @@ -238,12 +238,12 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g ```shell git init -b main - echo "gh-EXTENSION-NAME" >> .gitignore - git add main.go go.* .gitignore && git commit -m'Initial commit' - gh repo create "gh-EXTENSION-NAME" + echo "gh-EXTENSION-NAME" >> .gitignore + git add main.go go.* .gitignore && git commit -m 'Initial commit' + gh repo create "gh-EXTENSION-NAME" ``` -1. Create a release to share your precompiled extension with others. Compile for each platform you want to support, attaching each binary to a release as an asset. Binary executables attached to releases must follow a naming convention and have a suffix of OS-ARCHITECTURE\[EXTENSION\]. +1. Create a release to share your precompiled extension with others. Compile for each platform you want to support, attaching each binary to a release as an asset. Binary executables attached to releases must follow a naming convention and have a suffix of OS-ARCHITECTURE\[EXTENSION\]. For example, an extension named `whoami` compiled for Windows 64bit would have the name `gh-whoami-windows-amd64.exe` while the same extension compiled for Linux 32bit would have the name `gh-whoami-linux-386`. To see an exhaustive list of OS and architecture combinations recognized by `gh`, see [this source code](https://github.com/cli/cli/blob/14f704fd0da58cc01413ee4ba16f13f27e33d15e/pkg/cmd/extension/manager.go#L696). @@ -258,9 +258,9 @@ For more information, see [`gh help formatting`](https://cli.github.com/manual/g ```shell git tag v1.0.0 git push origin v1.0.0 - GOOS=windows GOARCH=amd64 go build -o gh-EXTENSION-NAME-windows-amd64.exe - GOOS=linux GOARCH=amd64 go build -o gh-EXTENSION-NAME-linux-amd64 - GOOS=darwin GOARCH=amd64 go build -o gh-EXTENSION-NAME-darwin-amd64 + GOOS=windows GOARCH=amd64 go build -o gh-EXTENSION-NAME-windows-amd64.exe + GOOS=linux GOARCH=amd64 go build -o gh-EXTENSION-NAME-linux-amd64 + GOOS=darwin GOARCH=amd64 go build -o gh-EXTENSION-NAME-darwin-amd64 gh release create v1.0.0 ./*amd64* 1. Optionally, to help other users discover your extension, add the repository topic `gh-extension`. This will make the extension appear on the [`gh-extension` topic page](https://github.com/topics/gh-extension). For more information about how to add a repository topic, see "[Classifying your repository with topics](/github/administering-a-repository/managing-repository-settings/classifying-your-repository-with-topics)." diff --git a/content/github-cli/github-cli/quickstart.md b/content/github-cli/github-cli/quickstart.md index 5cc3ec7b96c5..845ab25fdab9 100644 --- a/content/github-cli/github-cli/quickstart.md +++ b/content/github-cli/github-cli/quickstart.md @@ -30,7 +30,7 @@ shortTitle: Quickstart To authenticate to {% data variables.product.product_location %}, use the `--hostname` flag. ```shell - gh auth login --hostname hostname + gh auth login --hostname HOSTNAME ``` {% endif %} diff --git a/content/github-cli/github-cli/using-github-cli-extensions.md b/content/github-cli/github-cli/using-github-cli-extensions.md index c0f6c663f280..ebf804b6076e 100644 --- a/content/github-cli/github-cli/using-github-cli-extensions.md +++ b/content/github-cli/github-cli/using-github-cli-extensions.md @@ -35,7 +35,7 @@ If the owner and repository are used, `gh` will install the extension using the To install an extension in development from the current directory, use `.` as the value for the `repo` parameter. ```shell -gh extension install repo +gh extension install REPO ``` If you already have an extension by the same name installed, the command will fail. For example, if you have installed `octocat/gh-whoami`, you must uninstall it before installing `hubot/gh-whoami`. @@ -53,7 +53,7 @@ gh extension list To update an extension, use the `extensions upgrade` subcommand. Replace the `extension` parameter with the name of the extension. ```shell -gh extension upgrade extension +gh extension upgrade EXTENSION ``` To update all installed extensions, use the `--all` flag. @@ -67,5 +67,5 @@ gh extension upgrade --all To uninstall an extension, use the `extensions remove` subcommand. Replace the `extension` parameter with the name of the extension. ```shell -gh extension remove extension +gh extension remove EXTENSION ``` diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 5526810b97e0..eb64b6f601b1 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -62,7 +62,7 @@ In REST, [HTTP verbs](/rest#http-verbs) determine the operation performed. In Gr To query GraphQL using cURL, make a `POST` request with a JSON payload. The payload must contain a string called `query`: ```shell -curl -H "Authorization: bearer token" -X POST -d " \ +curl -H "Authorization: bearer TOKEN" -X POST -d " \ { \ \"query\": \"query { viewer { login }}\" \ } \ @@ -90,7 +90,7 @@ GraphQL queries return only the data you specify. To form a query, you must spec Queries are structured like this: 
query {
-  JSON objects to return
+  JSON-OBJECT-TO-RETURN
 }
For a real-world example, see "[Example query](#example-query)." @@ -106,8 +106,8 @@ To form a mutation, you must specify three things: Mutations are structured like this: 
mutation {
-  mutationName(input: {MutationNameInput!}) {
-    MutationNamePayload
+  MUTATION-NAME(input: {MUTATION-NAME-INPUT!}) {
+    MUTATION-NAME-PAYLOAD
   }
 }
diff --git a/content/graphql/guides/introduction-to-graphql.md b/content/graphql/guides/introduction-to-graphql.md index 573b706e451c..e3da852ff39b 100644 --- a/content/graphql/guides/introduction-to-graphql.md +++ b/content/graphql/guides/introduction-to-graphql.md @@ -116,7 +116,7 @@ GraphQL is [introspective](https://graphql.github.io/learn/introspection/). This * You can also run an _introspection query_ of the schema via a `GET` request: ```shell - $ curl -H "Authorization: bearer token" {% data variables.product.graphql_url_pre %} + $ curl -H "Authorization: bearer TOKEN" {% data variables.product.graphql_url_pre %} ``` {% note %} @@ -130,7 +130,7 @@ GraphQL is [introspective](https://graphql.github.io/learn/introspection/). This Alternatively, you can pass the `idl` media type to return the results in IDL format, which is a condensed version of the schema: ```shell - $ curl -H "Authorization: bearer token" -H "Accept: application/vnd.github.v4.idl" \ + $ curl -H "Authorization: bearer TOKEN" -H "Accept: application/vnd.github.v4.idl" \ {% data variables.product.graphql_url_pre %} ``` diff --git a/content/graphql/guides/using-global-node-ids.md b/content/graphql/guides/using-global-node-ids.md index 5dadcb4e95fd..ff9e2ee8929d 100644 --- a/content/graphql/guides/using-global-node-ids.md +++ b/content/graphql/guides/using-global-node-ids.md @@ -35,7 +35,7 @@ Let's walk through an example. If you [request the authenticated user](/rest/reference/users#get-the-authenticated-user): ```shell -$ curl -i -u username:token {% data variables.product.api_url_pre %}/user +$ curl -i -u USERNAME:TOKEN {% data variables.product.api_url_pre %}/user ``` you'll get a response that includes the `node_id` of the authenticated user: diff --git a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 44fc59d19057..5f0436ff5f0c 100644 --- a/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,8 +70,8 @@ You can find the node ID of an organization project if you know the organization ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -79,8 +79,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION"){ - projectV2(number: NUMBER) { + organization(login: "ORGANIZATION"){ + projectV2(number: NUMBER) { id } } @@ -94,8 +94,8 @@ You can also find the node ID of all projects in your organization. The followin ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{organization(login: \"ORGANIZATION") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -103,7 +103,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION") { + organization(login: "ORGANIZATION") { projectsV2(first: 20) { nodes { id @@ -125,8 +125,8 @@ You can find the node ID of a user project if you know the project number. Repla ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -134,8 +134,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER"){ - projectV2(number: NUMBER) { + user(login: "USER"){ + projectV2(number: NUMBER) { id } } @@ -149,8 +149,8 @@ You can also find the node ID for all of your projects. The following example wi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -158,7 +158,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER") { + user(login: "USER") { projectsV2(first: 20) { nodes { id @@ -180,8 +180,8 @@ The following example will return the ID, name, settings, and configuration for ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -189,7 +189,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -284,8 +284,8 @@ If you just need the name and ID of a field, and do not need information about i ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -293,7 +293,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -354,8 +354,8 @@ The following example will return the first 20 issues, pull requests, and draft ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -363,7 +363,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { items(first: 20) { nodes{ @@ -446,8 +446,8 @@ The following example will add an issue or pull request to your project. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -455,7 +455,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { + addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { item { id } @@ -488,8 +488,8 @@ The following example will add a draft issue to your project. Replace `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -497,7 +497,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { + addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { projectItem { id } @@ -528,8 +528,8 @@ The following example will update your project's settings. Replace `PROJECT_ID` ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: Bearer TOKEN' \ ---data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' +--header 'Authorization: Bearer TOKEN' \ +--data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -539,7 +539,7 @@ gh api graphql -f query=' mutation { updateProjectV2( input: { - projectId: "PROJECT_ID", + projectId: "PROJECT_ID", title: "Project title", public: false, readme: "# Project README\n\nA long description", @@ -565,8 +565,8 @@ The following example will update the value of a text field for an item. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -576,9 +576,9 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { text: "Updated text" } @@ -619,8 +619,8 @@ The following example will update the value of a single select field for an item ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -630,11 +630,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - singleSelectOptionId: "OPTION_ID" + singleSelectOptionId: "OPTION_ID" } } ) { @@ -659,8 +659,8 @@ The following example will update the value of an iteration field for an item. ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -670,11 +670,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - iterationId: "ITERATION_ID" + iterationId: "ITERATION_ID" } } ) { @@ -694,8 +694,8 @@ The following example will delete an item from a project. Replace `PROJECT_ID` w ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} @@ -705,8 +705,8 @@ gh api graphql -f query=' mutation { deleteProjectV2Item( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" } ) { deletedItemId diff --git a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md index cfd6821b286c..846d43cd1c09 100644 --- a/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md +++ b/content/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository.md @@ -50,7 +50,7 @@ People or teams who are mentioned in the issue will receive a notification letti To transfer an issue, use the `gh issue transfer` subcommand. Replace the `issue` parameter with the number or URL of the issue. Replace the `{% ifversion ghes %}hostname/{% endif %}owner/repo` parameter with the {% ifversion ghes %}URL{% else %}name{% endif %} of the repository that you want to transfer the issue to, such as `{% ifversion ghes %}https://ghe.io/{% endif %}octocat/octo-repo`. ```shell -gh issue transfer issue {% ifversion ghes %}hostname/{% endif %}owner/repo +gh issue transfer ISSUE {% ifversion ghes %}HOSTNAME/{% endif %}OWNER/REPO ``` {% endcli %} diff --git a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md index 4a6d44a2fa65..c9ebf87a0452 100644 --- a/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md +++ b/content/organizations/managing-git-access-to-your-organizations-repositories/about-ssh-certificate-authorities.md @@ -49,7 +49,7 @@ When you issue each certificate, you must include an extension that specifies wh {% endnote %} ```shell -$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% data variables.product.product_url %}=USERNAME ./user-key.pub +$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% data variables.product.product_url %}=USERNAME ./user-key.pub ``` {% warning %} @@ -61,11 +61,11 @@ $ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% To issue a certificate for someone who uses SSH to access multiple {% data variables.product.company_short %} products, you can include two login extensions to specify the username for each product. For example, the following command would issue a certificate for _USERNAME-1_ for the user's account for {% data variables.product.prodname_ghe_cloud %}, and _USERNAME-2_ for the user's account on {% data variables.product.prodname_ghe_managed %} or {% data variables.product.prodname_ghe_server %} at _HOSTNAME_. ```shell -$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@github.com=USERNAME-1 extension:login@HOSTNAME=USERNAME-2 ./user-key.pub +$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@github.com=USERNAME-1 extension:login@HOSTNAME=USERNAME-2 ./user-key.pub ``` You can restrict the IP addresses from which an organization member can access your organization's resources by using a `source-address` extension. The extension accepts a specific IP address or a range of IP addresses using CIDR notation. You can specify multiple addresses or ranges by separating the values with commas. For more information, see "[Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing#CIDR_notation)" on Wikipedia. ```shell -$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% data variables.product.product_url %}=USERNAME -O source-address=COMMA-SEPARATED-LIST-OF-IP-ADDRESSES-OR-RANGES ./user-key.pub +$ ssh-keygen -s ./ca-key -V '+1d' -I KEY-IDENTITY -O extension:login@{% data variables.product.product_url %}=USERNAME -O source-address=COMMA-SEPARATED-LIST-OF-IP-ADDRESSES-OR-RANGES ./user-key.pub ``` diff --git a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md index a31fe1399b17..76524a2ce037 100644 --- a/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md +++ b/content/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization.md @@ -65,7 +65,7 @@ To verify a domain, you must have access to modify domain records with your doma {% data reusables.organizations.add-dns-txt-record %} 1. Wait for your DNS configuration to change, which may take up to 72 hours. You can confirm your DNS configuration has changed by running the `dig` command on the command line, replacing `ORGANIZATION` with the name of your organization and `example.com` with the domain you'd like to verify. You should see your new TXT record listed in the command output. ```shell - $ dig _github-challenge-ORGANIZATION.example.com +nostats +nocomments +nocmd TXT + $ dig _github-challenge-ORGANIZATION.example.com +nostats +nocomments +nocmd TXT ``` 1. After confirming your TXT record is added to your DNS, follow steps one through three above to navigate to your organization's approved and verified domains. {% data reusables.organizations.continue-verifying-domain %} diff --git a/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md b/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md index 938cf7933bc0..fcdeb9ed5310 100644 --- a/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md +++ b/content/packages/learn-github-packages/connecting-a-repository-to-a-package.md @@ -36,7 +36,7 @@ By connecting a repository to a package, the package landing page will show info 1. In your Dockerfile, add this line, replacing {% ifversion ghes %}`HOSTNAME`, {% endif %}`OWNER` and `REPO` with your details: ```shell - LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPO + LABEL org.opencontainers.image.source=https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPO ``` For example, if you're the user `monalisa` and own `my-repo`, and {% data variables.product.product_location %} hostname is `github.companyname.com`, you would add this line to your Dockerfile: ```shell diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 839256b3ceb2..367b54eb1723 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -21,8 +21,8 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor 1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." 2. Clone the repository to your local machine. ```shell - $ git clone https://{% ifversion ghes or ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git - $ cd YOUR-REPOSITORY + $ git clone https://{% ifversion ghes or ghae %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git + $ cd YOUR-REPOSITORY ``` 3. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} @@ -35,9 +35,9 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ```shell $ npm init ... - package name: @YOUR-USERNAME/YOUR-REPOSITORY + package name: @YOUR-USERNAME/YOUR-REPOSITORY ... - test command: exit 0 + test command: exit 0 ... ``` {% endraw %} @@ -89,7 +89,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor - Add an NPM configuration file for the repository by creating a `.npmrc` file in the root directory with the contents: {% raw %} ```shell - @YOUR-USERNAME:registry=https://npm.pkg.github.com + @YOUR-USERNAME:registry=https://npm.pkg.github.com ``` {% endraw %} - Edit the `package.json` file and specify the `publishConfig` key: @@ -104,7 +104,7 @@ In this guide, you'll create a {% data variables.product.prodname_actions %} wor ```shell $ git add .github/workflows/release-package.yml # Also add the file you created or edited in the previous step. - $ git add .npmrc or package.json + $ git add .npmrc or package.json $ git commit -m "workflow to publish package" $ git push ``` diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md index dc433c384c01..86d916e35edd 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-docker-registry.md @@ -53,7 +53,7 @@ To keep your credentials secure, we recommend you save your personal access toke {% ifversion fpt or ghec %} {% raw %} ```shell - $ cat ~/TOKEN.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin + $ cat ~/TOKEN.txt | docker login https://docker.pkg.github.com -u USERNAME --password-stdin ``` {% endraw %} {% endif %} @@ -64,7 +64,7 @@ If your instance has subdomain isolation enabled: {% endif %} {% raw %} ```shell - $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin + $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} {% ifversion ghes %} @@ -72,7 +72,7 @@ If your instance has subdomain isolation disabled: {% raw %} ```shell - $ cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin + $ cat ~/TOKEN.txt | docker login HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} {% endif %} @@ -102,62 +102,62 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen $ docker images > < > > REPOSITORY TAG IMAGE ID CREATED SIZE - > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB + > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` 2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% ifversion fpt or ghec %} ```shell - $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} If your instance has subdomain isolation enabled: {% endif %} ```shell - $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell - $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} 3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% ifversion ghes or ghae %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% ifversion fpt or ghec %} ```shell - $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} {% ifversion ghes %} If your instance has subdomain isolation enabled: {% endif %} ```shell - $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell - $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH + $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% endif %} {% endif %} 4. Publish the image to {% data variables.product.prodname_registry %}. {% ifversion fpt or ghec %} ```shell - $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} {% ifversion ghes %} If your instance has subdomain isolation enabled: {% endif %} ```shell - $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell - $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION + $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} @@ -198,10 +198,10 @@ $ docker images > monalisa 1.0 c75bebcdd211 4 weeks ago 1.11MB # Tag the image with OWNER/REPO/IMAGE_NAME -$ docker tag c75bebcdd211 docker.HOSTNAME/octocat/octo-app/monalisa:1.0 +$ docker tag c75bebcdd211 docker.HOSTNAME/octocat/octo-app/monalisa:1.0 # Push the image to {% data variables.product.prodname_registry %} -$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 +$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 ``` {% endif %} @@ -222,10 +222,10 @@ $ docker push docker.pkg.github.com/octocat/octo-app/monalisa:1.0 ```shell # Build the image with docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION # Assumes Dockerfile resides in the current working directory (.) -$ docker build -t docker.HOSTNAME/octocat/octo-app/monalisa:1.0 . +$ docker build -t docker.HOSTNAME/octocat/octo-app/monalisa:1.0 . # Push the image to {% data variables.product.prodname_registry %} -$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 +$ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 ``` {% endif %} @@ -237,7 +237,7 @@ You can use the `docker pull` command to install a docker image from {% data var {% ifversion fpt or ghec %} ```shell -$ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +$ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% else %} @@ -245,12 +245,12 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAMEHOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +$ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell -$ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME +$ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` {% endif %} {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md index 7ff16231a56a..2646465644d0 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-gradle-registry.md @@ -57,10 +57,10 @@ publishing { repositories { maven { name = "GitHubPackages" - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") } } } @@ -84,10 +84,10 @@ subprojects { repositories { maven { name = "GitHubPackages" - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") } } } @@ -110,10 +110,10 @@ publishing { repositories { maven { name = "GitHubPackages" - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") } } } @@ -137,10 +137,10 @@ subprojects { repositories { maven { name = "GitHubPackages" - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") } } } @@ -192,10 +192,10 @@ To use a published package from {% data variables.product.prodname_registry %}, ```shell repositories { maven { - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") ?: System.getenv("TOKEN") } } } @@ -204,10 +204,10 @@ To use a published package from {% data variables.product.prodname_registry %}, ```shell repositories { maven { - url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") + url = uri("https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/REPOSITORY") credentials { - username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") - password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") + username = project.findProperty("gpr.user") as String? ?: System.getenv("USERNAME") + password = project.findProperty("gpr.key") as String? ?: System.getenv("TOKEN") } } } diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md index 8007cd2b6f96..cc0d74151d24 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-npm-registry.md @@ -55,14 +55,14 @@ If your instance has subdomain isolation enabled: {% endif %} ```shell -//{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}/:_authToken=TOKEN +//{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}/:_authToken=TOKEN ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell -//HOSTNAME/_registry/npm/:_authToken=TOKEN +//HOSTNAME/_registry/npm/:_authToken=TOKEN ``` {% endif %} @@ -75,21 +75,21 @@ If your instance has subdomain isolation enabled: {% endif %} ```shell -$ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %} +$ npm login --scope=@OWNER --registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %} -> Username: USERNAME -> Password: TOKEN -> Email: PUBLIC-EMAIL-ADDRESS +> Username: USERNAME +> Password: TOKEN +> Email: PUBLIC-EMAIL-ADDRESS ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell -$ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ -> Username: USERNAME -> Password: TOKEN -> Email: PUBLIC-EMAIL-ADDRESS +$ npm login --scope=@OWNER --registry=https://HOSTNAME/_registry/npm/ +> Username: USERNAME +> Password: TOKEN +> Email: PUBLIC-EMAIL-ADDRESS ``` {% endif %} @@ -142,14 +142,14 @@ You can use `publishConfig` element in the *package.json* file to specify the re {% endif %} ```shell "publishConfig": { - "registry":"https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}" + "registry":"https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME/{% endif %}" }, ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell "publishConfig": { - "registry":"https://HOSTNAME/_registry/npm/" + "registry":"https://HOSTNAME/_registry/npm/" }, ``` {% endif %} @@ -165,7 +165,7 @@ To ensure the repository's URL is correct, replace REPOSITORY with the name of t {% data variables.product.prodname_registry %} will match the repository based on the URL, instead of based on the package name. ```shell -"repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", +"repository":"https://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY", ``` ## Installing a package @@ -213,16 +213,16 @@ If your instance has subdomain isolation enabled: {% endif %} ```shell -@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} -@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} +@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} +@OWNER:registry=https://{% ifversion fpt or ghec %}npm.pkg.github.com{% else %}npm.HOSTNAME{% endif %} ``` {% ifversion ghes %} If your instance has subdomain isolation disabled: ```shell -@OWNER:registry=https://HOSTNAME/_registry/npm -@OWNER:registry=https://HOSTNAME/_registry/npm +@OWNER:registry=https://HOSTNAME/_registry/npm +@OWNER:registry=https://HOSTNAME/_registry/npm ``` {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md index fc4326ab48ce..2693ca8d8b8f 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-nuget-registry.md @@ -106,7 +106,7 @@ If you don't already have a PAT to use for your account on {% ifversion ghae %}{ 3. Publish the package using your PAT as the API key. ```shell - dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" + dotnet nuget push "bin/Release/OctocatApp.1.0.0.nupkg" --api-key YOUR_GITHUB_PAT --source "github" ``` {% data reusables.package_registry.viewing-packages %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md index 22800bd5c6b8..533df4844e3c 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-rubygems-registry.md @@ -60,7 +60,7 @@ For example, you would create or edit a *~/.gem/credentials* to include the foll ```shell --- -:github: Bearer TOKEN +:github: Bearer TOKEN ``` To install gems, you need to authenticate to {% data variables.product.prodname_registry %} by editing the *~/.gemrc* file for your project to include `https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER/`. You must replace: @@ -89,7 +89,7 @@ If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this exa To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% ifversion ghes %} Replace `REGISTRY-URL` with the URL for your instance's RubyGems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif ghae %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell -$ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN +$ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN ``` ## Publishing a package @@ -107,8 +107,8 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els ```shell $ gem push --key github \ - --host https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER \ - OCTO-GEM-0.0.1.gem + --host https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER \ + OCTO-GEM-0.0.1.gem ``` ## Publishing multiple packages to the same repository diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e1c0cc329d27..44bb21d7474a 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -62,11 +62,11 @@ For more information on Punycodes, see [Internationalized domain name](https://e {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM. IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . + > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -104,19 +104,19 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - For `A` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t A - > EXAMPLE.COM 3600 IN A 185.199.108.153 - > EXAMPLE.COM 3600 IN A 185.199.109.153 - > EXAMPLE.COM 3600 IN A 185.199.110.153 - > EXAMPLE.COM 3600 IN A 185.199.111.153 + $ dig EXAMPLE.COM +noall +answer -t A + > EXAMPLE.COM 3600 IN A 185.199.108.153 + > EXAMPLE.COM 3600 IN A 185.199.109.153 + > EXAMPLE.COM 3600 IN A 185.199.110.153 + > EXAMPLE.COM 3600 IN A 185.199.111.153 ``` - For `AAAA` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t AAAA - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 + $ dig EXAMPLE.COM +noall +answer -t AAAA + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -132,11 +132,11 @@ After you configure the apex domain, you must configure a CNAME record with your 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER. + > GITHUB-PAGES-SERVER. 22 IN A 192.0.2.1 ``` ## Removing a custom domain diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md index d651bc8152a7..1cc2c09500a3 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-content-to-your-github-pages-site-using-jekyll.md @@ -39,8 +39,8 @@ Your theme includes default layouts, includes, and stylesheets that will automat 4. Add the following YAML frontmatter to the top of the file, replacing _PAGE TITLE_ with the page's title and _URL-PATH_ with a path you want for the page's URL. For example, if the base URL of your site is `https://octocat.github.io` and your _URL-PATH_ is `/about/contact/`, your page will be located at `https://octocat.github.io/about/contact`. ```shell layout: page - title: "PAGE TITLE" - permalink: /URL-PATH/ + title: "PAGE-TITLE" + permalink: /URL-PATH ``` 5. Below the frontmatter, add content for your page. {% data reusables.files.write_commit_message %} @@ -62,9 +62,9 @@ Your theme includes default layouts, includes, and stylesheets that will automat 4. Add the following YAML frontmatter to the top of the file, replacing _POST TITLE_ with the post's title, _YYYY-MM-DD hh:mm:ss -0000_ with the date and time for the post, and _CATEGORY-1_ and _CATEGORY-2_ with as many categories you want for your post. ```shell layout: post - title: "POST TITLE" - date: YYYY-MM-DD hh:mm:ss -0000 - categories: CATEGORY-1 CATEGORY-2 + title: "POST-TITLE" + date: YYYY-MM-DD hh:mm:ss -0000 + categories: CATEGORY-1 CATEGORY-2 ``` 5. Below the frontmatter, add content for your post. {% data reusables.files.write_commit_message %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md index 925365fc4d0c..1ec7888ad094 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll.md @@ -45,17 +45,17 @@ Before you can use Jekyll to create a {% data variables.product.prodname_pages % {% data reusables.command_line.open_the_multi_os_terminal %} 1. If you don't already have a local copy of your repository, navigate to the location where you want to store your site's source files, replacing _PARENT-FOLDER_ with the folder you want to contain the folder for your repository. ```shell - $ cd PARENT-FOLDER + $ cd PARENT-FOLDER ``` 1. If you haven't already, initialize a local Git repository, replacing _REPOSITORY-NAME_ with the name of your repository. ```shell - $ git init REPOSITORY-NAME + $ git init REPOSITORY-NAME > Initialized empty Git repository in /Users/octocat/my-site/.git/ # Creates a new folder on your computer, initialized as a Git repository ``` 4. Change directories to the repository. ```shell - $ cd REPOSITORY-NAME + $ cd REPOSITORY-NAME # Changes the working directory ``` {% data reusables.pages.decide-publishing-source %} @@ -70,7 +70,7 @@ Before you can use Jekyll to create a {% data variables.product.prodname_pages % ```shell $ git checkout --orphan gh-pages # Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch - $ git rm -rf + $ git rm -rf . # Removes the contents from your default branch from the working directory ``` 1. To create a new Jekyll site, use the `jekyll new` command: @@ -106,14 +106,14 @@ git commit -m 'Initial GitHub pages site with Jekyll' 1. Add your repository on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} as a remote, replacing {% ifversion ghes or ghae %}_HOSTNAME_ with your enterprise's hostname,{% endif %} _USER_ with the account that owns the repository{% ifversion ghes or ghae %},{% endif %} and _REPOSITORY_ with the name of the repository. ```shell {% ifversion fpt or ghec %} -$ git remote add origin https://github.com/USER/REPOSITORY.git +$ git remote add origin https://github.com/USER/REPOSITORY.git {% else %} -$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git +$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git {% endif %} ``` 1. Push the repository to {% data variables.product.product_name %}, replacing _BRANCH_ with the name of the branch you're working on. ```shell - $ git push -u origin BRANCH + $ git push -u origin BRANCH ``` {% data reusables.pages.configure-publishing-source %} {% data reusables.pages.navigate-site-repo %} diff --git a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md index 46fd83c6c2ea..10630f1a54c7 100644 --- a/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md +++ b/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts.md @@ -30,7 +30,7 @@ To resolve a merge conflict, you must manually edit the conflicted file to selec If you have a merge conflict on the command line, you cannot push your local changes to {% data variables.product.product_name %} until you resolve the merge conflict locally on your computer. If you try merging branches on the command line that have a merge conflict, you'll get an error message. For more information, see "[Resolving a merge conflict using the command line](/articles/resolving-a-merge-conflict-using-the-command-line/)." ```shell -$ git merge BRANCH-NAME +$ git merge BRANCH-NAME > Auto-merging styleguide.md > CONFLICT (content): Merge conflict in styleguide.md > Automatic merge failed; fix conflicts and then commit the result 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 cb7b730366bb..a53dcfa122db 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 @@ -33,7 +33,7 @@ For example, if you and another person both edited the file _styleguide.md_ on t {% data reusables.command_line.open_the_multi_os_terminal %} 2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` 3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell @@ -85,7 +85,7 @@ For example, if you edited a file, such as *README.md*, and another person remov {% data reusables.command_line.open_the_multi_os_terminal %} 2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` 2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index ca86371e9b61..a137dad617f8 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -83,7 +83,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u To merge a pull request, use the `gh pr merge` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr merge pull-request +gh pr merge PULL-REQUEST ``` Follow the interactive prompts to complete the merge. For more information about the merge methods that you can choose, see "[About pull request merges](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md index 6dc332b6d9f6..0480d3a39cd5 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/committing-changes-to-a-pull-request-branch-created-from-a-fork.md @@ -43,11 +43,11 @@ Only the user who created the pull request can give you permission to push commi ``` 5. Type `git clone`, and then paste the URL you copied in Step 3. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY ``` 6. Press **Enter**. Your local clone will be created. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY > Cloning into `FORK-OF-THE-REPOSITORY`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. @@ -61,13 +61,13 @@ Only the user who created the pull request can give you permission to push commi {% endtip %} 7. Navigate into your new cloned repository. ```shell - $ cd FORK-OF-THE-REPOSITORY + $ cd FORK-OF-THE-REPOSITORY ``` 7. Switch branches to the compare branch of the pull request where the original changes were made. If you navigate to the original pull request, you'll see the compare branch at the top of the pull request. ![compare-branch-example](/assets/images/help/pull_requests/compare-branch-example.png) In this example, the compare branch is `test-branch`: ```shell - $ git checkout test-branch + $ git checkout TEST-BRANCH ``` {% tip %} @@ -84,8 +84,8 @@ Only the user who created the pull request can give you permission to push commi > Compressing objects: 100% (26/26), done. > Writing objects: 100% (29/29), 74.94 KiB | 0 bytes/s, done. > Total 29 (delta 8), reused 0 (delta 0) - > To https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY.git - > 12da2e9..250e946 test-branch -> test-branch + > To https://{% data variables.command_line.codeblock %}/USERNAME/FORK-OF-THE-REPOSITORY.git + > 12da2e9..250e946 TEST-BRANCH -> TEST-BRANCH ``` Your new commits will be reflected on the original pull request on {% data variables.product.product_location %}. diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md index cbfc7e4cabf8..07402829589f 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally.md @@ -44,7 +44,7 @@ shortTitle: Check out a PR locally To check out a pull request locally, use the `gh pr checkout` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr checkout pull-request +gh pr checkout PULL-REQUEST ``` {% endcli %} @@ -64,24 +64,24 @@ Anyone can work with a previously opened pull request to continue working on it, {% data reusables.command_line.open_the_multi_os_terminal %} 5. Fetch the reference to the pull request based on its ID number, creating a new branch in the process. ```shell - $ git fetch origin pull/ID/head:BRANCHNAME + $ git fetch origin pull/ID/head:BRANCH_NAME ``` 6. Switch to the new branch that's based on this pull request: ```shell - [main] $ git checkout BRANCHNAME - > Switched to a new branch 'BRANCHNAME' + [main] $ git checkout BRANCH_NAME + > Switched to a new branch 'BRANCH_NAME' ``` 7. At this point, you can do anything you want with this branch. You can run some local tests, or merge other branches into the branch. 8. When you're ready, you can push the new branch up: ```shell - [pull-inactive-pull-request] $ git push origin BRANCHNAME + [pull-inactive-pull-request] $ git push origin BRANCH_NAME > Counting objects: 32, done. > Delta compression using up to 8 threads. > Compressing objects: 100% (26/26), done. > Writing objects: 100% (29/29), 74.94 KiB | 0 bytes/s, done. > Total 29 (delta 8), reused 0 (delta 0) - > To https://{% data variables.command_line.codeblock %}/username/repository.git - > * [new branch] BRANCHNAME -> BRANCHNAME + > To https://{% data variables.command_line.codeblock %}/USERNAME/REPOSITORY.git + > * [new branch] BRANCH_NAME -> BRANCH_NAME ``` 9. [Create a new pull request](/articles/creating-a-pull-request) with your new branch. @@ -90,7 +90,7 @@ Anyone can work with a previously opened pull request to continue working on it, The remote `refs/pull/` namespace is *read-only*. If you try to push any commits there, you'll see this error: ```shell ! [remote rejected] HEAD -> refs/pull/1/head (deny updating a hidden ref) -error: failed to push some refs to 'git@github.local:USERNAME/REPOSITORY.git' +error: failed to push some refs to 'git@github.local:USERNAME/REPOSITORY.git' ``` {% tip %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md index 38e4a7e7d465..00882c58ed63 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-for-a-fork.md @@ -19,18 +19,18 @@ shortTitle: Configure a remote 2. List the current configured remote repository for your fork. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) ``` 3. Specify a new remote *upstream* repository that will be synced with the fork. ```shell - $ git remote add upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git + $ git remote add upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git ``` 4. Verify the new upstream repository you've specified for your fork. ```shell $ git remote -v - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) - > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) - > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) - > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (fetch) + > origin https://{% data variables.command_line.codeblock %}/YOUR_USERNAME/YOUR_FORK.git (push) + > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (fetch) + > upstream https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY.git (push) ``` diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md index b1b70872ecf2..4916aeb3cd5c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/syncing-a-fork.md @@ -45,7 +45,7 @@ If the changes from the upstream repository cause conflicts, {% data variables.p To update the remote fork from its parent, use the `gh repo sync -b BRANCHNAME` subcommand and supply your fork and branch name as arguments. ```shell -$ gh repo sync owner/cli-fork -b BRANCHNAME +$ gh repo sync owner/cli-fork -b BRANCH_NAME ``` If the changes from the upstream repository cause conflict then the {% data variables.product.prodname_cli %} can't sync. You can set the `-force` flag to overwrite the destination branch. @@ -64,7 +64,7 @@ Before you can sync your fork with an upstream repository, you must [configure a > remote: Compressing objects: 100% (53/53), done. > remote: Total 62 (delta 27), reused 44 (delta 9) > Unpacking objects: 100% (62/62), done. - > From https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY + > From https://{% data variables.command_line.codeblock %}/ORIGINAL_OWNER/ORIGINAL_REPOSITORY > * [new branch] main -> upstream/main ``` diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md index 520fd34daac7..aade27112eda 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/changing-a-commit-message.md @@ -53,7 +53,7 @@ We strongly discourage force pushing, since this changes the history of your rep 1. Follow the [steps above](/articles/changing-a-commit-message#commit-has-not-been-pushed-online) to amend the commit message. 2. Use the `push --force-with-lease` command to force push over the old commit. ```shell - $ git push --force-with-lease origin example-branch + $ git push --force-with-lease origin EXAMPLE-BRANCH ``` **Changing the message of older or multiple commit messages** @@ -102,7 +102,7 @@ If you need to amend the message for multiple commits or an older commit, you ca 5. In each resulting commit file, type the new commit message, save the file, and close it. 6. When you're ready to push your changes to GitHub, use the push --force command to force push over the old commit. ```shell -$ git push --force origin example-branch +$ git push --force origin EXAMPLE-BRANCH ``` For more information on interactive rebase, see "[Interactive mode](https://git-scm.com/docs/git-rebase#_interactive_mode)" in the Git manual. diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md index a7082678b845..e25a47c84415 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-on-behalf-of-an-organization.md @@ -47,7 +47,7 @@ Organizations can use the `name@organization.com` email as a public point of con $ git commit -m "Refactor usability tests. > > - on-behalf-of: @org <name@organization.com>" + on-behalf-of: @ORG NAME@ORGANIZATION.COM" ``` The new commit, message, and badge will appear on {% data variables.product.product_location %} the next time you push. For more information, see "[Pushing changes to a remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)." diff --git a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md index 75eca09a6449..97444af18dba 100644 --- a/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md +++ b/content/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors.md @@ -61,8 +61,8 @@ You can use {% data variables.product.prodname_desktop %} to create a commit wit $ git commit -m "Refactor usability tests. > > - Co-authored-by: name <name@example.com> - Co-authored-by: another-name <another-name@example.com>" + Co-authored-by: NAME NAME@EXAMPLE.COM + Co-authored-by: AUTHOR-NAME ANOTHER-NAME@EXAMPLE.COM" ``` The new commit and message will appear on {% data variables.product.product_location %} the next time you push. For more information, see "[Pushing changes to a remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/)." diff --git a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md index 613caee543d2..24834a7df7b0 100644 --- a/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md +++ b/content/pull-requests/committing-changes-to-your-project/troubleshooting-commits/commit-exists-on-github-but-not-in-my-local-clone.md @@ -36,7 +36,7 @@ There are several possible explanations: Your local repository may not have the commit yet. To get information from your remote repository to your local clone, use `git fetch`: ```shell -$ git fetch remote +$ git fetch REMOTE ``` This safely copies information from the remote repository to your local clone without making any changes to the files you have checked out. diff --git a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md index 1abc2a6e8798..5ec69c89508a 100644 --- a/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md +++ b/content/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/renaming-a-branch.md @@ -41,9 +41,9 @@ After you rename a branch in a repository on {% data variables.product.product_n From the local clone of the repository on a computer, run the following commands to update the name of the default branch. ```shell -$ git branch -m OLD-BRANCH-NAME NEW-BRANCH-NAME +$ git branch -m OLD-BRANCH-NAME NEW-BRANCH-NAME $ git fetch origin -$ git branch -u origin/NEW-BRANCH-NAME NEW-BRANCH-NAME +$ git branch -u origin/NEW-BRANCH-NAME NEW-BRANCH-NAME $ git remote set-head origin -a ``` diff --git a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md index 0fb1ff7c560e..d5ff6f38b60d 100644 --- a/content/repositories/creating-and-managing-repositories/cloning-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/cloning-a-repository.md @@ -42,13 +42,13 @@ You can clone your existing repository or clone another person's existing reposi To clone a repository locally, use the `repo clone` subcommand. Replace the `repository` parameter with the repository name. For example, `octo-org/octo-repo`, `monalisa/octo-repo`, or `octo-repo`. If the `OWNER/` portion of the `OWNER/REPO` repository argument is omitted, it defaults to the name of the authenticating user. ```shell -gh repo clone repository +gh repo clone REPOSITORY ``` You can also use the GitHub URL to clone a repository. ```shell -gh repo clone https://github.com/cli/cli +gh repo clone https://github.com/PATH-TO/REPOSITORY ``` {% endcli %} diff --git a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md index 133488a738aa..ea41e0173465 100644 --- a/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/duplicating-a-repository.md @@ -31,17 +31,17 @@ Before you can push the original repository to your new copy, or _mirror_, of th {% data reusables.command_line.open_the_multi_os_terminal %} 2. Create a bare clone of the repository. ```shell - $ git clone --bare https://{% data variables.command_line.codeblock %}/exampleuser/old-repository.git + $ git clone --bare https://{% data variables.command_line.codeblock %}/OLD-REPOSITORY.git/OLD-REPOSITORY.git ``` 3. Mirror-push to the new repository. ```shell - $ cd old-repository.git - $ git push --mirror https://{% data variables.command_line.codeblock %}/exampleuser/new-repository.git + $ cd OLD-REPOSITORY.git + $ git push --mirror https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/NEW-REPOSITORY.git ``` 4. Remove the temporary local repository you created earlier. ```shell $ cd .. - $ rm -rf old-repository.git + $ rm -rf OLD-REPOSITORY.git ``` ## Mirroring a repository that contains {% data variables.large_files.product_name_long %} objects @@ -49,11 +49,11 @@ Before you can push the original repository to your new copy, or _mirror_, of th {% data reusables.command_line.open_the_multi_os_terminal %} 2. Create a bare clone of the repository. Replace the example username with the name of the person or organization who owns the repository, and replace the example repository name with the name of the repository you'd like to duplicate. ```shell - $ git clone --bare https://{% data variables.command_line.codeblock %}/exampleuser/old-repository.git + $ git clone --bare https://{% data variables.command_line.codeblock %}/OLD-REPOSITORY.git/OLD-REPOSITORY.git ``` 3. Navigate to the repository you just cloned. ```shell - $ cd old-repository.git + $ cd OLD-REPOSITORY.git ``` 4. Pull in the repository's {% data variables.large_files.product_name_long %} objects. ```shell @@ -61,16 +61,16 @@ Before you can push the original repository to your new copy, or _mirror_, of th ``` 5. Mirror-push to the new repository. ```shell - $ git push --mirror https://{% data variables.command_line.codeblock %}/exampleuser/new-repository.git + $ git push --mirror https://{% data variables.command_line.codeblock %}/OLD-REPOSITORY.git/NEW-REPOSITORY.git ``` 6. Push the repository's {% data variables.large_files.product_name_long %} objects to your mirror. ```shell - $ git lfs push --all https://github.com/exampleuser/new-repository.git + $ git lfs push --all https://github.com/EXAMPLE-USER/NEW-REPOSITORY.git ``` 7. Remove the temporary local repository you created earlier. ```shell $ cd .. - $ rm -rf old-repository.git + $ rm -rf OLD-REPOSITORY.git ``` ## Mirroring a repository in another location @@ -80,12 +80,12 @@ If you want to mirror a repository in another location, including getting update {% data reusables.command_line.open_the_multi_os_terminal %} 2. Create a bare mirrored clone of the repository. ```shell - $ git clone --mirror https://{% data variables.command_line.codeblock %}/exampleuser/repository-to-mirror.git + $ git clone --mirror https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/REPOSITORY-TO-MIRROR.git ``` 3. Set the push location to your mirror. ```shell - $ cd repository-to-mirror - $ git remote set-url --push origin https://{% data variables.command_line.codeblock %}/exampleuser/mirrored + $ cd REPOSITORY-TO-MIRROR + $ git remote set-url --push origin https://{% data variables.command_line.codeblock %}/EXAMPLE-USER/MIRRORED ``` As with a bare clone, a mirrored clone includes all remote branches and tags, but all local references will be overwritten each time you fetch, so it will always be the same as the original repository. Setting the URL for pushes simplifies pushing to your mirror. diff --git a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md index 7d86a30d4ddf..0d3f8b8abf3b 100644 --- a/content/repositories/creating-and-managing-repositories/renaming-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/renaming-a-repository.md @@ -25,7 +25,7 @@ For more information on project sites, see "[About {% data variables.product.pro In addition to redirecting web traffic, all `git clone`, `git fetch`, or `git push` operations targeting the previous location will continue to function as if made on the new location. However, to reduce confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell -$ git remote set-url origin new_url +$ git remote set-url origin NEW_URL ``` For more information, see "[Managing remote repositories](/github/getting-started-with-github/managing-remote-repositories)." diff --git a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md index 74666a44c850..f005ae776ddf 100644 --- a/content/repositories/creating-and-managing-repositories/transferring-a-repository.md +++ b/content/repositories/creating-and-managing-repositories/transferring-a-repository.md @@ -48,7 +48,7 @@ When you transfer a repository, its issues, pull requests, wiki, stars, and watc - All links to the previous repository location are automatically redirected to the new location. When you use `git clone`, `git fetch`, or `git push` on a transferred repository, these commands will redirect to the new repository location or URL. However, to avoid confusion, we strongly recommend updating any existing local clones to point to the new repository URL. You can do this by using `git remote` on the command line: ```shell - $ git remote set-url origin new_url + $ git remote set-url origin NEW_URL ``` - When you transfer a repository from an organization to a personal account, the repository's read-only collaborators will not be transferred. This is because collaborators can't have read-only access to repositories owned by a personal account. For more information about repository permission levels, see "[Permission levels for a personal account repository](/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository)" and "[Repository roles for an organization](/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization)."{% ifversion fpt or ghec %} diff --git a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md index 4f8d39702e80..9d85d13f7fda 100644 --- a/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md +++ b/content/repositories/creating-and-managing-repositories/troubleshooting-cloning-errors.md @@ -29,18 +29,18 @@ Here's an example of an HTTPS error you might receive: ```shell > error: The requested URL returned error: 401 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs?service=git-receive-pack +> https://{% data variables.command_line.codeblock %}/USER/REPO.git/info/refs?service=git-receive-pack > fatal: HTTP request failed ``` ```shell > Error: The requested URL returned error: 403 while accessing -> https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs +> https://{% data variables.command_line.codeblock %}/USER/REPO.git/info/refs > fatal: HTTP request failed ``` ```shell -> Error: https://{% data variables.command_line.codeblock %}/user/repo.git/info/refs not found: did you run git +> Error: https://{% data variables.command_line.codeblock %}/USER/REPO.git/info/refs not found: did you run git > update-server-info on the server? ``` @@ -124,7 +124,7 @@ the following into the command line: ```shell $ ssh -T git@{% data variables.command_line.codeblock %} -> Hi username! You've successfully authenticated, but GitHub does not +> Hi USERNAME! You've successfully authenticated, but GitHub does not > provide shell access. ``` @@ -152,7 +152,7 @@ This error occurs if the default branch of a repository has been deleted on {% d Detecting this error is simple; Git will warn you when you try to clone the repository: ```shell -$ git clone https://{% data variables.command_line.codeblock %}/user/repo.git +$ git clone https://{% data variables.command_line.codeblock %}/USER/REPO.git # Clone a repo > Cloning into 'repo'... > remote: Counting objects: 66179, done. diff --git a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index 75f9b9672317..2805786381d2 100644 --- a/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -90,7 +90,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da 1. To create a release, use the `gh release create` subcommand. Replace `tag` with the desired tag for the release. ```shell - gh release create tag + gh release create TAG ``` 2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. @@ -153,7 +153,7 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli 1. To delete a release, use the `gh release delete` subcommand. Replace `tag` with the tag of the release to delete. Use the `-y` flag to skip confirmation. ```shell - gh release delete tag -y + gh release delete TAG -y ``` {% endcli %} diff --git a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md index fc6581d18423..8f0f3eca5c43 100644 --- a/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md +++ b/content/repositories/working-with-files/managing-files/moving-a-file-to-a-new-location.md @@ -55,17 +55,17 @@ Many files can be [moved directly on {% data variables.product.product_name %}]( 3. Use `git status` to check the old and new file locations. ```shell $ git status - > # On branch your-branch + > # On branch YOUR-BRANCH > # Changes not staged for commit: > # (use "git add/rm ..." to update what will be committed) > # (use "git checkout -- ..." to discard changes in working directory) > # - > # deleted: /old-folder/image.png + > # deleted: /OLD-FOLDER/IMAGE.PNG > # > # Untracked files: > # (use "git add ..." to include in what will be committed) > # - > # /new-folder/image.png + > # /NEW-FOLDER/IMAGE.PNG > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` @@ -78,7 +78,7 @@ Many files can be [moved directly on {% data variables.product.product_name %}]( 5. Use `git status` to check the changes staged for commit. ```shell $ git status - > # On branch your-branch + > # On branch YOUR-BRANCH > # Changes to be committed: > # (use "git reset HEAD ..." to unstage) > # diff --git a/content/repositories/working-with-files/managing-files/renaming-a-file.md b/content/repositories/working-with-files/managing-files/renaming-a-file.md index 66bf319c27c2..03b7e8130fbf 100644 --- a/content/repositories/working-with-files/managing-files/renaming-a-file.md +++ b/content/repositories/working-with-files/managing-files/renaming-a-file.md @@ -52,16 +52,16 @@ Many files can be [renamed directly on {% data variables.product.product_name %} {% data reusables.command_line.switching_directories_procedural %} 3. Rename the file, specifying the old file name and the new name you'd like to give the file. This will stage your change for commit. ```shell - $ git mv old_filename new_filename + $ git mv OLD-FILENAME NEW-FILENAME ``` 4. Use `git status` to check the old and new file names. ```shell $ git status - > # On branch your-branch + > # On branch YOUR-BRANCH > # Changes to be committed: > # (use "git reset HEAD ..." to unstage) > # - > # renamed: old_filename -> new_filename + > # renamed: OLD-FILENAME -> NEW-FILENAME > # ``` {% data reusables.git.commit-file %} diff --git a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md index 7436a77b2858..f78ecc725039 100644 --- a/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md +++ b/content/repositories/working-with-files/managing-large-files/about-large-files-on-github.md @@ -74,7 +74,7 @@ If the file was added with your most recent commit, and you have not pushed to { {% data reusables.command_line.switching_directories_procedural %} 3. To remove the file, enter `git rm --cached`: ```shell - $ git rm --cached giant_file + $ git rm --cached GIANT_FILE # Stage our giant file for removal, but leave it on disk ``` 4. Commit this change using `--amend -CHEAD`: diff --git a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md index 744ea932b551..91b7f2d94865 100644 --- a/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/installing-git-large-file-storage.md @@ -25,7 +25,7 @@ shortTitle: Install Git LFS {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory into the folder you downloaded and unzipped. ```shell - $ cd ~/Downloads/git-lfs-1.X.X + $ cd ~/Downloads/git-lfs-1.X.X ``` {% note %} @@ -85,7 +85,7 @@ shortTitle: Install Git LFS {% data reusables.command_line.open_the_multi_os_terminal %} 3. Change the current working directory into the folder you downloaded and unzipped. ```shell - $ cd ~/Downloads/git-lfs-1.X.X + $ cd ~/Downloads/git-lfs-1.X.X ``` {% note %} diff --git a/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 2621f90997af..229230ac9802 100644 --- a/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -340,7 +340,7 @@ To view a fully interactive version of your Jupyter Notebook, you can set up a n If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): ```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb ``` ### Further reading diff --git a/content/rest/enterprise-admin/index.md b/content/rest/enterprise-admin/index.md index 4221451d7aef..3350cf559db8 100644 --- a/content/rest/enterprise-admin/index.md +++ b/content/rest/enterprise-admin/index.md @@ -59,7 +59,7 @@ When endpoints include `{enterprise}`, replace `{enterprise}` with the handle fo [Management Console](#management-console) API endpoints are only prefixed with a hostname: ```shell -http(s)://hostname/ +http(s)://HOSTNAME/ ``` {% endif %} {% ifversion ghae or ghes %} diff --git a/content/rest/enterprise-admin/management-console.md b/content/rest/enterprise-admin/management-console.md index 83bb465f04ec..961fc9d74a6d 100644 --- a/content/rest/enterprise-admin/management-console.md +++ b/content/rest/enterprise-admin/management-console.md @@ -25,11 +25,11 @@ You need to pass your [Management Console password](/enterprise/admin/articles/a Use the `api_key` parameter to send this token with each request. For example: ```shell -$ curl -L 'https://hostname:admin_port/setup/api?api_key=your-amazing-password' +$ curl -L 'https://HOSTNAME:ADMIN-PORT/setup/api?api_key=YOUR_PASSWORD' ``` You can also use standard HTTP authentication to send this token. For example: ```shell -$ curl -L -u "api_key:your-amazing-password" 'https://hostname:admin_port/setup/api' +$ curl -L -u "api_key:YOUR_PASSWORD" 'https://HOSTNAME:ADMIN-PORT/setup/api' ``` diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index 083950084df8..a744b76793e0 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -163,7 +163,7 @@ With cURL, you will send an `Authorization` header with your token. Replace `YOU ```shell curl --request GET \ --url "https://api.github.com/octocat" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% note %} @@ -326,7 +326,7 @@ To send a header with cURL, use the `--header` or `-H` flag followed by the head curl --request GET \ --url "https://api.github.com/octocat" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -390,7 +390,7 @@ To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -443,7 +443,7 @@ For cURL, add a `?` to the end of the path, then append your query parameter nam curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -495,7 +495,7 @@ For cURL, use the `--data` flag to pass the body parameters in a JSON object. curl --request POST \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --data '{ "title": "Created with the REST API", "body": "This is a test issue created by the REST API" @@ -593,7 +593,7 @@ For example, this request: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --include ``` @@ -661,7 +661,7 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -730,7 +730,7 @@ For example, you can use `>` to redirect the response to a file: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" > data.json +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` Then you can use jq to get the title and author ID of each issue: diff --git a/content/rest/overview/other-authentication-methods.md b/content/rest/overview/other-authentication-methods.md index d8147fdb5d4f..9cebcf591a3f 100644 --- a/content/rest/overview/other-authentication-methods.md +++ b/content/rest/overview/other-authentication-methods.md @@ -45,7 +45,7 @@ response. The solution is to manually craft the `Authorization` header. We recommend you use OAuth tokens to authenticate to the GitHub API. OAuth tokens include [personal access tokens][personal-access-tokens] and enable the user to revoke access at any time. ```shell -$ curl -u username:token {% data variables.product.api_url_pre %}/user +$ curl -u USERNAME:TOKEN {% data variables.product.api_url_pre %}/user ``` This approach is useful if your tools only support Basic Authentication but you want to take advantage of OAuth access token security features. @@ -71,7 +71,7 @@ would authenticate you if you replace `` with your {% data variables.p (cURL will prompt you to enter the password.) ```shell -$ curl -u username {% data variables.product.api_url_pre %}/user +$ curl -u USERNAME {% data variables.product.api_url_pre %}/user ``` If you have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). @@ -95,7 +95,7 @@ If you have two-factor authentication enabled, make sure you understand how to [ If you're using the API to access an organization that enforces [SAML SSO][saml-sso] for authentication, you'll need to create a personal access token (PAT) and [authorize the token][allowlist] for that organization. Visit the URL specified in `X-GitHub-SSO` to authorize the token for the organization. ```shell -$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -107,7 +107,7 @@ $ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.ap When requesting data that could come from multiple organizations (for example, [requesting a list of issues created by the user][user-issues]), the `X-GitHub-SSO` header indicates which organizations require you to authorize your personal access token: ```shell -$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` @@ -136,9 +136,9 @@ This header tells you how your account receives its two-factor authentication co ```shell $ curl --request POST \ --url https://api.github.com/authorizations \ - --header 'authorization: Basic PASSWORD' \ + --header 'authorization: Basic PASSWORD' \ --header 'content-type: application/json' \ - --header 'x-github-otp: OTP' \ + --header 'x-github-otp: OTP' \ --data '{"scopes": ["public_repo"], "note": "test"}' ``` {% endif %} diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index 033f0ccd7897..0432d216c945 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -91,7 +91,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### OAuth2 token (sent in a header) ```shell -$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -150,7 +150,7 @@ the API will temporarily reject all authentication attempts for that user ```shell $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae or ghec %} --u valid_username:valid_token {% endif %}{% ifversion ghes %}-u valid_username:valid_password {% endif %} +-u VALID_USERNAME:VALID_TOKEN {% endif %}{% ifversion ghes %}-u VALID_USERNAME:VALID_PASSWORD {% endif %} > HTTP/2 403 > { > "message": "Maximum number of login attempts exceeded. Please try again later.", @@ -185,7 +185,7 @@ You can issue a `GET` request to the root endpoint to get all the endpoint categ ```shell $ curl {% ifversion fpt or ghae or ghec %} --u username:token {% endif %}{% ifversion ghes %}-u username:password {% endif %}{% data variables.product.api_url_pre %} +-u USERNAME:TOKEN {% endif %}{% ifversion ghes %}-u USERNAME:PASSWORD {% endif %}{% data variables.product.api_url_pre %} ``` ## GraphQL global node IDs diff --git a/content/rest/quickstart.md b/content/rest/quickstart.md index 7c56fcf40206..e70d6f227258 100644 --- a/content/rest/quickstart.md +++ b/content/rest/quickstart.md @@ -279,7 +279,7 @@ jobs: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ - --header "Authorization: Bearer YOUR-TOKEN" + --header "Authorization: Bearer YOUR-TOKEN" ``` {% note %} diff --git a/content/support/contacting-github-support/providing-data-to-github-support.md b/content/support/contacting-github-support/providing-data-to-github-support.md index c2966bf474d4..7e3c1432ec04 100644 --- a/content/support/contacting-github-support/providing-data-to-github-support.md +++ b/content/support/contacting-github-support/providing-data-to-github-support.md @@ -71,7 +71,7 @@ You can use this method without signing into the {% data variables.enterprise.ma Use the [ghe-diagnostics](/enterprise/admin/guides/installation/command-line-utilities#ghe-diagnostics) command-line utility to retrieve the diagnostics for your instance. ```shell -$ ssh -p122 admin@hostname -- 'ghe-diagnostics' > diagnostics.txt +$ ssh -p122 admin@HOSTNAME -- 'ghe-diagnostics' > diagnostics.txt ``` ## Creating and sharing support bundles @@ -119,7 +119,7 @@ You can use these steps to create and share a support bundle if you have SSH acc 1. Download the support bundle via SSH: ```shell - $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o' > support-bundle.tgz + $ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o' > support-bundle.tgz ``` For more information about the `ghe-support-bundle` command, see "[Command-line utilities](/enterprise/admin/guides/installation/command-line-utilities#ghe-support-bundle)". {% data reusables.enterprise_enterprise_support.sign-in-to-support %} @@ -147,7 +147,7 @@ You can directly upload a support bundle to our server if: 1. Upload the bundle to our support bundle server: ```shell - $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u' + $ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u' ``` ## Creating and sharing extended support bundles @@ -162,7 +162,7 @@ You can use these steps to create and share an extended support bundle if you ha 1. Download the extended support bundle via SSH by adding the `-x` flag to the `ghe-support-bundle` command: ```shell - $ ssh -p 122 admin@hostname -- 'ghe-support-bundle -o -x' > support-bundle.tgz + $ ssh -p 122 admin@HOSTNAME -- 'ghe-support-bundle -o -x' > support-bundle.tgz ``` {% data reusables.enterprise_enterprise_support.sign-in-to-support %} {% data reusables.enterprise_enterprise_support.upload-support-bundle %} @@ -175,7 +175,7 @@ You can directly upload a support bundle to our server if: 1. Upload the bundle to our support bundle server: ```shell - $ ssh -p122 admin@hostname -- 'ghe-support-bundle -u -x' + $ ssh -p122 admin@HOSTNAME -- 'ghe-support-bundle -u -x' ``` ## Further reading diff --git a/data/reusables/actions/self-hosted-runner-check-mac-linux.md b/data/reusables/actions/self-hosted-runner-check-mac-linux.md index 34fab292bc70..ca32cd3f4a90 100644 --- a/data/reusables/actions/self-hosted-runner-check-mac-linux.md +++ b/data/reusables/actions/self-hosted-runner-check-mac-linux.md @@ -1,3 +1,3 @@ ```shell -./run.sh --check --url https://github.com/octo-org/octo-repo --pat ghp_abcd1234 -``` +./run.sh --check --url URL --pat ghp_abcd1234 +``` \ No newline at end of file diff --git a/data/reusables/command_line/git-clone-url.md b/data/reusables/command_line/git-clone-url.md index 0ed7dd68150d..7f2210364a51 100644 --- a/data/reusables/command_line/git-clone-url.md +++ b/data/reusables/command_line/git-clone-url.md @@ -1,4 +1,4 @@ 5. Type `git clone`, and then paste the URL you copied earlier. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY ``` diff --git a/data/reusables/command_line/local-clone-created.md b/data/reusables/command_line/local-clone-created.md index 1fa36e19641b..de216eff20df 100644 --- a/data/reusables/command_line/local-clone-created.md +++ b/data/reusables/command_line/local-clone-created.md @@ -1,6 +1,6 @@ 6. Press **Enter** to create your local clone. ```shell - $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY + $ git clone https://{% data variables.command_line.codeblock %}/YOUR-USERNAME/YOUR-REPOSITORY > Cloning into `Spoon-Knife`... > remote: Counting objects: 10, done. > remote: Compressing objects: 100% (8/8), done. diff --git a/data/reusables/command_line/providing-token-as-password.md b/data/reusables/command_line/providing-token-as-password.md index a938fcfd9ca3..44e5a96cae83 100644 --- a/data/reusables/command_line/providing-token-as-password.md +++ b/data/reusables/command_line/providing-token-as-password.md @@ -3,7 +3,7 @@ Once you have a token, you can enter it instead of your password when performing For example, on the command line you would enter the following: ```shell -$ git clone https://{% data variables.command_line.codeblock %}/username/repo.git -Username: your_username -Password: your_token +$ git clone https://{% data variables.command_line.codeblock %}/USERNAME/REPO.git +Username: YOUR_USERNAME +Password: YOUR_TOKEN ``` diff --git a/data/reusables/enterprise_installation/command-line-utilities-ghe-upgrade-rollback.md b/data/reusables/enterprise_installation/command-line-utilities-ghe-upgrade-rollback.md index 8d44dbb7277b..3465598ef896 100644 --- a/data/reusables/enterprise_installation/command-line-utilities-ghe-upgrade-rollback.md +++ b/data/reusables/enterprise_installation/command-line-utilities-ghe-upgrade-rollback.md @@ -1,7 +1,7 @@ When rolling back an upgrade, you must use an upgrade package file with the *.pkg* extension. Hotpatch package files with the *.hpkg* extension are not supported. ```shell -ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg +ghe-upgrade --allow-patch-rollback EARLIER-RELEASE-UPGRADE-PACKAGE.pkg ``` A reboot is required after running the command. Rolling back does not affect the data partition, as migrations are not run on patch releases. diff --git a/data/reusables/enterprise_installation/configuration-recognized.md b/data/reusables/enterprise_installation/configuration-recognized.md index 60d20391dc60..4cb2268a4985 100644 --- a/data/reusables/enterprise_installation/configuration-recognized.md +++ b/data/reusables/enterprise_installation/configuration-recognized.md @@ -1,5 +1,5 @@ 1. Once the instance has fully restarted and you can reach it, use the SSH administrative shell to verify that the new resource configuration is recognized: ```shell -$ ssh -p 122 admin@HOSTNAME +$ ssh -p 122 admin@HOSTNAME $ ghe-system-info ``` diff --git a/data/reusables/enterprise_installation/download-package.md b/data/reusables/enterprise_installation/download-package.md index 6cc7a602ff50..e051e1cc9e3b 100644 --- a/data/reusables/enterprise_installation/download-package.md +++ b/data/reusables/enterprise_installation/download-package.md @@ -1,4 +1,4 @@ 1. Download the upgrade package to {% data variables.product.product_location %} using `curl `: ```shell -admin@HOSTNAME:~$ curl -L -O UPGRADE-PKG-URL +admin@HOSTNAME:~$ curl -L -O UPGRADE-PKG-URL ``` diff --git a/data/reusables/enterprise_installation/generate-replication-key-pair.md b/data/reusables/enterprise_installation/generate-replication-key-pair.md index 7f7056e59a9d..66c04ee3eda8 100644 --- a/data/reusables/enterprise_installation/generate-replication-key-pair.md +++ b/data/reusables/enterprise_installation/generate-replication-key-pair.md @@ -1,4 +1,4 @@ 7. To generate a key pair for replication, use the `ghe-repl-setup` command with the primary appliance's IP address and copy the public key that it returns. ```shell - $ ghe-repl-setup PRIMARY IP + $ ghe-repl-setup PRIMARY_IP ``` diff --git a/data/reusables/enterprise_installation/replica-ssh.md b/data/reusables/enterprise_installation/replica-ssh.md index 3a2810863002..b2c22e490550 100644 --- a/data/reusables/enterprise_installation/replica-ssh.md +++ b/data/reusables/enterprise_installation/replica-ssh.md @@ -1,4 +1,4 @@ 1. Connect to the replica instance over SSH as the "admin" user on port 122: ```shell -$ ssh -p 122 admin@replica-host +$ ssh -p 122 admin@REPLICA_HOST ``` diff --git a/data/reusables/enterprise_installation/ssh-into-instance.md b/data/reusables/enterprise_installation/ssh-into-instance.md index 01094fb67b70..cd5b8ce2cd7a 100644 --- a/data/reusables/enterprise_installation/ssh-into-instance.md +++ b/data/reusables/enterprise_installation/ssh-into-instance.md @@ -1,5 +1,5 @@ 1. SSH into {% data variables.product.product_location %}. If your instance comprises multiple nodes, for example if high availability or geo-replication are configured, SSH into the primary node. If you use a cluster, you can SSH into any node. For more information about SSH access, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)." ```shell - $ ssh -p 122 admin@HOSTNAME + $ ssh -p 122 admin@HOSTNAME ``` diff --git a/data/reusables/enterprise_installation/ssh-into-target-instance.md b/data/reusables/enterprise_installation/ssh-into-target-instance.md index 9c6a2495d5c6..a249949cdf82 100644 --- a/data/reusables/enterprise_installation/ssh-into-target-instance.md +++ b/data/reusables/enterprise_installation/ssh-into-target-instance.md @@ -1,4 +1,4 @@ 1. As a site admin, [SSH into your target {% data variables.product.prodname_ghe_server %} instance](/enterprise/admin/guides/installation/accessing-the-administrative-shell-ssh/). ```shell -$ ssh -p 122 admin@HOSTNAME +$ ssh -p 122 admin@HOSTNAME ``` diff --git a/data/reusables/enterprise_migrations/unlocking-on-instances.md b/data/reusables/enterprise_migrations/unlocking-on-instances.md index 67495e72279d..29f0034a47e4 100644 --- a/data/reusables/enterprise_migrations/unlocking-on-instances.md +++ b/data/reusables/enterprise_migrations/unlocking-on-instances.md @@ -1,5 +1,5 @@ 1. Unlock all the imported repositories with the `ghe-migrator unlock` command. You'll need your Migration GUID: ```shell -$ ghe-migrator unlock -g MIGRATION_GUID +$ ghe-migrator unlock -g MIGRATION-GUID > Unlocked octo-org/octo-project ``` diff --git a/data/reusables/git/git-push.md b/data/reusables/git/git-push.md index 2e99b1f21b5c..850aca63b90b 100644 --- a/data/reusables/git/git-push.md +++ b/data/reusables/git/git-push.md @@ -1,5 +1,5 @@ 1. [Push the changes](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) in your local repository to {% data variables.product.product_location %}. ```shell - $ git push origin your-branch + $ git push origin YOUR_BRANCH # Pushes the changes in your local repository up to the remote repository you specified as the origin ``` diff --git a/data/reusables/gpg/paste-gpg-key-id.md b/data/reusables/gpg/paste-gpg-key-id.md index e0bb894d013f..d75e15cb2edc 100644 --- a/data/reusables/gpg/paste-gpg-key-id.md +++ b/data/reusables/gpg/paste-gpg-key-id.md @@ -1,9 +1,9 @@ 1. To set your primary GPG signing key in Git, paste the text below, substituting in the GPG primary key ID you'd like to use. In this example, the GPG key ID is `3AA5C34371567BD2`: ```shell - $ git config --global user.signingkey 3AA5C34371567BD2 + $ git config --global user.signingkey 3AA5C34371567BD2 ``` Alternatively, when setting a subkey include the `!` suffix. In this example, the GPG subkey ID is `4BB6D45482678BE3`: ```shell - $ git config --global user.signingkey 4BB6D45482678BE3! + $ git config --global user.signingkey 4BB6D45482678BE3! ``` diff --git a/data/reusables/gpg/x-509-key.md b/data/reusables/gpg/x-509-key.md index a303466a11bd..26e14aa4024b 100644 --- a/data/reusables/gpg/x-509-key.md +++ b/data/reusables/gpg/x-509-key.md @@ -15,7 +15,7 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and ``` - To use S/MIME to sign for a single repository: ```shell - $ cd /path/to/my/repository + $ cd PATH-TO-REPOSITORY $ git config --local gpg.x509.program smimesign $ git config --local gpg.format x509 ``` @@ -26,7 +26,7 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and ``` - To use S/MIME to sign for a single repository: ```shell - $ cd /path/to/my/repository + $ cd PATH-TO-REPOSITORY $ git config --local gpg.program smimesign ``` If you're using an X.509 key that matches your committer identity, you can begin signing commits and tags. @@ -48,10 +48,10 @@ You can use [smimesign](https://github.com/github/smimesign) to sign commits and 6. To set your X.509 signing key in Git, paste the text below, substituting in the certificate ID you copied earlier. - To use your X.509 key to sign for all repositories: ```shell - $ git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f + $ git config --global user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f ``` - To use your X.509 key to sign for a single repository: ```shell - $ cd /path/to/my/repository - $ git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f + $ cd PATH-TO-REPOSITORY + $ git config --local user.signingkey 0ff455a2708394633e4bb2f88002e3cd80cbd76f ``` diff --git a/data/reusables/package_registry/create-npmrc-owner-step.md b/data/reusables/package_registry/create-npmrc-owner-step.md index af4ee63bcd6f..2d49a24d9cfb 100644 --- a/data/reusables/package_registry/create-npmrc-owner-step.md +++ b/data/reusables/package_registry/create-npmrc-owner-step.md @@ -2,15 +2,15 @@ {% ifversion fpt or ghec %} ```shell - @OWNER:registry=https://npm.pkg.github.com + @OWNER:registry=https://npm.pkg.github.com ``` {% else %} If subdomain isolation is enabled: ```shell - @OWNER:registry=https://npm.HOSTNAME + @OWNER:registry=https://npm.HOSTNAME ``` If subdomain isolation is disabled: ```shell - @OWNER:registry=https://HOSTNAME/_registry/npm + @OWNER:registry=https://HOSTNAME/_registry/npm ``` {% endif %} diff --git a/data/reusables/pages/remove-submodule.md b/data/reusables/pages/remove-submodule.md index 4e1201dcd4e6..63c2baba8b76 100644 --- a/data/reusables/pages/remove-submodule.md +++ b/data/reusables/pages/remove-submodule.md @@ -1,9 +1,9 @@ To troubleshoot, first decide if you actually want to use a submodule, which is a Git project inside a Git project; submodules are sometimes created accidentally. -If you don't want to use a submodule, remove the submodule, replacing PATH-TO-SUBMODULE with the path to the submodule: +If you don't want to use a submodule, remove the submodule, replacing PATH-TO-SUBMODULE with the path to the submodule: ```shell -$ git submodule deinit PATH-TO-SUBMODULE -$ git rm PATH-TO-SUBMODULE +$ git submodule deinit PATH-TO-SUBMODULE +$ git rm PATH-TO-SUBMODULE $ git commit -m "Remove submodule" -$ rm -rf .git/modules/PATH-TO-SUBMODULE +$ rm -rf .git/modules/PATH-TO-SUBMODULE ``` diff --git a/translations/log/msft-pt-resets.csv b/translations/log/msft-pt-resets.csv index 0def37c8cf69..33b394e90ee3 100644 --- a/translations/log/msft-pt-resets.csv +++ b/translations/log/msft-pt-resets.csv @@ -176,6 +176,7 @@ translations/pt-BR/content/site-policy/github-terms/github-community-forum-code- translations/pt-BR/content/sponsors/receiving-sponsorships-through-github-sponsors/setting-up-github-sponsors-for-your-user-account.md,file deleted because it no longer exists in main translations/pt-BR/data/glossaries/internal.yml,file deleted because it no longer exists in main translations/pt-BR/data/graphql/ghes-3.1/graphql_previews.enterprise.yml,file deleted because it no longer exists in main +translations/pt-BR/data/reusables/actions/link-to-example-library.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-configure-runner-group.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/actions/self-hosted-runner-groups-navigate-to-repo-org-enterprise.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/billing/per-user-pricing-reference.md,file deleted because it no longer exists in main @@ -234,8 +235,10 @@ translations/pt-BR/data/reusables/rest-reference/webhooks/repos.md,file deleted translations/pt-BR/data/reusables/security-center/beta.md,file deleted because it no longer exists in main translations/pt-BR/data/reusables/server-statistics/release-phase.md,file deleted because it no longer exists in main translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions.md,rendering error +translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md,broken liquid tags translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md,rendering error translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/about-your-organizations-profile.md,rendering error +translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md,broken liquid tags translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/setting-your-profile-to-private.md,broken liquid tags translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md,broken liquid tags translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-access-to-your-personal-repositories/inviting-collaborators-to-a-personal-repository.md,rendering error @@ -292,7 +295,7 @@ translations/pt-BR/content/admin/configuration/configuring-your-enterprise/confi translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md,rendering error translations/pt-BR/content/admin/configuration/configuring-your-enterprise/restricting-network-traffic-to-your-enterprise.md,broken liquid tags translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md,broken liquid tags -translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,broken liquid tags +translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md,rendering error translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/about-github-actions-for-enterprises.md,rendering error translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/getting-started-with-self-hosted-runners-for-your-enterprise.md,rendering error translations/pt-BR/content/admin/github-actions/getting-started-with-github-actions-for-your-enterprise/introducing-github-actions-to-your-enterprise.md,rendering error @@ -345,6 +348,7 @@ translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scannin translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md,rendering error translations/pt-BR/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/installing-codeql-cli-in-your-ci-system.md,broken liquid tags translations/pt-BR/content/code-security/dependabot/dependabot-alerts/browsing-security-advisories-in-the-github-advisory-database.md,rendering error +translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md,broken liquid tags translations/pt-BR/content/code-security/dependabot/dependabot-alerts/editing-security-advisories-in-the-github-advisory-database.md,broken liquid tags translations/pt-BR/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md,rendering error translations/pt-BR/content/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates.md,rendering error @@ -421,25 +425,33 @@ translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-prebuilds. translations/pt-BR/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md,broken liquid tags translations/pt-BR/content/codespaces/troubleshooting/working-with-support-for-github-codespaces.md,broken liquid tags translations/pt-BR/content/communities/documenting-your-project-with-wikis/editing-wiki-content.md,rendering error +translations/pt-BR/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md,broken liquid tags translations/pt-BR/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-a-jetbrains-ide.md,broken liquid tags translations/pt-BR/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio-code.md,broken liquid tags translations/pt-BR/content/copilot/getting-started-with-github-copilot/getting-started-with-github-copilot-in-visual-studio.md,broken liquid tags translations/pt-BR/content/copilot/quickstart.md,broken liquid tags +translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md,broken liquid tags translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md,rendering error translations/pt-BR/content/developers/apps/building-github-apps/managing-allowed-ip-addresses-for-a-github-app.md,rendering error translations/pt-BR/content/developers/apps/getting-started-with-apps/differences-between-github-apps-and-oauth-apps.md,broken liquid tags translations/pt-BR/content/developers/overview/about-githubs-apis.md,broken liquid tags +translations/pt-BR/content/developers/overview/managing-deploy-keys.md,broken liquid tags translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md,rendering error translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/collaborating-with-maintainers-using-discussions.md,broken liquid tags translations/pt-BR/content/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion.md,broken liquid tags translations/pt-BR/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/integrate-github-classroom-with-an-ide.md,broken liquid tags translations/pt-BR/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md,broken liquid tags translations/pt-BR/content/education/manage-coursework-with-github-classroom/teach-with-github-classroom/connect-a-learning-management-system-to-github-classroom.md,broken liquid tags +translations/pt-BR/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md,broken liquid tags translations/pt-BR/content/get-started/exploring-projects-on-github/following-organizations.md,broken liquid tags +translations/pt-BR/content/get-started/getting-started-with-git/associating-text-editors-with-git.md,broken liquid tags translations/pt-BR/content/get-started/learning-about-github/about-github-advanced-security.md,rendering error translations/pt-BR/content/get-started/quickstart/be-social.md,broken liquid tags +translations/pt-BR/content/get-started/quickstart/communicating-on-github.md,broken liquid tags +translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md,broken liquid tags translations/pt-BR/content/get-started/quickstart/github-glossary.md,rendering error translations/pt-BR/content/get-started/using-github/keyboard-shortcuts.md,rendering error +translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md,broken liquid tags translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md,rendering error translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md,broken liquid tags translations/pt-BR/content/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions.md,rendering error @@ -475,6 +487,7 @@ translations/pt-BR/content/packages/learn-github-packages/viewing-packages.md,re translations/pt-BR/content/packages/working-with-a-github-packages-registry/working-with-the-container-registry.md,rendering error translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md,rendering error translations/pt-BR/content/pages/getting-started-with-github-pages/creating-a-github-pages-site.md,rendering error +translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md,broken liquid tags translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md,broken liquid tags translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository.md,rendering error translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/keeping-your-pull-request-in-sync-with-the-base-branch.md,rendering error @@ -623,6 +636,7 @@ translations/pt-BR/data/reusables/gated-features/secret-scanning-partner.md,rend translations/pt-BR/data/reusables/gated-features/secret-scanning.md,rendering error translations/pt-BR/data/reusables/identity-and-permissions/ip-allow-lists-enable.md,broken liquid tags translations/pt-BR/data/reusables/notifications-v2/custom-notification-types.md,broken liquid tags +translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md,broken liquid tags translations/pt-BR/data/reusables/organizations/billing_plans.md,rendering error translations/pt-BR/data/reusables/organizations/github-apps-settings-sidebar.md,rendering error translations/pt-BR/data/reusables/organizations/member-privileges.md,rendering error diff --git a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md index e52dad7b9a5a..8d2d85b673ea 100644 --- a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md +++ b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/viewing-your-subscriptions.md @@ -1,6 +1,6 @@ --- -title: Visualizando suas assinaturas -intro: 'Para entender de onde suas notificações estão vindo e o volume de suas notificações, recomendamos analisar suas assinaturas e repositórios inspecionados regularmente.' +title: Viewing your subscriptions +intro: 'To understand where your notifications are coming from and your notifications volume, we recommend reviewing your subscriptions and watched repositories regularly.' redirect_from: - /articles/subscribing-to-conversations - /articles/unsubscribing-from-conversations @@ -24,63 +24,61 @@ versions: topics: - Notifications shortTitle: View subscriptions -ms.openlocfilehash: 34faad79004d34f5beb14e8992b9aff4e6a3ab39 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145095108' --- -Você recebe notificações para suas assinaturas de atividades contínuas em {% data variables.product.product_name %}. Há muitos motivos para você assinar uma conversa. Para obter mais informações, confira "[Sobre as notificações](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)". +You receive notifications for your subscriptions of ongoing activity on {% data variables.product.product_name %}. There are many reasons you can be subscribed to a conversation. For more information, see "[About notifications](/github/managing-subscriptions-and-notifications-on-github/about-notifications#notifications-and-subscriptions)." -Recomendamos a auditoria e o cancelamento das suas assinaturas como parte de um fluxo de trabalho de notificações saudáveis. Para obter mais informações sobre as opções de cancelamento de assinatura, confira "[Como gerenciar assinaturas](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)". +We recommend auditing and unsubscribing from your subscriptions as a part of a healthy notifications workflow. For more information about your options for unsubscribing, see "[Managing subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." -## Diagnosticando os motivos de receber muitas notificações +## Diagnosing why you receive too many notifications -Quando sua caixa de entrada tiver muitas notificações para gerenciar, considere se você se inscreveu mais de uma vez ou como você pode alterar suas configurações de notificação para reduzir as assinaturas que você tem e os tipos de notificações que está recebendo. Por exemplo, você pode considerar desabilitar as configurações para inspecionar automaticamente todos os repositórios e todas as discussões da equipe sempre que você ingressar em uma equipe ou repositório. +When your inbox has too many notifications to manage, consider whether you have oversubscribed or how you can change your notification settings to reduce the subscriptions you have and the types of notifications you're receiving. For example, you may consider disabling the settings to automatically watch all repositories and all team discussions whenever you've joined a team or repository. -![Inspeção automática](/assets/images/help/notifications-v2/automatic-watching-example.png) +{% ifversion update-notification-settings-22 %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Screenshot of automatic watching options for teams and repositories](/assets/images/help/notifications-v2/automatic-watching-example.png){% endif %} -Para obter mais informações, confira "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)". +For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#automatic-watching)." -Para ter uma visão geral das assinaturas do repositório, confira "[Como revisar repositórios que você está inspecionando](#reviewing-repositories-that-youre-watching)". {% tip %} +To see an overview of your repository subscriptions, see "[Reviewing repositories that you're watching](#reviewing-repositories-that-youre-watching)." +{% tip %} -**Dica:** selecione os tipos de evento para notificação usando a opção **Personalizado** do menu suspenso **Inspecionar/Cancelar a inspeção** na [página Inspeção](https://github.com/watching) ou em qualquer página do repositório no {% data variables.product.product_name %}. Para obter mais informações, confira "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +**Tip:** You can select the types of event to be notified of by using the **Custom** option of the **Watch/Unwatch** dropdown list in your [watching page](https://github.com/watching) or on any repository page on {% data variables.product.product_name %}. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endtip %} -Muitas pessoas esquecem os repositórios que eles escolheram inspecionar no passado. Na página "Repositórios inspecionados" você pode rapidamente deixar de acompanhar repositórios. Para obter mais informações sobre as maneiras de cancelar a assinatura, confira "[Recomendações de cancelamento da inspeção](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" no {% data variables.product.prodname_blog %} e "[Como gerenciar suas assinaturas](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)". Também é possível criar um fluxo de trabalho de triagem para ajudar com as notificações que você recebe. Para obter diretrizes sobre os fluxos de trabalho de triagem, confira "[Como personalizar um fluxo de trabalho para fazer a triagem das notificações](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)". +Many people forget about repositories that they've chosen to watch in the past. From the "Watched repositories" page you can quickly unwatch repositories. For more information on ways to unsubscribe, see "[Unwatch recommendations](https://github.blog/changelog/2020-11-10-unwatch-recommendations/)" on {% data variables.product.prodname_blog %} and "[Managing your subscriptions](/github/managing-subscriptions-and-notifications-on-github/managing-your-subscriptions)." You can also create a triage workflow to help with the notifications you receive. For guidance on triage workflows, see "[Customizing a workflow for triaging your notifications](/github/managing-subscriptions-and-notifications-on-github/customizing-a-workflow-for-triaging-your-notifications)." -## Revisando todas as suas assinaturas +## Reviewing all of your subscriptions {% data reusables.notifications.access_notifications %} -1. Na barra lateral esquerda, na lista de repositórios dos quais você tem notificações, use o menu suspenso "Gerenciar notificações" para clicar em **Assinaturas**. - ![Opções do menu suspenso Gerenciar notificações](/assets/images/help/notifications-v2/manage-notifications-options.png) +1. In the left sidebar, under the list of repositories that you have notifications from, use the "Manage notifications" drop-down to click **Subscriptions**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Use os filtros e classifique para limitar a lista de assinaturas e comece a cancelar as assinaturas de conversas das quais você não deseja mais receber notificações. +2. Use the filters and sort to narrow the list of subscriptions and begin unsubscribing to conversations you no longer want to receive notifications for. - ![Página de assinaturas](/assets/images/help/notifications-v2/all-subscriptions.png) + ![Subscriptions page](/assets/images/help/notifications-v2/all-subscriptions.png) {% tip %} -**Dicas:** -- Para revisar as assinaturas que você pode ter esquecido, classifique por "assinada menos recentemente". +**Tips:** +- To review subscriptions you may have forgotten about, sort by "least recently subscribed." -- Para revisar uma lista de repositórios para os quais você ainda pode receber notificações, consulte a lista de repositórios no menu suspenso "filtrar por repositório". +- To review a list of repositories that you can still receive notifications for, see the repository list in the "filter by repository" drop-down menu. {% endtip %} -## Revisando repositórios que você está inspecionando +## Reviewing repositories that you're watching -1. Na barra lateral esquerda, na lista de repositórios, use o menu suspenso "Gerenciar notificações" e clique em **Repositórios inspecionados**. - ![Opções do menu suspenso Gerenciar notificações](/assets/images/help/notifications-v2/manage-notifications-options.png) -2. Avalie os repositórios que você está inspecionando e decida se suas atualizações ainda são relevantes e úteis. Quando você inspeciona um repositório, você será notificado de todas as conversas desse repositório. -![Página Notificações inspecionadas](/assets/images/help/notifications-v2/watched-notifications-custom.png) +1. In the left sidebar, under the list of repositories, use the "Manage notifications" drop-down menu and click **Watched repositories**. + ![Manage notifications drop down menu options](/assets/images/help/notifications-v2/manage-notifications-options.png) +2. Evaluate the repositories that you are watching and decide if their updates are still relevant and helpful. When you watch a repository, you will be notified of all conversations for that repository. +![Watched notifications page](/assets/images/help/notifications-v2/watched-notifications-custom.png) {% tip %} - **Dica:** em vez de inspecionar um repositório, considere a possibilidade de apenas receber notificações quando houver atualizações nos {% data reusables.notifications-v2.custom-notification-types %} (se habilitado para o repositório) ou qualquer combinação dessas opções ou cancelar a inspeção por completo de um repositório. + **Tip:** Instead of watching a repository, consider only receiving notifications when there are updates to {% data reusables.notifications-v2.custom-notification-types %} (if enabled for the repository), or any combination of these options, or completely unwatching a repository. - Quando você cancelar a inspeção de um repositório, ainda poderá receber notificações quando for @mentioned ou estiver participando de uma conversa. Quando você configura o recebimento de notificações para determinados tipos de eventos, só é notificado quando há atualizações para esses tipos de eventos no repositório, quando está participando de uma conversa ou quando você ou uma equipe em que você está é @mentioned. + When you unwatch a repository, you can still be notified when you're @mentioned or participating in a thread. When you configure to receive notifications for certain event types, you're only notified when there are updates to these event types in the repository, you're participating in a thread, or you or a team you're on is @mentioned. {% endtip %} diff --git a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md index 35d44edfe894..f0ec8c75e9c2 100644 --- a/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md +++ b/translations/pt-BR/content/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications.md @@ -79,15 +79,27 @@ You can customize notifications for a repository. For example, you can choose to ### Participating in conversations Anytime you comment in a conversation or when someone @mentions your username, you are _participating_ in a conversation. By default, you are automatically subscribed to a conversation when you participate in it. You can unsubscribe from a conversation you've participated in manually by clicking **Unsubscribe** on the issue or pull request or through the **Unsubscribe** option in the notifications inbox. -For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion fpt or ghes or ghec %} and {% data variables.product.prodname_mobile %}{% endif %}. +{% ifversion update-notification-settings-22 %}For conversations you're watching or participating in, you can choose whether you want to receive notifications on {% data variables.product.company_short %} or by email in your notification settings. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Animated GIF of participating and watching subscriptions options](/assets/images/help/notifications/selecting-participating-notifications.gif) + +{% else %} + +For conversations you're watching or participating in, you can choose whether you want to receive notifications by email or through the notifications inbox on {% data variables.product.product_location %}{% ifversion ghes %} and {% data variables.product.prodname_mobile %}{% endif %}. For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." + +![Screenshot of participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png){% endif %} + -![Participating and watching notifications options](/assets/images/help/notifications-v2/participating-and-watching-options.png) For example: - If you don't want notifications to be sent to your email, unselect **email** for participating and watching notifications. - If you want to receive notifications by email when you've participated in a conversation, then you can select **email** under "Participating". -If you do not enable watching or participating notifications for web{% ifversion fpt or ghes or ghec %} and mobile{% endif %}, then your notifications inbox will not have any updates. +{% ifversion update-notification-settings-22 %}If you do not enable "Notify me: On GitHub" for watching or participating notifications, then your notifications inbox will not have any updates. + +{% else %} + +If you do not enable watching or participating notifications for web{% ifversion ghes %} and mobile{% endif %}, then your notifications inbox will not have any updates.{% endif %} ## Customizing your email notifications @@ -146,11 +158,16 @@ Email notifications from {% data variables.product.product_location %} contain t ## Automatic watching -By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options. +By default, anytime you gain access to a new repository, you will automatically begin watching that repository. Anytime you join a new team, you will automatically be subscribed to updates and receive notifications when that team is @mentioned. If you don't want to automatically be subscribed, you can unselect the automatic watching options in your notification settings. - ![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png) +{% ifversion update-notification-settings-22 %} +![Automatic watching options for teams and repositories](/assets/images/automatically-watch-repos-and-teams.png) +{% else %} +![Automatic watching options](/assets/images/help/notifications-v2/automatic-watching-options.png){% endif %} -If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. +If "Automatically watch repositories" is disabled, then you will not automatically watch your own repositories. You must navigate to your repository page and choose the watch option. + +For more information, see "[Choosing your notification settings](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#choosing-your-notification-settings)." ## Configuring your watch settings for an individual repository @@ -172,9 +189,17 @@ If you belong to an organization, you can choose the email account you want noti {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} + 3. Under "Default notification email", select the email address you'd like notifications sent to. -![Default notification email address drop-down](/assets/images/help/notifications/notifications_primary_email_for_orgs.png) -4. Click **Save**. +{% ifversion update-notification-settings-22 %} + + ![Screenshot of the default notification email address setting](/assets/images/help/notifications/default-email-address-emphasized.png) + +{% else %} + + ![Screenshot of the default notification email address dropdown](/assets/images/help/notifications/notifications_primary_email_for_orgs.png){% endif %} +{% ifversion ghes or ghae %} +4. Click **Save**.{% endif %} ### Customizing email routes per organization @@ -182,12 +207,35 @@ If you are a member of more than one organization, you can configure each one to {% data reusables.notifications.access_notifications %} {% data reusables.notifications-v2.manage-notifications %} -3. Under "Custom routing," find your organization's name in the list. -![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) +{% ifversion update-notification-settings-22 %} +3. Under "Default notifications email", click **Custom routing**. + + ![Screenshot of default notifications email settings with custom routing button emphasised](/assets/images/help/notifications/custom-router-emphasized.png) + +4. Click **Add new route**. + + ![Screenshot of custom routing settings with add new route button emphasised](/assets/images/help/notifications/add-new-route-emphasized.png) + +5. Click **Pick organization**, then select the organization you want to customize from the dropdown. + + ![Screenshot of dropdown to pick organization](/assets/images/help/notifications/organization-dropdown-custom-routing-emphasis.png) + +6. Select one of your verified email addresses, then click **Save**. + + ![Screenshot of custom routing page with save button](/assets/images/help/notifications/select-email-address-custom-routing-and-save.png) + +{% else %} +3. Under "Custom routing," find your organization's name in the list. + + ![List of organizations and email addresses](/assets/images/help/notifications/notifications_org_emails.png) + 4. Click **Edit** next to the email address you want to change. -![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + + ![Editing an organization's email addresses](/assets/images/help/notifications/notifications_edit_org_emails.png) + 5. Select one of your verified email addresses, then click **Save**. -![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif) + + ![Switching your per-org email address](/assets/images/help/notifications/notifications_switching_org_email.gif){% endif %} ## {% data variables.product.prodname_dependabot_alerts %} notification options @@ -197,14 +245,17 @@ If you are a member of more than one organization, you can configure each one to For more information about the notification delivery methods available to you, and advice on optimizing your notifications for {% data variables.product.prodname_dependabot_alerts %}, see "[Configuring notifications for {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts)." -{% ifversion fpt or ghes or ghec %} +{% ifversion update-notification-settings-22 or ghes %} ## {% data variables.product.prodname_actions %} notification options -Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs. +Choose how you want to receive workflow run updates for repositories that you are watching that are set up with {% data variables.product.prodname_actions %}. You can also choose to only receive notifications for failed workflow runs.{% endif %} - ![Notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png) +{% ifversion update-notification-settings-22 %} +![Animated GIF of notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications/github-actions-customize-notifications.gif){% endif %} + +{% ifversion ghes %} + ![Screenshot of the notification options for {% data variables.product.prodname_actions %}](/assets/images/help/notifications-v2/github-actions-notification-options.png){% endif %} -{% endif %} {% ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} ## Organization alerts notification options diff --git a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md index 89b73ed3a304..c0511693a352 100644 --- a/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md +++ b/translations/pt-BR/content/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme.md @@ -1,6 +1,6 @@ --- -title: Gerenciar o README do seu perfil -intro: 'Você pode adicionar um README ao seu perfil de{% data variables.product.prodname_dotcom %} para contar a outras pessoas sobre você.' +title: Managing your profile README +intro: 'You can add a README to your {% data variables.product.prodname_dotcom %} profile to tell other people about yourself.' versions: fpt: '*' ghes: '*' @@ -11,71 +11,67 @@ redirect_from: - /github/setting-up-and-managing-your-github-profile/managing-your-profile-readme - /github/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme shortTitle: Your profile README -ms.openlocfilehash: 587bcea1e1a0f96aad8882b41196afcc6e433363 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578897' --- -## Sobre o README do seu perfil +## About your profile README -Você pode compartilhar informações sobre si mesmo com a comunidade no {% data variables.product.product_location %} criando um LEIAME do perfil. {% data variables.product.prodname_dotcom %} mostra o README do seu perfil na parte superior da sua página de perfil. +You can share information about yourself with the community on {% data variables.product.product_location %} by creating a profile README. {% data variables.product.prodname_dotcom %} shows your profile README at the top of your profile page. -Você decide quais informações incluir no README do seu perfil. Portanto, você tem total controle sobre a forma como se apresenta no {% data variables.product.prodname_dotcom %}. Aqui estão alguns exemplos de informações que os visitantes podem achar interessantes, divertidas ou úteis no README do seu perfil. +You decide what information to include in your profile README, so you have full control over how you present yourself on {% data variables.product.prodname_dotcom %}. Here are some examples of information that visitors may find interesting, fun, or useful in your profile README. -- Uma seção "Sobre mim" que descreve seu trabalho e seus interesses -- Contribuições das quais você está orgulhoso, bem como contexto dessas contribuições -- Orientação para obter ajuda nas comunidades onde você está envolvido +- An "About me" section that describes your work and interests +- Contributions you're proud of, and context about those contributions +- Guidance for getting help in communities where you're involved -![Arquivo README do perfil exibido no perfil](/assets/images/help/repository/profile-with-readme.png) +![Profile README file displayed on profile](/assets/images/help/repository/profile-with-readme.png) -Você pode formatar texto e incluir emoji, imagens e GIFs no seu perfil README usando o markdown específico do {% data variables.product.company_short %}. Para obter mais informações, confira "[Introdução à escrita e à formatação no {% 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)." -## Pré-requisitos +## Prerequisites -O GitHub irá exibir o README do seu perfil na sua página de perfil se todas as informações a seguir forem verdadeiras. +GitHub will display your profile README on your profile page if all of the following are true. -- Você criou um repositório com um nome que corresponde ao nome de usuário do {% data variables.product.prodname_dotcom %}. -- O repositório é público. -- O repositório contém um arquivo denominado README.md na sua raiz. -- O arquivo README.md contém qualquer conteúdo. +- You've created a repository with a name that matches your {% data variables.product.prodname_dotcom %} username. +- The repository is public. +- The repository contains a file named README.md in its root. +- The README.md file contains any content. {% note %} -**Observação**: se você criou um repositório público com o mesmo nome do nome de usuário antes de julho de 2020, o {% data variables.product.prodname_dotcom %} não mostra automaticamente o LEIAME do repositório no seu perfil. Você pode compartilhar manualmente o LEIAME do repositório para o seu perfil acessando o repositório no {% data variables.product.prodname_dotcom_the_website %} e clicando em **Compartilhar no perfil**. +**Note**: If you created a public repository with the same name as your username before July 2020, {% data variables.product.prodname_dotcom %} won't automatically show the repository's README on your profile. You can manually share the repository's README to your profile by going to the repository on {% data variables.product.prodname_dotcom_the_website %} and clicking **Share to profile**. -![Botão para compartilhar o README no perfil](/assets/images/help/repository/share-to-profile.png) +![Button to share README to profile](/assets/images/help/repository/share-to-profile.png) {% endnote %} -## Adicionar um README do perfil +## Adding a profile README {% data reusables.repositories.create_new %} -2. Em "Nome do repositório", digite um nome de repositório que corresponde ao nome de usuário do {% data variables.product.prodname_dotcom %}. Por exemplo, se seu nome de usuário for "octocat", o nome do repositório deverá ser "octocat". - ![Campo de nome do repositório que corresponde ao nome de usuário](/assets/images/help/repository/repo-username-match.png) -3. Opcionalmente, adicione uma descrição do repositório. Por exemplo, "Meu repositório pessoal". - ![Campo usado para inserir uma descrição do repositório](/assets/images/help/repository/create-personal-repository-desc.png) -4. Selecione **Público**. - ![Botão de opção usado para selecionar a visibilidade com o público-alvo selecionado](/assets/images/help/repository/create-personal-repository-visibility.png) {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -7. Acima da barra lateral direita, clique em **Editar LEIAME**. - ![Botão usado para editar o arquivo LEIAME](/assets/images/help/repository/personal-repository-edit-readme.png) +2. Under "Repository name", type a repository name that matches your {% data variables.product.prodname_dotcom %} username. For example, if your username is "octocat", the repository name must be "octocat". + ![Repository name field which matches username](/assets/images/help/repository/repo-username-match.png) +3. Optionally, add a description of your repository. For example, "My personal repository." + ![Field for entering a repository description](/assets/images/help/repository/create-personal-repository-desc.png) +4. Select **Public**. + ![Radio button to select visibility with public selected](/assets/images/help/repository/create-personal-repository-visibility.png) +{% data reusables.repositories.initialize-with-readme %} +{% data reusables.repositories.create-repo %} +7. Above the right sidebar, click **Edit README**. + ![Button to edit README file](/assets/images/help/repository/personal-repository-edit-readme.png) - O arquivo README gerado é pré-preenchido com um modelo para dar alguma inspiração para o README do seu perfil. - ![Arquivo LEIAME com modelo preenchido previamente](/assets/images/help/repository/personal-repository-readme-template.png) + The generated README file is pre-populated with a template to give you some inspiration for your profile README. + ![README file with pre-populated template](/assets/images/help/repository/personal-repository-readme-template.png) -Para ver um resumo de todos os emojis disponíveis e os respectivos códigos, confira "[Folha de referências de emojis](https://www.webfx.com/tools/emoji-cheat-sheet/)". +For a summary of all the available emojis and their codes, see "[Emoji cheat sheet](https://www.webfx.com/tools/emoji-cheat-sheet/)." -## Remover um README do perfil +## Removing a profile README -O perfil README é removido do seu perfil de {% data variables.product.prodname_dotcom %} se algum dos pontos seguintes se aplicar: +The profile README is removed from your {% data variables.product.prodname_dotcom %} profile if any of the following apply: -- O arquivo README está vazio ou não existe. -- O repositório é privado. -- O nome do repositório não corresponde mais ao seu nome de usuário. +- The README file is empty or doesn't exist. +- The repository is private. +- The repository name no longer matches your username. -The method you choose is dependant upon your needs, but if you're unsure, we recommend making your repository private. Para ver as etapas de como tornar seu repositório privado, confira "[Como alterar a visibilidade de um repositório](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)". +The method you choose depends upon your needs, but if you're unsure, we recommend making your repository private. For steps on how to make your repository private, see "[Changing a repository's visibility](/github/administering-a-repository/setting-repository-visibility#changing-a-repositorys-visibility)." -## Leitura adicional +## Further reading -- "[Sobre os arquivos LEIAME](/github/creating-cloning-and-archiving-repositories/about-readmes)" +- [About READMEs](/github/creating-cloning-and-archiving-repositories/about-readmes) diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md index 053f0e3d1eea..e2894b8fdda5 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/autoscaling-with-self-hosted-runners.md @@ -63,7 +63,7 @@ By default, self-hosted runners will automatically perform a software update whe To turn off automatic software updates and install software updates yourself, specify the `--disableupdate` flag when registering your runner using `config.sh`. For example: ```shell -./config.sh --url https://github.com/octo-org --token example-token --disableupdate +./config.sh --url https://github.com/YOUR-ORGANIZATION --token EXAMPLE-TOKEN --disableupdate ``` If you disable automatic updates, you must still update your runner version regularly. New functionality in {% data variables.product.prodname_actions %} requires changes in both the {% data variables.product.prodname_actions %} service _and_ the runner software. The runner may not be able to correctly process jobs that take advantage of new features in {% data variables.product.prodname_actions %} without a software update. diff --git a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index f95896503ddf..7463d3c5df25 100644 --- a/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/translations/pt-BR/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -77,7 +77,7 @@ You can manage the runner service in the Windows **Services** application, or yo 1. Alternatively, the command takes an optional `user` argument to install the service as a different user. ```shell - ./svc.sh install USERNAME + ./svc.sh install USERNAME ``` {% endlinux %} diff --git a/translations/pt-BR/content/actions/learn-github-actions/contexts.md b/translations/pt-BR/content/actions/learn-github-actions/contexts.md index a4fdab860d13..7a13b15687c3 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/contexts.md +++ b/translations/pt-BR/content/actions/learn-github-actions/contexts.md @@ -201,7 +201,7 @@ The `github` context contains information about the workflow run and the event t | `github.ref` | `string` | {% data reusables.actions.ref-description %} | {%- ifversion fpt or ghec or ghes > 3.3 or ghae > 3.3 %} | `github.ref_name` | `string` | {% data reusables.actions.ref_name-description %} | -| `github.ref_protected` | `string` | {% data reusables.actions.ref_protected-description %} | +| `github.ref_protected` | `boolean` | {% data reusables.actions.ref_protected-description %} | | `github.ref_type` | `string` | {% data reusables.actions.ref_type-description %} | {%- endif %} | `github.path` | `string` | Path on the runner to the file that sets system `PATH` variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/workflow-commands-for-github-actions#adding-a-system-path)." | diff --git a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md index f3c1c1faf6c3..ea6cebc80b16 100644 --- a/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md +++ b/translations/pt-BR/content/actions/learn-github-actions/understanding-github-actions.md @@ -87,15 +87,9 @@ For more information, see "[Creating actions](/actions/creating-actions)." {% data reusables.actions.workflow-basic-example-and-explanation %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -- To continue learning about {% data variables.product.prodname_actions %}, see "[Finding and customizing actions](/actions/learn-github-actions/finding-and-customizing-actions)." -{% ifversion fpt or ghec or ghes %} -- To understand how billing works for {% data variables.product.prodname_actions %}, see "[About billing for {% data variables.product.prodname_actions %}](/actions/reference/usage-limits-billing-and-administration#about-billing-for-github-actions)." -{% endif %} +{% data reusables.actions.onboarding-next-steps %} ## Contacting support diff --git a/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md b/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md index cc2359f7a547..a1d240e9c058 100644 --- a/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md +++ b/translations/pt-BR/content/actions/managing-workflow-runs/re-running-workflows-and-jobs.md @@ -48,14 +48,14 @@ Re-running a workflow{% ifversion re-run-jobs %} or jobs in a workflow{% endif % To re-run a failed workflow run, use the `run rerun` subcommand. Replace `run-id` with the ID of the failed run that you want to re-run. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id +gh run rerun RUN_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --debug +gh run rerun RUN_ID --debug ``` {% endif %} @@ -90,14 +90,14 @@ If any jobs in a workflow run failed, you can re-run just the jobs that failed. To re-run failed jobs in a workflow run, use the `run rerun` subcommand with the `--failed` flag. Replace `run-id` with the ID of the run for which you want to re-run failed jobs. If you don't specify a `run-id`, {% data variables.product.prodname_cli %} returns an interactive menu for you to choose a recent failed run. ```shell -gh run rerun run-id --failed +gh run rerun RUN_ID --failed ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun run-id --failed --debug +gh run rerun RUN_ID --failed --debug ``` {% endif %} @@ -127,14 +127,14 @@ When you re-run a specific job in a workflow, a new workflow run will start for To re-run a specific job in a workflow run, use the `run rerun` subcommand with the `--job` flag. Replace `job-id` with the ID of the job that you want to re-run. ```shell -gh run rerun --job job-id +gh run rerun --job JOB_ID ``` {% ifversion debug-reruns %} {% data reusables.actions.enable-debug-logging-cli %} ```shell -gh run rerun --job job-id --debug +gh run rerun --job JOB_ID --debug ``` {% endif %} diff --git a/translations/pt-BR/content/actions/quickstart.md b/translations/pt-BR/content/actions/quickstart.md index b83df0ebe23a..44f3ab36a3bc 100644 --- a/translations/pt-BR/content/actions/quickstart.md +++ b/translations/pt-BR/content/actions/quickstart.md @@ -77,21 +77,13 @@ Committing the workflow file to a branch in your repository triggers the `push` For example, you can see the list of files in your repository: ![Example action detail](/assets/images/help/repository/actions-quickstart-log-detail.png) - + +The example workflow you just added is triggered each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. For an in-depth tutorial, see "[Understanding {% data variables.product.prodname_actions %}](/actions/learn-github-actions/understanding-github-actions)." + ## More starter workflows {% data reusables.actions.workflow-template-overview %} -## More complex examples -{% data reusables.actions.link-to-example-library %} - ## Next steps -The example workflow you just added runs each time code is pushed to the branch, and shows you how {% data variables.product.prodname_actions %} can work with the contents of your repository. But this is only the beginning of what you can do with {% data variables.product.prodname_actions %}: - -- Your repository can contain multiple workflows that trigger different jobs based on different events. -- You can use a workflow to install software testing apps and have them automatically test your code on {% data variables.product.prodname_dotcom %}'s runners. - -{% data variables.product.prodname_actions %} can help you automate nearly every aspect of your application development processes. Ready to get started? Here are some helpful resources for taking your next steps with {% data variables.product.prodname_actions %}: - -- "[Learn {% data variables.product.prodname_actions %}](/actions/learn-github-actions)" for an in-depth tutorial. +{% data reusables.actions.onboarding-next-steps %} diff --git a/translations/pt-BR/content/actions/security-guides/encrypted-secrets.md b/translations/pt-BR/content/actions/security-guides/encrypted-secrets.md index 9a60fda43d2f..e678c2474ce0 100644 --- a/translations/pt-BR/content/actions/security-guides/encrypted-secrets.md +++ b/translations/pt-BR/content/actions/security-guides/encrypted-secrets.md @@ -93,13 +93,13 @@ If your repository has environment secrets or can access secrets from the parent To add a repository secret, use the `gh secret set` subcommand. Replace `secret-name` with the name of your secret. ```shell -gh secret set secret-name +gh secret set SECRET_NAME ``` The CLI will prompt you to enter a secret value. Alternatively, you can read the value of the secret from a file. ```shell -gh secret set secret-name < secret.txt +gh secret set SECRET_NAME < secret.txt ``` To list all secrets for the repository, use the `gh secret list` subcommand. @@ -128,13 +128,13 @@ To list all secrets for the repository, use the `gh secret list` subcommand. To add a secret for an environment, use the `gh secret set` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret set --env environment-name secret-name +gh secret set --env ENV_NAME SECRET_NAME ``` To list all secrets for an environment, use the `gh secret list` subcommand with the `--env` or `-e` flag followed by the environment name. ```shell -gh secret list --env environment-name +gh secret list --env ENV_NAME ``` {% endcli %} @@ -173,25 +173,25 @@ gh auth login --scopes "admin:org" To add a secret for an organization, use the `gh secret set` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret set --org organization-name secret-name +gh secret set --org ORG_NAME SECRET_NAME ``` By default, the secret is only available to private repositories. To specify that the secret should be available to all repositories within the organization, use the `--visibility` or `-v` flag. ```shell -gh secret set --org organization-name secret-name --visibility all +gh secret set --org ORG_NAME SECRET_NAME --visibility all ``` To specify that the secret should be available to selected repositories within the organization, use the `--repos` or `-r` flag. ```shell -gh secret set --org organization-name secret-name --repos repo-name-1,repo-name-2" +gh secret set --org ORG_NAME SECRET_NAME --repos REPO-NAME-1, REPO-NAME-2" ``` To list all secrets for an organization, use the `gh secret list` subcommand with the `--org` or `-o` flag followed by the organization name. ```shell -gh secret list --org organization-name +gh secret list --org ORG_NAME ``` {% endcli %} diff --git a/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md b/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md index 17fb1a7a0f5d..5d941f42f36d 100644 --- a/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md +++ b/translations/pt-BR/content/actions/using-github-hosted-runners/using-larger-runners.md @@ -87,7 +87,7 @@ You can add a {% data variables.actions.hosted_runner %} to an organization, whe ## Running jobs on your runner -Once your runner type has been been defined, you can update your workflows to send jobs to the runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: +Once your runner type has been defined, you can update your workflow YAML files to send jobs to your newly created runner instances for processing. In this example, a runner group is populated with Ubuntu 16-core runners, which have been assigned the label `ubuntu-20.04-16core`. If you have a runner matching this label, the `check-bats-version` job then uses the `runs-on` key to target that runner whenever the job is run: ```yaml name: learn-github-actions @@ -104,6 +104,8 @@ jobs: - run: bats -v ``` +To find out which runners are enabled for your repository and organization, you must contact your organization admin. Your organization admin can create new runners and runner groups, as well as configure permissions to specify which repositories can access a runner group. + ## Managing access to your runners {% note %} diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md index 26c878bfaa04..6f6735949d9d 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/configuring-rate-limits.md @@ -93,7 +93,7 @@ By default, the rate limit for {% data variables.product.prodname_actions %} is ```shell ghe-config actions-rate-limiting.enabled true - ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE + ghe-config actions-rate-limiting.queue-runs-per-minute RUNS-PER-MINUTE ``` 1. To disable the rate limit after it's been enabled, run the following command. diff --git a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md index 5bd322dcae97..ea742e0fc5ea 100644 --- a/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md +++ b/translations/pt-BR/content/admin/configuration/configuring-your-enterprise/site-admin-dashboard.md @@ -67,7 +67,7 @@ You can also access these reports programmatically via standard HTTP authenticat For example, here is how you would download the "all users" report using cURL: ```shell -curl -L -u username:token http(s)://hostname/stafftools/reports/all_users.csv +curl -L -u USERNAME:TOKEN http(s)://HOSTNAME/stafftools/reports/all_users.csv ``` To access the other reports programmatically, replace `all_users` with `active_users`, `dormant_users`, `suspended_users`, `all_organizations`, or `all_repositories`. diff --git a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md index 2fabe7244ad5..590bf709b2c3 100644 --- a/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md +++ b/translations/pt-BR/content/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources/upgrading-github-enterprise-server.md @@ -118,7 +118,7 @@ If the upgrade target you're presented with is a feature release instead of a pa {% data reusables.enterprise_installation.download-package %} 4. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.hpkg *** verifying upgrade package signature... ``` 5. If a reboot is required for updates for kernel, MySQL, Elasticsearch or other programs, the hotpatch upgrade script notifies you. @@ -170,14 +170,14 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea 5. Run the `ghe-upgrade` command using the package file name: ```shell - admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg + admin@HOSTNAME:~$ ghe-upgrade GITHUB-UPGRADE.pkg *** verifying upgrade package signature... ``` 6. Confirm that you'd like to continue with the upgrade and restart after the package signature verifies. The new root filesystem writes to the secondary partition and the instance automatically restarts in maintenance mode: ```shell *** applying update... - This package will upgrade your installation to version version-number - Current root partition: /dev/xvda1 [version-number] + This package will upgrade your installation to version VERSION-NUMBER + Current root partition: /dev/xvda1 [VERSION-NUMBER] Target root partition: /dev/xvda2 Proceed with installation? [y/N] ``` diff --git a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md index b34b1c60c307..47804fb2d705 100644 --- a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/streaming-the-audit-log-for-your-enterprise.md @@ -86,12 +86,6 @@ For information on creating or accessing your access key ID and secret key, see {% ifversion streaming-oidc-s3 %} #### Setting up streaming to S3 with OpenID Connect -{% note %} - -**Note:** Streaming to Amazon S3 with OpenID Connect is currently in beta and subject to change. - -{% endnote %} - 1. In AWS, add the {% data variables.product.prodname_dotcom %} OIDC provider to IAM. For more information, see [Creating OpenID Connect (OIDC) identity providers](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_providers_create_oidc.html) in the AWS documentation. - For the provider URL, use `https://oidc-configuration.audit-log.githubusercontent.com`. diff --git a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md index fe9cb82ebb5a..eb7ca4cae4cb 100644 --- a/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md +++ b/translations/pt-BR/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/using-the-audit-log-api-for-your-enterprise.md @@ -121,7 +121,7 @@ For more information about the audit log REST API, see "[Enterprise administrati The query below searches for audit log events created on Jan 1st, 2022 in the `avocado-corp` enterprise, and return the first page with a maximum of 100 items per page using [REST API pagination](/rest/overview/resources-in-the-rest-api#pagination): ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=created:2022-01-01&page=1&per_page=100" ``` @@ -133,7 +133,7 @@ You can specify multiple search phrases, such as `created` and `actor`, by separ The query below searches for audit log events for pull requests, where the event occurred on or after Jan 1st, 2022 in the `avocado-corp` enterprise, and the action was performed by the `octocat` user: ```shell -curl -H "Authorization: Bearer TOKEN" \ +curl -H "Authorization: Bearer TOKEN" \ --request GET \ "https://api.github.com/enterprises/avocado-corp/audit-log?phrase=action:pull_request+created:>=2022-01-01+actor:octocat" ``` diff --git a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md index 9d0033a39f75..92fa29e8a531 100644 --- a/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md +++ b/translations/pt-BR/content/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent.md @@ -44,17 +44,19 @@ If you are a site administrator for {% data variables.product.product_location % {%- ifversion ghae %} ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + ``` {%- else %} ```shell - $ ssh-keygen -t ed25519 -C "your_email@example.com" + $ ssh-keygen -t ed25519 -C "your_email@example.com" ``` {% note %} **Note:** If you are using a legacy system that doesn't support the Ed25519 algorithm, use: ```shell - $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" + $ ssh-keygen -t rsa -b 4096 -C "your_email@example.com" ``` {% endnote %} @@ -62,14 +64,14 @@ If you are a site administrator for {% data variables.product.product_location % This creates a new SSH key, using the provided email as a label. ```shell - > Generating public/private algorithm key pair. + > Generating public/private ALGORITHM key pair. ``` 3. When you're prompted to "Enter a file in which to save the key," press Enter. This accepts the default file location. {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_algorithm): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_ALGORITHM: [Press enter] ``` {% endmac %} @@ -77,7 +79,7 @@ If you are a site administrator for {% data variables.product.product_location % {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_algorithm):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_ALGORITHM):[Press enter] ``` {% endwindows %} @@ -85,15 +87,15 @@ If you are a site administrator for {% data variables.product.product_location % {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/algorithm): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/ALGORITHM):[Press enter] ``` {% endlinux %} 4. At the prompt, type a secure passphrase. For more information, see ["Working with SSH key passphrases](/articles/working-with-ssh-key-passphrases)." ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` ## Adding your SSH key to the ssh-agent @@ -110,7 +112,7 @@ Before adding a new SSH key to the ssh-agent to manage your keys, you should hav ```shell $ open ~/.ssh/config - > The file /Users/you/.ssh/config does not exist. + > The file /Users/YOU/.ssh/config does not exist. ``` * If the file doesn't exist, create the file. @@ -198,7 +200,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% data reusables.command_line.open_the_multi_os_terminal %} 3. Paste the text below, substituting in the email address for your account on {% data variables.product.product_name %}. ```shell - $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "your_email@example.com" + $ ssh-keygen -t {% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}-sk -C "YOUR_EMAIL" ``` {%- ifversion not ghae %} @@ -217,7 +219,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% mac %} ```shell - > Enter a file in which to save the key (/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] ``` {% endmac %} @@ -225,7 +227,7 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% windows %} ```shell - > Enter a file in which to save the key (/c/Users/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] + > Enter a file in which to save the key (/c/Users/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endwindows %} @@ -233,14 +235,14 @@ If you are using macOS or Linux, you may need to update your SSH client or insta {% linux %} ```shell - > Enter a file in which to save the key (/home/you/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk): [Press enter] + > Enter a file in which to save the key (/home/YOU/.ssh/id_{% ifversion ghae %}ecdsa{% else %}ed25519{% endif %}_sk):[Press enter] ``` {% endlinux %} 6. When you are prompted to type a passphrase, press **Enter**. ```shell - > Enter passphrase (empty for no passphrase): [Type a passphrase] - > Enter same passphrase again: [Type passphrase again] + > Enter passphrase (empty for no passphrase): [Type a passphrase] + > Enter same passphrase again: [Type passphrase again] ``` 7. Add the SSH key to your account on {% data variables.product.prodname_dotcom %}. For more information, see "[Adding a new SSH key to your {% data variables.product.prodname_dotcom %} account](/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account)." diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md index cf7d05904237..e9b3200e360c 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-commits.md @@ -36,7 +36,7 @@ If you have multiple keys or are attempting to sign commits or tags with a key t 1. When committing changes in your local branch, add the -S flag to the git commit command: ```shell - $ git commit -S -m "your commit message" + $ git commit -S -m "YOUR_COMMIT_MESSAGE" # Creates a signed commit ``` 2. If you're using GPG, after you create your commit, provide the passphrase you set up when you [generated your GPG key](/articles/generating-a-new-gpg-key). diff --git a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md index fac18fab40a6..e5371adbc68c 100644 --- a/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md +++ b/translations/pt-BR/content/authentication/managing-commit-signature-verification/signing-tags.md @@ -19,12 +19,12 @@ topics: 1. To sign a tag, add `-s` to your `git tag` command. ```shell - $ git tag -s mytag + $ git tag -s MYTAG # Creates a signed tag ``` 2. Verify your signed tag by running `git tag -v [tag-name]`. ```shell - $ git tag -v mytag + $ git tag -v MYTAG # Verifies the signed tag ``` diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md index b907b2c69fed..91f2e8d0640d 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md +++ b/translations/pt-BR/content/code-security/dependabot/dependabot-alerts/configuring-notifications-for-dependabot-alerts.md @@ -1,7 +1,7 @@ --- -title: Configurando notificações para alertas do Dependabot +title: Configuring notifications for Dependabot alerts shortTitle: Configure notifications -intro: 'Otimize a forma como você recebe notificações sobre {% data variables.product.prodname_dependabot_alerts %}.' +intro: 'Optimize how you receive notifications about {% data variables.product.prodname_dependabot_alerts %}.' redirect_from: - /github/managing-security-vulnerabilities/configuring-notifications-for-vulnerable-dependencies - /code-security/supply-chain-security/configuring-notifications-for-vulnerable-dependencies @@ -19,50 +19,51 @@ topics: - Vulnerabilities - Dependencies - Repositories -ms.openlocfilehash: b8810c27a10302a7873fc61a32189f33855140bb -ms.sourcegitcommit: ac00e2afa6160341c5b258d73539869720b395a4 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147875524' --- -## Sobre as notificações de {% data variables.product.prodname_dependabot_alerts %}. -Quando o {% data variables.product.prodname_dependabot %} detecta dependências vulneráveis {% ifversion GH-advisory-db-supports-malware %} ou malware{% endif %} nos seus repositórios, geramos um alerta do {% data variables.product.prodname_dependabot %} que é exibido na guia Segurança do repositório. O {% data variables.product.product_name %} notifica os mantenedores dos repositórios afetados sobre o novo alerta de acordo com as preferências de notificação.{% ifversion fpt or ghec %} Por padrão, o {% data variables.product.prodname_dependabot %} está habilitado em todos os repositórios públicos. Para {% data variables.product.prodname_dependabot_alerts %}, por padrão, você receberá {% data variables.product.prodname_dependabot_alerts %} por e-mail, agrupado pela vulnerabilidade específica. +## About notifications for {% data variables.product.prodname_dependabot_alerts %} + +When {% data variables.product.prodname_dependabot %} detects vulnerable dependencies{% ifversion GH-advisory-db-supports-malware %} or malware{% endif %} in your repositories, we generate a {% data variables.product.prodname_dependabot %} alert and display it on the Security tab for the repository. {% data variables.product.product_name %} notifies the maintainers of affected repositories about the new alert according to their notification preferences.{% ifversion fpt or ghec %} {% data variables.product.prodname_dependabot %} is enabled by default on all public repositories. For {% data variables.product.prodname_dependabot_alerts %}, by default, you will receive {% data variables.product.prodname_dependabot_alerts %} by email, grouped by the specific vulnerability. {% endif %} -{% ifversion fpt or ghec %}Se você é proprietário de uma organização, habilite ou desabilite os {% data variables.product.prodname_dependabot_alerts %} em todos os repositórios da organização com um clique. Você também pode definir se os {% data variables.product.prodname_dependabot_alerts %} serão habilitados ou desabilitados para repositórios recém-criados. Para obter mais informações, confira "[Como gerenciar as configurações de segurança e de análise da sua organização](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)". +{% ifversion fpt or ghec %}If you're an organization owner, you can enable or disable {% data variables.product.prodname_dependabot_alerts %} for all repositories in your organization with one click. You can also set whether {% data variables.product.prodname_dependabot_alerts %} will be enabled or disabled for newly-created repositories. For more information, see "[Managing security and analysis settings for your organization](/organizations/keeping-your-organization-secure/managing-security-and-analysis-settings-for-your-organization#enabling-or-disabling-a-feature-for-all-new-repositories-when-they-are-added)." {% endif %} -{% ifversion ghes or ghae %} Por padrão, se o proprietário da sua empresa configurou o email para receber notificações sobre sua empresa, você receberá os {% data variables.product.prodname_dependabot_alerts %} por email. +{% ifversion ghes or ghae %} +By default, if your enterprise owner has configured email for notifications on your enterprise, you will receive {% data variables.product.prodname_dependabot_alerts %} by email. -Os proprietários das empresas também podem habilitar {% data variables.product.prodname_dependabot_alerts %} sem notificações. Para obter mais informações, confira "[Como habilitar o {% data variables.product.prodname_dependabot %} para sua empresa](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)". +Enterprise owners can also enable {% data variables.product.prodname_dependabot_alerts %} without notifications. For more information, see "[Enabling {% data variables.product.prodname_dependabot %} for your enterprise](/admin/configuration/configuring-github-connect/enabling-dependabot-for-your-enterprise)." {% endif %} -## Configurar notificações para {% data variables.product.prodname_dependabot_alerts %} +## Configuring notifications for {% data variables.product.prodname_dependabot_alerts %} -{% ifversion fpt or ghes or ghec %} Quando um novo alerta do {% data variables.product.prodname_dependabot %} é detectado, o {% data variables.product.product_name %} notifica todos os usuários com acesso aos {% data variables.product.prodname_dependabot_alerts %} no repositório de acordo com as respectivas preferências de notificação. Você receberá alertas se estiver acompanhando o repositório, caso tenha habilitado notificações para alertas de segurança ou para toda a atividade no repositório e não estiver ignorando o repositório. Para obter mais informações, confira "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)". +{% ifversion fpt or ghes or ghec %} +When a new {% data variables.product.prodname_dependabot %} alert is detected, {% data variables.product.product_name %} notifies all users with access to {% data variables.product.prodname_dependabot_alerts %} for the repository according to their notification preferences. You will receive alerts if you are watching the repository, have enabled notifications for security alerts or for all the activity on the repository, and are not ignoring the repository. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#configuring-your-watch-settings-for-an-individual-repository)." {% endif %} -Você pode definir as configurações de notificação para si mesmo ou para sua organização no menu suspenso Gerenciar notificações {% octicon "bell" aria-label="The notifications bell" %} exibido na parte superior de cada página. Para obter mais informações, confira "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)". +You can configure notification settings for yourself or your organization from the Manage notifications drop-down {% octicon "bell" aria-label="The notifications bell" %} shown at the top of each page. For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#choosing-your-notification-settings)." + +{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} +{% data reusables.notifications.vulnerable-dependency-notification-options %} -{% data reusables.notifications.vulnerable-dependency-notification-delivery-method-customization2 %} {% data reusables.notifications.vulnerable-dependency-notification-options %} +{% ifversion update-notification-settings-22 %} +![Screenshot of {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/dependabot/dependabot-notification-frequency.png){% else %} +![Screenshot of the {% data variables.product.prodname_dependabot_alerts %} options](/assets/images/help/notifications-v2/dependabot-alerts-options.png){% endif %} - ![Opções {% data variables.product.prodname_dependabot_alerts %}](/assets/images/help/notifications-v2/dependabot-alerts-options.png) {% note %} -**Observação:** você pode filtrar suas notificações no {% data variables.product.company_short %} para mostrar os {% data variables.product.prodname_dependabot_alerts %}. Para obter mais informações, confira "[Como gerenciar notificações na sua caixa de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)". +**Note:** You can filter your notifications on {% data variables.product.company_short %} to show {% data variables.product.prodname_dependabot_alerts %}. For more information, see "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#dependabot-custom-filters)." {% endnote %} -{% data reusables.repositories.security-alerts-x-github-severity %} Para obter mais informações, confira "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)". +{% data reusables.repositories.security-alerts-x-github-severity %} For more information, see "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#filtering-email-notifications)." -## Como reduzir as notificações desnecessárias de {% data variables.product.prodname_dependabot_alerts %}. +## How to reduce the noise from notifications for {% data variables.product.prodname_dependabot_alerts %} -Se você estiver preocupado em receber muitas notificações para {% data variables.product.prodname_dependabot_alerts %}, recomendamos que você opte pelo resumo semanal de e-mail ou desabilite as notificações enquanto mantém {% data variables.product.prodname_dependabot_alerts %} habilitado. Você ainda pode navegar para ver os {% data variables.product.prodname_dependabot_alerts %} na guia Segurança do repositório. Para obter mais informações, confira "[Como ver os {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)". +If you are concerned about receiving too many notifications for {% data variables.product.prodname_dependabot_alerts %}, we recommend you opt into the weekly email digest, or turn off notifications while keeping {% data variables.product.prodname_dependabot_alerts %} enabled. You can still navigate to see your {% data variables.product.prodname_dependabot_alerts %} in your repository's Security tab. For more information, see "[Viewing and updating {% data variables.product.prodname_dependabot_alerts %}](/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts)." -## Leitura adicional +## Further reading -- "[Como configurar notificações](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" -- "[Como gerenciar notificações na sua caixa de entrada](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" +- "[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications)" +- "[Managing notifications from your inbox](/github/managing-subscriptions-and-notifications-on-github/managing-notifications-from-your-inbox#supported-is-queries)" diff --git a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 9dcf891257e9..5bd218b446e5 100644 --- a/translations/pt-BR/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/translations/pt-BR/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/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md index fe6e0c705e1f..559ed6dc3834 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/creating-a-codespace.md @@ -73,6 +73,8 @@ Organization owners can specify who can create and use codespaces at the organiz ![New codespace button](/assets/images/help/codespaces/new-codespace-button.png) + If codespaces for this repository are billable, a message is displayed below the **Create codespace on BRANCH** button telling you who will pay for the codespace. + 1. Create your codespace, either using the default options, or after configuring advanced options: * **Use the default options** @@ -131,12 +133,12 @@ To create a new codespace, use the `gh codespace create` subcommand. gh codespace create ``` -You are prompted to choose a repository, a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). +You are prompted to choose a repository. If codespaces for this repository are billable, a message is displayed telling you who will pay for the codespace. You are then prompted to choose a branch, a dev container configuration file (if more than one is available), and a machine type (if more than one is available). Alternatively, you can use flags to specify some or all of the options: ```shell -gh codespace create -r owner/repo -b branch --devcontainer-path path -m machine-type +gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE ``` In this example, replace `owner/repo` with the repository identifier. Replace `branch` with the name of the branch, or the full SHA hash of the commit, that you want to be initially checked out in the codespace. If you use the `-r` flag without the `b` flag, the codespace is created from the default branch. diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md index eee506d1f6db..c5cea6210c7d 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md @@ -78,7 +78,7 @@ By default, {% data variables.product.prodname_github_codespaces %} forwards por To forward a port use the `gh codespace ports forward` subcommand. Replace `codespace-port:local-port` with the remote and local ports that you want to connect. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports forward codespace-port:local-port +gh codespace ports forward CODESPACE-PORT:LOCAL-PORT ``` For more information about this command, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_codespace_ports_forward). @@ -132,7 +132,7 @@ To change the visibility of a forwarded port, use the `gh codespace ports visibi Replace `codespace-port` with the forwarded port number. Replace `setting` with `private`, `org`, or `public`. After entering the command choose from the list of codespaces that's displayed. ```shell -gh codespace ports visibility codespace-port:setting +gh codespace ports visibility CODESPACE-PORT:SETTINGS ``` You can set the visibility for multiple ports with one command. For example: diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md index b296745717e4..e27f565ffc95 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/renaming-a-codespace.md @@ -50,7 +50,7 @@ Changing the display name of a codespace can be useful if you have multiple code To rename a codespace, use the `gh codespace edit` subcommand: ```shell -gh codespace edit -c permanent name of the codespace -d new display name +gh codespace edit -c PERMANENT-NAME-OF-CODESPACE -d NEW-DISPLAY-NAME ``` In this example, replace `permanent name of the codespace` with the permanent name of the codespace. Replace `new display name` with the desired display name. \ No newline at end of file diff --git a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md index 0a582c1557e5..14283811fcb1 100644 --- a/translations/pt-BR/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md +++ b/translations/pt-BR/content/codespaces/developing-in-codespaces/using-github-codespaces-with-github-cli.md @@ -62,7 +62,7 @@ For a complete reference of `gh` commands for {% data variables.product.prodname {% note %} -**Note**: The `-c codespace-name` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. +**Note**: The `-c CODESPACE_NAME` flag, used with many commands, is optional. If you omit it a list of codespaces is displayed for you to choose from. {% endnote %} @@ -77,7 +77,7 @@ The list includes the unique name of each codespace, which you can use in other ### Create a new codespace ```shell -gh codespace create -r owner/repository [-b branch] +gh codespace create -r OWNER/REPO_NAME [-b BRANCH] ``` For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace)." @@ -85,7 +85,7 @@ For more information, see "[Creating a codespace](/codespaces/developing-in-code ### Stop a codespace ```shell -gh codespace stop -c codespace-name +gh codespace stop -c CODESPACE-NAME ``` For more information, see "[Deep dive into {% data variables.product.prodname_github_codespaces %}](/codespaces/getting-started/deep-dive#closing-or-stopping-your-codespace)." @@ -93,7 +93,7 @@ For more information, see "[Deep dive into {% data variables.product.prodname_gi ### Delete a codespace ```shell -gh codespace delete -c codespace-name +gh codespace delete -c CODESPACE-NAME ``` For more information, see "[Deleting a codespace](/codespaces/developing-in-codespaces/deleting-a-codespace)." @@ -103,7 +103,7 @@ For more information, see "[Deleting a codespace](/codespaces/developing-in-code To run commands on the remote codespace machine, from your terminal, you can SSH into the codespace. ```shell -gh codespace ssh -c codespace-name +gh codespace ssh -c CODESPACE-NAME ``` {% data variables.product.prodname_github_codespaces %} copies your GitHub SSH keys into the codespace on creation for a seamless authentication experience. You may be asked to enter the passphrase for your SSH key, after which you will get a command prompt from the remote codespace machine. @@ -113,7 +113,7 @@ If you don't have any SSH keys, follow the instructions in "[Generating a new SS ### Open a codespace in {% data variables.product.prodname_vscode %} ```shell -gh codespace code -c codespace-name +gh codespace code -c CODESPACE-NAME ``` For more information, see "[Using {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code)." @@ -121,13 +121,13 @@ For more information, see "[Using {% data variables.product.prodname_github_code ### Open a codespace in JupyterLab ```shell -gh codespace jupyter -c codespace-name +gh codespace jupyter -c CODESPACE-NAME ``` ### Copy a file to/from a codespace ```shell -gh codespace cp [-r] source(s) destination +gh codespace cp [-r] SOURCE(S) DESTINATION ``` Use the prefix `remote:` on a file or directory name to indicate that it's on the codespace. As with the UNIX `cp` command, the first argument specifies the source and the last specifies the destination. If the destination is a directory, you can specify multiple sources. Use the `-r` (recursive) flag if any of the sources is a directory. @@ -171,7 +171,7 @@ For more information about the `gh codespace cp` command, including additional f You can forward a port on a codespace to a local port. The port remains forwarded as long as the process is running. To stop forwarding the port, press Control+C. ```shell -gh codespace ports forward codespace-port-number:local-port-number -c codespace-name +gh codespace ports forward CODESPACE-PORT_NAME:LOCAL-PORT-NAME -c CODESPACE-NAME ``` To see details of forwarded ports enter `gh codespace ports` and then choose a codespace. @@ -179,13 +179,13 @@ To see details of forwarded ports enter `gh codespace ports` and then choose a c You can set the visibility of a forwarded port. {% data reusables.codespaces.port-visibility-settings %} ```shell -gh codespace ports visibility codespace-port:private|org|public -c codespace-name +gh codespace ports visibility CODESPACE-PORT:private|org|public -c CODESPACE-NAME ``` You can set the visibility for multiple ports with one command. For example: ```shell -gh codespace ports visibility 80:private 3000:public 3306:org -c codespace-name +gh codespace ports visibility 80:private 3000:public 3306:org -c CODESPACE-NAME ``` For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)." @@ -195,7 +195,7 @@ For more information, see "[Forwarding ports in your codespace](/codespaces/deve You can see the creation log for a codespace. After entering this command you will be asked to enter the passphrase for your SSH key. ```shell -gh codespace logs -c codespace-name +gh codespace logs -c CODESPACE-NAME ``` For more information about the creation log, see "[{% data variables.product.prodname_github_codespaces %} logs](/codespaces/troubleshooting/github-codespaces-logs#creation-logs)." diff --git a/translations/pt-BR/content/codespaces/overview.md b/translations/pt-BR/content/codespaces/overview.md index 447eb37a352e..4c07f6674aa6 100644 --- a/translations/pt-BR/content/codespaces/overview.md +++ b/translations/pt-BR/content/codespaces/overview.md @@ -41,3 +41,5 @@ You can also personalize aspects of your codespace environment by using a public For information on pricing, storage, and usage for {% data variables.product.prodname_github_codespaces %}, see "[About billing for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." {% data reusables.codespaces.codespaces-spending-limit-requirement %} For information on how organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_github_codespaces %} for an organization, see "[Managing spending limits for {% data variables.product.prodname_github_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-github-codespaces)." + +You can see who will pay for a codespace before you create it. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)." \ No newline at end of file diff --git a/translations/pt-BR/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/translations/pt-BR/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index 1a9ef5e0f598..17139235ce37 100644 --- a/translations/pt-BR/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/translations/pt-BR/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -1,6 +1,6 @@ --- -title: Configurar diretrizes para os contribuidores do repositório -intro: Você pode criar diretrizes para informar como as pessoas devem contribuir com o projeto. +title: Setting guidelines for repository contributors +intro: You can create guidelines to communicate how people should contribute to your project. versions: fpt: '*' ghes: '*' @@ -13,59 +13,56 @@ redirect_from: topics: - Community shortTitle: Contributor guidelines -ms.openlocfilehash: b418c5a3d10f8b8f7572f33b17a9ebfbb3de27d3 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147578785' --- -## Sobre diretrizes de contribuição -Para ajudar os colaboradores do projeto a fazer um bom trabalho, você pode adicionar um arquivo com diretrizes de contribuição à raiz do repositório de projeto, a `docs` ou à pasta `.github`. Quando alguém abrir uma pull request ou criar um problema, verá um link para esse arquivo. O link usado para as diretrizes de contribuição também é exibido na página do repositório `contribute`. Para ver um exemplo de uma página `contribute`, confira [github/docs/contribute](https://github.com/github/docs/contribute). +## About contributing guidelines +To help your project contributors do good work, you can add a file with contribution guidelines to your project repository's root, `docs`, or `.github` folder. When someone opens a pull request or creates an issue, they will see a link to that file. The link to the contributing guidelines also appears on your repository's `contribute` page. For an example of a `contribute` page, see [github/docs/contribute](https://github.com/github/docs/contribute). -![diretrizes de contribuição](/assets/images/help/pull_requests/contributing-guidelines.png) +![contributing-guidelines](/assets/images/help/pull_requests/contributing-guidelines.png) -Para o proprietário do repositório, as diretrizes de contribuição são uma forma de informar como as pessoas devem contribuir. +For the repository owner, contribution guidelines are a way to communicate how people should contribute. -Para contribuidores, as diretrizes ajudam a verificar se eles estão enviando pull requests corretas e abrindo problemas úteis. +For contributors, the guidelines help them verify that they're submitting well-formed pull requests and opening useful issues. -Para proprietários e contribuidores, as diretrizes de contribuição economizam tempo e evitam aborrecimentos causados por pull requests ou problemas incorretos que precisam ser rejeitados e enviados novamente. +For both owners and contributors, contribution guidelines save time and hassle caused by improperly created pull requests or issues that have to be rejected and re-submitted. {% ifversion fpt or ghes or ghec %} -Você pode criar diretrizes de contribuição padrão para sua conta de organização{% ifversion fpt or ghes or ghec %} ou pessoal {% endif %}. Para obter mais informações, confira "[Como criar um arquivo padrão de integridade da comunidade](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)". +You can create default contribution guidelines for your organization{% ifversion fpt or ghes or ghec %} or personal account{% endif %}. For more information, see "[Creating a default community health file](//communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file)." {% endif %} {% tip %} -**Dica:** os mantenedores do repositório podem definir diretrizes específicas para problemas criando um modelo de solicitação de pull ou de problema para o repositório. Para obter mais informações, confira "[Sobre os modelos de solicitações de pull e de problemas](/articles/about-issue-and-pull-request-templates)". +**Tip:** Repository maintainers can set specific guidelines for issues by creating an issue or pull request template for the repository. For more information, see "[About issue and pull request templates](/articles/about-issue-and-pull-request-templates)." {% endtip %} -## Como adicionar um arquivo *CONTRIBUTING* - -{% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. Decida se deseja armazenar suas diretrizes de contribuição na raiz do repositório, em `docs` ou no diretório `.github`. Em seguida, no campo de nome do arquivo, digite o nome e a extensão do arquivo. Os nomes de arquivos com diretrizes de contribuição não são sensíveis a maiúsculas de minúsculas. Os arquivos são renderizados no formato de texto rich se a extensão do arquivo estiver em um formato compatível. Para obter mais informações, confira "[Como trabalhar com arquivos que não são de código](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)". - ![Nome do novo arquivo](/assets/images/help/repository/new-file-name.png) - - Para tornar as diretrizes de contribuição visíveis no diretório raiz do repositório, digite *CONTRIBUTING*. - - Para tornar as diretrizes de contribuição visíveis no diretório `docs` do repositório, digite *docs/* para criar o diretório e, depois, *CONTRIBUTING*. - - Se um repositório contiver mais de um arquivo *CONTRIBUTING*, o arquivo mostrado nos links será escolhido dos locais na seguinte ordem: o diretório `.github`, o diretório raiz do repositório e, por fim, o diretório `docs`. -4. Adicione as diretrizes de contribuição ao novo arquivo. Elas podem conter: - - Etapas para criar bons problemas ou pull requests. - - Links para documentações externas, listas de distribuição ou um código de conduta. - - Expectativas de comportamento e da comunidade. -{% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} {% data reusables.files.propose_new_file %} - -## Exemplos de diretrizes de contribuição - -Caso tenha dúvidas, estes são alguns bons exemplos de diretrizes de contribuição: - -- As [diretrizes de contribuição](https://github.com/atom/atom/blob/master/CONTRIBUTING.md) do editor do Atom. -- As [diretrizes de contribuição](https://github.com/rails/rails/blob/main/CONTRIBUTING.md) do Ruby on Rails. -- As [diretrizes de contribuição](https://github.com/opengovernment/opengovernment/blob/master/CONTRIBUTING.md) do Open Government. - -## Leitura adicional -- A seção "[Como iniciar um projeto de código aberto](https://opensource.guide/starting-a-project/)" dos Guias de Código Aberto{% ifversion fpt or ghec %} +## Adding a *CONTRIBUTING* file + +{% data reusables.repositories.navigate-to-repo %} +{% data reusables.files.add-file %} +3. Decide whether to store your contributing guidelines in your repository's root, `docs`, or `.github` directory. Then, in the filename field, type the name and extension for the file. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "[Working with non-code files](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." + ![New file name](/assets/images/help/repository/new-file-name.png) + - To make your contributing guidelines visible in the repository's root directory, type *CONTRIBUTING*. + - To make your contributing guidelines visible in the repository's `docs` directory, type *docs/* to create the new directory, then *CONTRIBUTING*. + - If a repository contains more than one *CONTRIBUTING* file, then the file shown in links is chosen from locations in the following order: the `.github` directory, then the repository's root directory, and finally the `docs` directory. +4. In the new file, add contribution guidelines. These could include: + - Steps for creating good issues or pull requests. + - Links to external documentation, mailing lists, or a code of conduct. + - Community and behavioral expectations. +{% data reusables.files.write_commit_message %} +{% data reusables.files.choose_commit_branch %} +{% data reusables.files.propose_new_file %} + +## Examples of contribution guidelines + +If you're stumped, here are some good examples of contribution guidelines: + +- 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). + +## Further reading +- The Open Source Guides' section "[Starting an Open Source Project](https://opensource.guide/starting-a-project/)"{% ifversion fpt or ghec %} - [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}){% endif %}{% ifversion fpt or ghes or ghec %} -- "[Como adicionar uma licença a um repositório](/articles/adding-a-license-to-a-repository)"{% endif %} +- "[Adding a license to a repository](/articles/adding-a-license-to-a-repository)"{% endif %} diff --git a/translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md b/translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md index 288d4f969374..42d4793a906e 100644 --- a/translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md +++ b/translations/pt-BR/content/desktop/contributing-and-collaborating-using-github-desktop/making-changes-in-a-branch/index.md @@ -1,6 +1,6 @@ --- -title: Fazer alterações em um branch -intro: 'Faça alterações no projeto usando seu editor de texto favorito, como o [Atom](https://atom.io/) e use o {% data variables.product.prodname_desktop %} para exibir commits relevantes.' +title: Making changes in a branch +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: @@ -12,11 +12,5 @@ children: - /viewing-the-branch-history - /pushing-changes-to-github shortTitle: Make changes in a branch -ms.openlocfilehash: 3ff1729cdf050f3604c383d965dda117b5a18e42 -ms.sourcegitcommit: fb047f9450b41b24afc43d9512a5db2a2b750a2a -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: '145084072' --- diff --git a/translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md b/translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md index e25b98006d25..a8274a92fa32 100644 --- a/translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md +++ b/translations/pt-BR/content/developers/apps/building-github-apps/authenticating-with-github-apps.md @@ -48,7 +48,7 @@ To verify a private key: ![Private key fingerprint](/assets/images/github-apps/github_apps_private_key_fingerprint.png) 2. Generate the fingerprint of your private key (PEM) locally by using the following command: ```shell - $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 + $ openssl rsa -in PATH_TO_PEM_FILE -pubout -outform DER | openssl sha256 -binary | openssl base64 ``` 3. Compare the results of the locally generated fingerprint to the fingerprint you see in {% data variables.product.product_name %}. diff --git a/translations/pt-BR/content/developers/overview/managing-deploy-keys.md b/translations/pt-BR/content/developers/overview/managing-deploy-keys.md index 4487ef07c98b..45e840a0232f 100644 --- a/translations/pt-BR/content/developers/overview/managing-deploy-keys.md +++ b/translations/pt-BR/content/developers/overview/managing-deploy-keys.md @@ -1,6 +1,6 @@ --- -title: Gerenciar chaves de implantação -intro: Aprenda maneiras diferentes de gerenciar chaves SSH em seus servidores ao automatizar scripts de implantação e da melhor maneira para você. +title: Managing deploy keys +intro: Learn different ways to manage SSH keys on your servers when you automate deployment scripts and which way is best for you. redirect_from: - /guides/managing-deploy-keys - /v3/guides/managing-deploy-keys @@ -14,91 +14,90 @@ versions: ghec: '*' topics: - API -ms.openlocfilehash: 425535eb582c84801d79f00df751bb48d4a5b05e -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146058465' --- -Você pode gerenciar chaves SSH em seus servidores ao automatizar scripts de implantação usando o encaminhamento do agente SSH, HTTPS com tokens do OAuth, chaves de implantação ou usuários de máquina. -## Encaminhamento de agente SSH -Em muitos casos, especialmente no início de um projeto, o encaminhamento de agentes SSH é o método mais rápido e simples de utilizar. O encaminhamento de agentes usa as mesmas chaves SSH que o seu computador de desenvolvimento local. +You can manage SSH keys on your servers when automating deployment scripts using SSH agent forwarding, HTTPS with OAuth tokens, deploy keys, or machine users. -#### Vantagens +## SSH agent forwarding -* Você não tem que gerar ou monitorar nenhuma chave nova. -* Não há gerenciamento de chaves; os usuários têm as mesmas permissões no servidor e localmente. -* Não há chaves armazenadas no servidor. Portanto, caso o servidor esteja comprometido, você não precisa buscar e remover as chaves comprometidas. +In many cases, especially in the beginning of a project, SSH agent forwarding is the quickest and simplest method to use. Agent forwarding uses the same SSH keys that your local development computer uses. -#### Desvantagens +#### Pros -* Os usuários **precisam** usar o SSH para fazer a implantação: processos de implantação automatizados não podem ser usados. -* Pode ser problemático executar o encaminhamento de agente SSH para usuários do Windows. +* You do not have to generate or keep track of any new keys. +* There is no key management; users have the same permissions on the server that they do locally. +* No keys are stored on the server, so in case the server is compromised, you don't need to hunt down and remove the compromised keys. -#### Configuração +#### Cons -1. Ativar o encaminhamento do agente localmente. Confira [nosso guia sobre o encaminhamento do agente SSH][ssh-agent-forwarding] para obter mais informações. -2. Defina seus scripts de implantação para usar o encaminhamento de agentes. Por exemplo, em um script do Bash, a habilitação do encaminhamento do agente será algo assim: `ssh -A serverA 'bash -s' < deploy.sh` +* Users **must** SSH in to deploy; automated deploy processes can't be used. +* SSH agent forwarding can be troublesome to run for Windows users. -## Clonagem de HTTPS com tokens do OAuth +#### Setup -Se você não quiser usar chaves SSH, você poderá usar HTTPS com tokens OAuth. +1. Turn on agent forwarding locally. See [our guide on SSH agent forwarding][ssh-agent-forwarding] for more information. +2. Set your deploy scripts to use agent forwarding. For example, on a bash script, enabling agent forwarding would look something like this: +`ssh -A serverA 'bash -s' < deploy.sh` -#### Vantagens +## HTTPS cloning with OAuth tokens -* Qualquer pessoa com acesso ao servidor pode implantar o repositório. -* Os usuários não precisam alterar suas configurações SSH locais. -* Não são necessários vários tokens (um para cada usuário); um token por servidor é suficiente. -* Um token pode ser revogado a qualquer momento, transformando-o, basicamente, em uma senha de uso único. +If you don't want to use SSH keys, you can use HTTPS with OAuth tokens. + +#### Pros + +* Anyone with access to the server can deploy the repository. +* Users don't have to change their local SSH settings. +* Multiple tokens (one for each user) are not needed; one token per server is enough. +* A token can be revoked at any time, turning it essentially into a one-use password. {% ifversion ghes %} -* A geração de novos tokens pode ser inserida com facilidade em um script por meio [da API do OAuth](/rest/reference/oauth-authorizations#create-a-new-authorization). +* Generating new tokens can be easily scripted using [the OAuth API](/rest/reference/oauth-authorizations#create-a-new-authorization). {% endif %} -#### Desvantagens +#### Cons -* Você deve certificar-se de configurar seu token com os escopos de acesso corretos. -* Os Tokens são, basicamente, senhas e devem ser protegidos da mesma maneira. +* You must make sure that you configure your token with the correct access scopes. +* Tokens are essentially passwords, and must be protected the same way. -#### Configuração +#### Setup -Confira [nosso guia sobre como criar um token de acesso pessoal](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). +See [our guide on creating a personal access token](/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token). -## Chaves de implantação +## Deploy keys {% data reusables.repositories.deploy-keys %} {% data reusables.repositories.deploy-keys-write-access %} -#### Vantagens +#### Pros + +* Anyone with access to the repository and server has the ability to deploy the project. +* Users don't have to change their local SSH settings. +* Deploy keys are read-only by default, but you can give them write access when adding them to a repository. -* Qualquer pessoa com acesso ao repositório e servidor é capaz de implantar o projeto. -* Os usuários não precisam alterar suas configurações SSH locais. -* As chaves de implantação são somente leitura por padrão, mas você pode dar a elas acesso de gravação ao adicioná-las a um repositório. +#### Cons -#### Desvantagens +* Deploy keys only grant access to a single repository. More complex projects may have many repositories to pull to the same server. +* Deploy keys are usually not protected by a passphrase, making the key easily accessible if the server is compromised. -* As chaves de implementação só concedem acesso a um único repositório. Projetos mais complexos podem ter muitos repositórios para extrair para o mesmo servidor. -* De modo geral, as chaves de implantação não são protegidas por uma frase secreta, o que a chave facilmente acessível se o servidor estiver comprometido. +#### Setup -#### Configuração +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. +{% data reusables.profile.navigating-to-profile %} -1. [Execute o procedimento `ssh-keygen`][generating-ssh-keys] no servidor e lembre-se do local em que salvou o par de chaves RSA público e privado gerado. -2. No canto superior direito de qualquer página do {% data variables.product.product_name %}, clique na foto do seu perfil e clique em **Seu perfil**. ![Navegação para o perfil](/assets/images/profile-page.png) -3. Na página do seu perfil, clique em **Repositórios** e clique no nome do repositório. ![Link dos repositórios](/assets/images/repos.png) -4. No seu repositório, clique em **Configurações**. ![Configurações do repositório](/assets/images/repo-settings.png) -5. Na barra lateral, clique em **Implantar Chaves** e em **Adicionar chave de implantação**. ![Link para adicionar chaves de implantação](/assets/images/add-deploy-key.png) -6. Forneça um título e cole na sua chave pública. ![Página da chave implantação](/assets/images/deploy-key.png) -7. Selecione **Permitir acesso de gravação** se desejar que essa chave tenha acesso de gravação no repositório. Uma chave de implantação com acesso de gravação permite que uma implantação faça push no repositório. -8. Clique em **Adicionar chave**. + ![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**. -#### Usar vários repositórios em um servidor +#### Using multiple repositories on one server -Se você usar vários repositórios em um servidor, você deverá gerar um par de chaves dedicado para cada um. Você não pode reutilizar uma chave de implantação para vários repositórios. +If you use multiple repositories on one server, you will need to generate a dedicated key pair for each one. You can't reuse a deploy key for multiple repositories. -No arquivo de configuração do SSH do servidor (geralmente, `~/.ssh/config`), adicione uma entrada de alias para cada repositório. Por exemplo: +In the server's SSH configuration file (usually `~/.ssh/config`), add an alias entry for each repository. For example: ```bash Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0 @@ -110,79 +109,79 @@ Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif IdentityFile=/home/user/.ssh/repo-1_deploy_key ``` -* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` – O alias do repositório. -* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` – Configura o nome do host a ser usado com o alias. -* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` – Atribui uma chave privada ao alias. +* `Host {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-0` - The repository's alias. +* `Hostname {% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}` - Configures the hostname to use with the alias. +* `IdentityFile=/home/user/.ssh/repo-0_deploy_key` - Assigns a private key to the alias. -Em seguida, você pode usar o apelido do host para interagir com o repositório usando SSH, que usará a chave de deploy exclusiva atribuída a esse pseudônimo. Por exemplo: +You can then use the hostname's alias to interact with the repository using SSH, which will use the unique deploy key assigned to that alias. For example: ```bash $ git clone git@{% ifversion fpt or ghec %}github.com{% else %}my-GHE-hostname.com{% endif %}-repo-1:OWNER/repo-1.git ``` -## Tokens do servidor para servidor +## Server-to-server tokens -Se o servidor precisar acessar repositórios em uma ou mais organizações, use um Aplicativo do GitHub para definir o acesso necessário e gere tokens _de servidor para servidor_ com _escopo delimitado_ por meio desse Aplicativo do GitHub. Os tokens do servidor para servidor podem ter escopo de repositório único ou múltiplo e podem ter permissões refinadas. Por exemplo, você pode gerar um token com acesso somente leitura para o conteúdo de um repositório. +If your server needs to access repositories across one or more organizations, you can use a GitHub App to define the access you need, and then generate _tightly-scoped_, _server-to-server_ tokens from that GitHub App. The server-to-server tokens can be scoped to single or multiple repositories, and can have fine-grained permissions. For example, you can generate a token with read-only access to a repository's contents. -Uma vez que os aplicativos GitHub são um ator de primeira classe em {% data variables.product.product_name %}, os tokens do servidor para servidor são dissociados de qualquer usuário do GitHub, o que os torna comparáveis aos "tokens de serviço". Além disso, tokens de servidor para servidor têm limites de taxa dedicados que escalam com o tamanho das organizações sobre as quais eles atuam. Para obter mais informações, confira [Limites de taxa dos {% data variables.product.prodname_github_apps %}](/developers/apps/rate-limits-for-github-apps). +Since GitHub Apps are a first class actor on {% data variables.product.product_name %}, the server-to-server tokens are decoupled from any GitHub user, which makes them comparable to "service tokens". Additionally, server-to-server tokens have dedicated rate limits that scale with the size of the organizations that they act upon. For more information, see [Rate limits for {% data variables.product.prodname_github_apps %}](/developers/apps/rate-limits-for-github-apps). -#### Vantagens +#### Pros -- Tokens com escopo limitado com conjuntos de permissões bem definidos e tempos de expiração (1 hora, ou menos se for revogado manualmente usando a API). -- Limites de taxa dedicados que crescem com a sua organização. -- Separados das identidades de usuários do GitHub para que não consumam nenhuma estação licenciada. -- Nunca concedeu uma senha. Portanto, não pode efetuar o login diretamente. +- Tightly-scoped tokens with well-defined permission sets and expiration times (1 hour, or less if revoked manually using the API). +- Dedicated rate limits that grow with your organization. +- Decoupled from GitHub user identities, so they do not consume any licensed seats. +- Never granted a password, so cannot be directly signed in to. -#### Desvantagens +#### Cons -- É necessária uma configuração adicional para criar o aplicativo GitHub. -- Os tokens de servidor para servidor expiram após 1 hora. Portanto, precisam ser gerados novamente, geralmente sob demanda e usando código. +- Additional setup is needed to create the GitHub App. +- Server-to-server tokens expire after 1 hour, and so need to be re-generated, typically on-demand using code. -#### Configuração +#### Setup -1. Determine se seu aplicativo GitHub deve ser público ou privado. Se o seu aplicativo GitHub agir apenas nos repositórios da organização, é provável que você queira que ele seja privado. -1. Determine as permissões que o aplicativo GitHub exige, como acesso somente leitura ao conteúdo do repositório. -1. Crie seu aplicativo GitHub por meio da página de configurações da sua organização. Para obter mais informações, confira [Como criar um Aplicativo do GitHub](/developers/apps/creating-a-github-app). -1. Anote a `id` do Aplicativo do GitHub. -1. Gere e faça o download da chave privada do seu aplicativo GitHub e armazene-a com segurança. Para obter mais informações, confira [Como gerar uma chave privada](/developers/apps/authenticating-with-github-apps#generating-a-private-key). -1. Instale o aplicativo GitHub nos repositórios nos quais ele precisa agir. Opcionalmente você poderá instalar o aplicativo GitHub em todos os repositórios da sua organização. -1. Identifique a `installation_id` que representa a conexão entre o Aplicativo do GitHub e os repositórios da organização que ele pode acessar. Cada par de Aplicativo do GitHub e de organização têm, no máximo, uma `installation_id`. Você pode identificar essa `installation_id` por meio de [Obter uma instalação da organização para o aplicativo autenticado](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). Isso exige a autenticação como um Aplicativo do GitHub com um JWT. Para obter mais informações, confira [Autenticação como um Aplicativo do GitHub](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). -1. Gere um token de servidor para servidor usando o ponto de extremidade da API REST correspondente: [Criar um token de acesso de instalação para um aplicativo](/rest/reference/apps#create-an-installation-access-token-for-an-app). Isso exige a autenticação como um Aplicativo do GitHub com um JWT. Para obter mais informações, confira [Autenticação como um Aplicativo do GitHub](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app) e [Autenticação como uma instalação](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). -1. Use este token de servidor para servidor para interagir com seus repositórios, seja por meio das APIs REST ou GraphQL, ou por meio de um cliente Git. +1. Determine if your GitHub App should be public or private. If your GitHub App will only act on repositories within your organization, you likely want it private. +1. Determine the permissions your GitHub App requires, such as read-only access to repository contents. +1. Create your GitHub App via your organization's settings page. For more information, see [Creating a GitHub App](/developers/apps/creating-a-github-app). +1. Note your GitHub App `id`. +1. Generate and download your GitHub App's private key, and store this safely. For more information, see [Generating a private key](/developers/apps/authenticating-with-github-apps#generating-a-private-key). +1. Install your GitHub App on the repositories it needs to act upon, optionally you may install the GitHub App on all repositories in your organization. +1. Identify the `installation_id` that represents the connection between your GitHub App and the organization repositories it can access. Each GitHub App and organization pair have at most a single `installation_id`. You can identify this `installation_id` via [Get an organization installation for the authenticated app](/rest/reference/apps#get-an-organization-installation-for-the-authenticated-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app). +1. Generate a server-to-server token using the corresponding REST API endpoint, [Create an installation access token for an app](/rest/reference/apps#create-an-installation-access-token-for-an-app). This requires authenticating as a GitHub App using a JWT, for more information see [Authenticating as a GitHub App](/developers/apps/authenticating-with-github-apps#authenticating-as-a-github-app), and [Authenticating as an installation](/developers/apps/authenticating-with-github-apps#authenticating-as-an-installation). +1. Use this server-to-server token to interact with your repositories, either via the REST or GraphQL APIs, or via a Git client. -## Usuários máquina +## Machine users -Se o servidor tiver de acessar vários repositórios, você poderá criar uma nova conta em {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} e anexar uma chave SSH que será usada exclusivamente para automatização. Como essa conta do {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} não será usada por uma pessoa, ela é chamada de _usuário de computador_. Você pode adicionar o usuário de computador como um [colaborador][collaborator] em um repositório pessoal (permitindo acesso de leitura e gravação), como um [colaborador externo][outside-collaborator] em um repositório da organização (permitindo acesso de leitura, gravação ou administrador) ou como uma [equipe][team] com acesso aos repositórios necessários para automação (concedendo as permissões da equipe). +If your server needs to access multiple repositories, you can create a new account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} and attach an SSH key that will be used exclusively for automation. Since this account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.product.product_location %}{% endif %} won't be used by a human, it's called a _machine user_. You can add the machine user as a [collaborator][collaborator] on a personal repository (granting read and write access), as an [outside collaborator][outside-collaborator] on an organization repository (granting read, write, or admin access), or to a [team][team] with access to the repositories it needs to automate (granting the permissions of the team). {% ifversion fpt or ghec %} {% tip %} -**Dica:** nossos [termos de serviço][tos] indicam: +**Tip:** Our [terms of service][tos] state: -> *Contas registradas por "bots" ou outros métodos automatizados não são permitidas.* +> *Accounts registered by "bots" or other automated methods are not permitted.* -Isto significa que você não pode automatizar a criação de contas. Mas se você desejar criar um único usuário máquina para automatizar tarefas como scripts de implantação em seu projeto ou organização, isso é muito legal. +This means that you cannot automate the creation of accounts. But if you want to create a single machine user for automating tasks such as deploy scripts in your project or organization, that is totally cool. {% endtip %} {% endif %} -#### Vantagens +#### Pros -* Qualquer pessoa com acesso ao repositório e servidor é capaz de implantar o projeto. -* Nenhum usuário (humano) precisa alterar suas configurações de SSH locais. -* Não são necessárias várias chaves; o adequado é uma por servidor. +* Anyone with access to the repository and server has the ability to deploy the project. +* No (human) users need to change their local SSH settings. +* Multiple keys are not needed; one per server is adequate. -#### Desvantagens +#### Cons -* Apenas organizações podem restringir os usuários máquina para acesso somente leitura. Os repositórios pessoais sempre concedem aos colaboradores acesso de leitura/gravação. -* Chaves dos usuário máquina, como chaves de implantação, geralmente não são protegidas por senha. +* Only organizations can restrict machine users to read-only access. Personal repositories always grant collaborators read/write access. +* Machine user keys, like deploy keys, are usually not protected by a passphrase. -#### Configuração +#### Setup -1. [Execute o procedimento `ssh-keygen`][generating-ssh-keys] no servidor e anexe a chave pública à conta do usuário de computador. -2. Dê acesso à conta de usuário máquina aos repositórios que deseja automatizar. Faça isso adicionando a conta como um [colaborador][collaborator], como um [colaborador externo][outside-collaborator] ou como uma [equipe][team] a uma organização. +1. [Run the `ssh-keygen` procedure][generating-ssh-keys] on your server and attach the public key to the machine user account. +2. Give the machine user account access to the repositories you want to automate. You can do this by adding the account as a [collaborator][collaborator], as an [outside collaborator][outside-collaborator], or to a [team][team] in an organization. [ssh-agent-forwarding]: /guides/using-ssh-agent-forwarding/ [generating-ssh-keys]: /articles/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent/#generating-a-new-ssh-key @@ -192,5 +191,5 @@ Isto significa que você não pode automatizar a criação de contas. Mas se voc [outside-collaborator]: /articles/adding-outside-collaborators-to-repositories-in-your-organization [team]: /articles/adding-organization-members-to-a-team -## Leitura adicional -- [Como configurar notificações](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) +## Further reading +- [Configuring notifications](/account-and-profile/managing-subscriptions-and-notifications-on-github/setting-up-notifications/configuring-notifications#organization-alerts-notification-options) diff --git a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md index 5125f0390988..cf3226377168 100644 --- a/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md +++ b/translations/pt-BR/content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md @@ -106,7 +106,7 @@ Activity related to a branch protection rule. For more information, see "[About - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -161,7 +161,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `created` and `completed` event types in a repository - Organization webhooks only receive payloads for the `created` and `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `rerequested` and `requested_action` event types. The `rerequested` and `requested_action` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -185,7 +185,7 @@ Key | Type | Description - Repository webhooks only receive payloads for the `completed` event types in a repository - Organization webhooks only receive payloads for the `completed` event types in repositories -- {% data variables.product.prodname_github_apps %} with the `checks:read` permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have the `checks:write` permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with the `checks:write` are automatically subscribed to this webhook event. +- {% data variables.product.prodname_github_apps %} with **Checks** read permission receive payloads for the `created` and `completed` events that occur in the repository where the app is installed. The app must have **Checks** write permission to receive the `requested` and `rerequested` event types. The `requested` and `rerequested` event type payloads are only sent to the {% data variables.product.prodname_github_app %} being requested. {% data variables.product.prodname_github_apps %} with **Checks** write permission are automatically subscribed to this webhook event. ### Webhook payload object @@ -207,7 +207,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `security_events :read` permission +- {% data variables.product.prodname_github_apps %} with **Code scanning alerts** permission ### Webhook payload object @@ -229,7 +229,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -273,7 +273,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -302,7 +302,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -345,7 +345,7 @@ Webhook events are triggered based on the specificity of the domain you register - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -370,7 +370,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `deployments` permission +- {% data variables.product.prodname_github_apps %} with **Deployments** permission ### Webhook payload object @@ -401,7 +401,7 @@ Activity related to a discussion. For more information, see the "[Using the Grap - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -427,7 +427,7 @@ Activity related to a comment in a discussion. For more information, see "[Using - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `discussions` permission +- {% data variables.product.prodname_github_apps %} with **Discussions** permission ### Webhook payload object @@ -475,7 +475,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -518,7 +518,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -576,7 +576,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -599,7 +599,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `issues` permission +- {% data variables.product.prodname_github_apps %} with **Issues** permission ### Webhook payload object @@ -622,7 +622,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -673,7 +673,7 @@ For a detailed description of this payload and the payload for each type of `act - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -695,7 +695,7 @@ For a detailed description of this payload and the payload for each type of `act ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -721,7 +721,7 @@ Activity related to merge groups in a merge queue. The type of activity is speci - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `merge_queues` permission +- {% data variables.product.prodname_github_apps %} with **Merge queues** permission ### Webhook payload object @@ -775,7 +775,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -798,7 +798,7 @@ Key | Type | Description {% ifversion ghes or ghae %} - GitHub Enterprise webhooks only receive `created` and `deleted` events. For more information, "[Global webhooks](/rest/reference/enterprise-admin#global-webhooks/).{% endif %} - Organization webhooks only receive the `deleted`, `added`, `removed`, `renamed`, and `invited` events -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -824,7 +824,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_administration` permission +- {% data variables.product.prodname_github_apps %} with **Administration** organization permission ### Webhook payload object @@ -870,7 +870,7 @@ Activity related to {% data variables.product.prodname_registry %}. {% data reus - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pages` permission +- {% data variables.product.prodname_github_apps %} with **Pages** permission ### Webhook payload object @@ -921,7 +921,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -953,7 +953,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -983,7 +983,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `repository_projects` or `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** repository or organization permission {% ifversion projects-v2 %} {% note %} @@ -1020,7 +1020,7 @@ Activity related to items in a {% data variables.projects.project_v2 %}. {% data ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `organization_projects` permission +- {% data variables.product.prodname_github_apps %} with **Projects** organization permission ### Webhook payload object @@ -1046,7 +1046,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1073,7 +1073,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1098,7 +1098,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1120,7 +1120,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1143,7 +1143,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission +- {% data variables.product.prodname_github_apps %} with **Pull requests** permission ### Webhook payload object @@ -1171,7 +1171,7 @@ Deliveries for `review_requested` and `review_request_removed` events will have - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1215,7 +1215,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `contents` permission +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1236,7 +1236,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload example @@ -1250,7 +1250,7 @@ This event occurs when a {% data variables.product.prodname_github_app %} sends - Repository webhooks receive all event types except `deleted` - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission receive all event types except `deleted` +- {% data variables.product.prodname_github_apps %} with **Metadata** permission receive all event types except `deleted` ### Webhook payload object @@ -1319,7 +1319,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1343,7 +1343,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `secret_scanning_alerts:read` permission +- {% data variables.product.prodname_github_apps %} with **Secret scanning alerts** permission ### Webhook payload object @@ -1366,7 +1366,7 @@ The security advisory dataset also powers the GitHub {% data variables.product.p ### Availability -- {% data variables.product.prodname_github_apps %} with the `security_events` permission +- {% data variables.product.prodname_github_apps %} ### Webhook payload object @@ -1391,7 +1391,7 @@ Activity related to enabling or disabling code security and analysis features fo - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with at least `read-only` access on repositories administration +- {% data variables.product.prodname_github_apps %} with **Administration** repository permission ### Webhook payload object @@ -1464,7 +1464,7 @@ You can only create a sponsorship webhook on {% data variables.product.prodname_ - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `statuses` permission +- {% data variables.product.prodname_github_apps %} with **Commit statuses** permission ### Webhook payload object @@ -1492,7 +1492,7 @@ Key | Type | Description ### Availability - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1523,7 +1523,7 @@ Key | Type | Description - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `members` permission +- {% data variables.product.prodname_github_apps %} with **Members** permission ### Webhook payload object @@ -1564,7 +1564,7 @@ The event’s actor is the [user](/rest/reference/users) who starred a repositor - Repository webhooks - Organization webhooks -- {% data variables.product.prodname_github_apps %} with the `metadata` permission +- {% data variables.product.prodname_github_apps %} with **Metadata** permission ### Webhook payload object @@ -1585,7 +1585,7 @@ This event occurs when someone triggers a workflow run on GitHub or sends a `POS ### Availability -- {% data variables.product.prodname_github_apps %} must have the `contents` permission to receive this webhook. +- {% data variables.product.prodname_github_apps %} with **Contents** permission ### Webhook payload object @@ -1634,7 +1634,7 @@ When a {% data variables.product.prodname_actions %} workflow run is requested o ### Availability -- {% data variables.product.prodname_github_apps %} with the `actions` or `contents` permissions. +- {% data variables.product.prodname_github_apps %} with **Actions** or **Contents** permissions ### Webhook payload object diff --git a/translations/pt-BR/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md b/translations/pt-BR/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md index b5e4f742a2f1..463ad45f8b7b 100644 --- a/translations/pt-BR/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md +++ b/translations/pt-BR/content/get-started/customizing-your-github-workflow/exploring-integrations/github-extensions-and-integrations.md @@ -1,6 +1,6 @@ --- -title: Extensões e integrações do GitHub -intro: 'Use extensões {% data variables.product.product_name %} para trabalhar com facilidade nos repositórios {% data variables.product.product_name %} dentro de aplicativos de terceiros.' +title: GitHub extensions and integrations +intro: 'Use {% data variables.product.product_name %} extensions to work seamlessly in {% data variables.product.product_name %} repositories within third-party applications.' redirect_from: - /articles/about-github-extensions-for-third-party-applications - /articles/github-extensions-and-integrations @@ -10,53 +10,43 @@ versions: fpt: '*' ghec: '*' shortTitle: Extensions & integrations -ms.openlocfilehash: f33ce9b9ae55e523bedff1309f3f2f15202dcf82 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147884210' --- -## Ferramentas de edição +## Editor tools -Você pode conectar-se aos repositórios do {% data variables.product.product_name %} por meio de ferramentas de editores de terceiros, como o Atom, Unity e o {% data variables.product.prodname_vs %}. +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 %} para Atom +### {% data variables.product.product_name %} for Unity -É possível fazer commits, push, pull, resolver conflitos de merge e mais no editor Atom, usando a extensão {% data variables.product.product_name %} para Atom. Para obter mais informações, confira o [site oficial do {% data variables.product.product_name %} para Atom](https://github.atom.io/). +With the {% data variables.product.product_name %} for Unity editor extension, you can develop on Unity, the open source game development platform, and see your work on {% data variables.product.product_name %}. For more information, see the official Unity editor extension [site](https://unity.github.com/) or the [documentation](https://github.com/github-for-unity/Unity/tree/master/docs). -### {% data variables.product.product_name %} para Unity +### {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} -Você pode desenvolver em Unity, a plataforma de desenvolvimento de jogos de código aberto, e ver seu trabalho em {% data variables.product.product_name %}, usando a extensão de editor {% data variables.product.product_name %} para Unity. Para obter mais informações, confira o [site](https://unity.github.com/) ou a [documentação](https://github.com/github-for-unity/Unity/tree/master/docs) oficial da extensão do editor do Unity. +With the {% data variables.product.product_name %} for {% data variables.product.prodname_vs %} extension, you can work in {% data variables.product.product_name %} repositories without leaving {% data variables.product.prodname_vs %}. For more information, see the official {% data variables.product.prodname_vs %} extension [site](https://visualstudio.github.com/) or [documentation](https://github.com/github/VisualStudio/tree/master/docs). -### {% data variables.product.product_name %} para {% data variables.product.prodname_vs %} +### {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} -Com o {% data variables.product.product_name %} para a extensão do {% data variables.product.prodname_vs %}, você pode trabalhar em repositórios do {% data variables.product.product_name %} sem sair do {% data variables.product.prodname_vs %}. Para obter mais informações, veja o [site](https://visualstudio.github.com/) ou a [documentação](https://github.com/github/VisualStudio/tree/master/docs) oficial do {% data variables.product.prodname_vs %}. +With the {% data variables.product.prodname_dotcom %} for {% data variables.product.prodname_vscode %} extension, you can review and manage {% data variables.product.product_name %} pull requests in {% data variables.product.prodname_vscode_shortname %}. For more information, see the official {% data variables.product.prodname_vscode_shortname %} extension [site](https://vscode.github.com/) or [documentation](https://github.com/Microsoft/vscode-pull-request-github). -### {% data variables.product.prodname_dotcom %} para {% data variables.product.prodname_vscode %} +## Project management tools -Com a extensão do {% data variables.product.prodname_dotcom %} para {% data variables.product.prodname_vscode %}, você pode revisar e gerenciar solicitações de pull do {% data variables.product.product_name %} no {% data variables.product.prodname_vscode_shortname %}. Para obter mais informações, veja o [site](https://vscode.github.com/) ou a [documentação](https://github.com/Microsoft/vscode-pull-request-github) oficial do {% data variables.product.prodname_vscode_shortname %}. +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party project management tools, such as Jira. -## Ferramentas de gerenciamento de projetos +### Jira Cloud and {% data variables.product.product_name %}.com integration -Você pode integrar a sua conta pessoal ou de organização no {% data variables.product.product_location %} com ferramentas de gerenciamento de projetos de terceiros, como o Jira. +You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. -### Integração Jira Cloud e {% data variables.product.product_name %}.com +## Team communication tools -É possível integrar o Jira Cloud à sua conta pessoal ou de sua organização para analisar commits e pull requests e criar metadados e hyperlinks relevantes em qualquer problema mencionado no Jira. Para obter mais informações, acesse o [aplicativo de integração do Jira](https://github.com/marketplace/jira-software-github) no marketplace. +You can integrate your personal or organization account on {% data variables.product.product_location %} with third-party team communication tools, such as Slack or Microsoft Teams. -## Ferramentas de comunicação de equipe +### Slack and {% data variables.product.product_name %} integration -Você pode integrar sua conta pessoal ou de organização no {% data variables.product.product_location %} com ferramentas de comunicação de equipes de terceiros, como o Slack ou o Microsoft Teams. +The Slack + {% data variables.product.prodname_dotcom %} app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, and you can see detailed references to issues and pull requests without leaving Slack. The app will also ping you personally in Slack if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -### Integração com Slack e {% data variables.product.product_name %} +The Slack + {% data variables.product.prodname_dotcom %} app is also compatible with [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). For more information, visit the [Slack + {% data variables.product.prodname_dotcom %} app](https://github.com/marketplace/slack-github) in the marketplace. -O aplicativo Slack + de {% data variables.product.prodname_dotcom %} permite que você assine seus repositórios ou organizações e obtenha atualizações em tempo real sobre problemas, pull requests, commits, discussões, versões, revisões de implantação e status da implantação. Você também pode executar atividades como abrir e fechar problemas, além de poder ver referências detalhadas para problemas e pull requests sem sair do Slack. O aplicativo também irá marcar você pessoalmente no Slack se você for mencionado como parte de quaisquer notificações de {% data variables.product.prodname_dotcom %} que você receber nos seus canais ou chats pessoais. +### Microsoft Teams and {% data variables.product.product_name %} integration -O aplicativo Slack + {% data variables.product.prodname_dotcom %} também é compatível com o [Slack Enterprise Grid](https://slack.com/intl/en-in/help/articles/360000281563-Manage-apps-on-Enterprise-Grid). Para obter mais informações, acesse o [aplicativo Slack + {% data variables.product.prodname_dotcom %}](https://github.com/marketplace/slack-github) no marketplace. +The {% data variables.product.prodname_dotcom %} for Teams app lets you subscribe to your repositories or organizations and get realtime updates about issues, pull requests, commits, discussions, releases, deployment reviews and deployment statuses. You can also perform activities like opening and closing issues, commenting on your issues and pull requests, and you can see detailed references to issues and pull requests without leaving Microsoft Teams. The app will also ping you personally in Teams if you are mentioned as part of any {% data variables.product.prodname_dotcom %} notifications that you receive in your channels or personal chats. -### Integração com o Microsoft Teams e {% data variables.product.product_name %} - -O {% data variables.product.prodname_dotcom %} para o aplicativo Teams permite que você assine seus repositórios ou organizações e obtenha atualizações em tempo real sobre problemas, pull requests, commits, discussões, versões, revisões de implantação e status da implantação. Você também pode realizar atividades como abrir e fechar problemas, comentar nos seus problemase pull requests, e você pode ver referências detalhadas a problemas e pull requests sem sair do Microsoft Teams. O aplicativo também irá marcar você pessoalmente no Teams se você for mencionado como parte de quaisquer notificações de {% data variables.product.prodname_dotcom %} que você receber nos seus canais ou chats pessoais. - -Para obter mais informações, acesse o [aplicativo {% data variables.product.prodname_dotcom %} para Teams](https://appsource.microsoft.com/en-us/product/office/WA200002077) no Microsoft AppSource. +For more information, visit the [{% data variables.product.prodname_dotcom %} for Teams app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/translations/pt-BR/content/get-started/getting-started-with-git/associating-text-editors-with-git.md b/translations/pt-BR/content/get-started/getting-started-with-git/associating-text-editors-with-git.md index 92066fa4796f..37d6192f7a49 100644 --- a/translations/pt-BR/content/get-started/getting-started-with-git/associating-text-editors-with-git.md +++ b/translations/pt-BR/content/get-started/getting-started-with-git/associating-text-editors-with-git.md @@ -1,6 +1,6 @@ --- -title: Associar editores de texto ao Git -intro: Use um editor de texto para abrir e editar seus arquivos com o Git. +title: Associating text editors with Git +intro: Use a text editor to open and edit your files with Git. redirect_from: - /textmate - /articles/using-textmate-as-your-default-editor @@ -15,48 +15,33 @@ versions: ghae: '*' ghec: '*' shortTitle: Associate text editors -ms.openlocfilehash: 0d02c32ff04d4a5a2a1003464175e866630603f4 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '145148749' --- {% mac %} -## Usar o Atom como seu editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale o [Atom](https://atom.io/). Para obter mais informações, confira "[Como instalar o Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" na documentação do Atom. +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. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Usando o {% data variables.product.prodname_vscode %} como editor - -1. Instale o [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obter mais informações, confira "[Configurar o {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" na documentação do {% data variables.product.prodname_vscode_shortname %}. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar o Sublime Text como seu editor +## Using Sublime Text as your editor -1. Instale o [Sublime Text](https://www.sublimetext.com/). Para obter mais informações, confira "[Instalação](https://docs.sublimetext.io/guide/getting-started/installation.html)" na documentação do Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` -## Usar o TextMate como seu editor +## Using TextMate as your editor -1. Instale o [TextMate](https://macromates.com/). -2. Instale o utilitário de shell `mate` do TextMate. Para obter mais informações, confira "[`mate` e `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" na documentação do TextMate. +1. Install [TextMate](https://macromates.com/). +2. Install TextMate's `mate` shell utility. For more information, see "[`mate` and `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -4. Digite este comando: +4. Type this command: ```shell $ git config --global core.editor "mate -w" ``` @@ -64,38 +49,29 @@ ms.locfileid: '145148749' {% windows %} -## Usar o Atom como seu editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale o [Atom](https://atom.io/). Para obter mais informações, confira "[Como instalar o Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" na documentação do Atom. +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. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Usando o {% data variables.product.prodname_vscode %} como editor - -1. Instale o [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obter mais informações, confira "[Configurar o {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" na documentação do {% data variables.product.prodname_vscode_shortname %}. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar o Sublime Text como seu editor +## Using Sublime Text as your editor -1. Instale o [Sublime Text](https://www.sublimetext.com/). Para obter mais informações, confira "[Instalação](https://docs.sublimetext.io/guide/getting-started/installation.html)" na documentação do Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w" ``` -## Usar o Notepad++ como seu editor +## Using Notepad++ as your editor -1. Instale o Notepad++ por meio de https://notepad-plus-plus.org/. Para obter mais informações, confira "[Introdução](https://npp-user-manual.org/docs/getting-started/)" na documentação do Notepad++. +1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "'C:/Program Files (x86)/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin" ``` @@ -103,29 +79,20 @@ ms.locfileid: '145148749' {% linux %} -## Usar o Atom como seu editor - -1. Instale o [Atom](https://atom.io/). Para obter mais informações, confira "[Como instalar o Atom](https://flight-manual.atom.io/getting-started/sections/installing-atom/)" na documentação do Atom. -{% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: - ```shell - $ git config --global core.editor "atom --wait" - ``` - -## Usando o {% data variables.product.prodname_vscode %} como editor +## Using {% data variables.product.prodname_vscode %} as your editor -1. Instale o [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). Para obter mais informações, confira "[Configurar o {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" na documentação do {% data variables.product.prodname_vscode_shortname %}. +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. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "code --wait" ``` -## Usar o Sublime Text como seu editor +## Using Sublime Text as your editor -1. Instale o [Sublime Text](https://www.sublimetext.com/). Para obter mais informações, confira "[Instalação](https://docs.sublimetext.io/guide/getting-started/installation.html)" na documentação do Sublime Text. +1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation. {% data reusables.command_line.open_the_multi_os_terminal %} -3. Digite este comando: +3. Type this command: ```shell $ git config --global core.editor "subl -n -w" ``` diff --git a/translations/pt-BR/content/get-started/index.md b/translations/pt-BR/content/get-started/index.md index 6e6990790974..ede63a1da2fc 100644 --- a/translations/pt-BR/content/get-started/index.md +++ b/translations/pt-BR/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/translations/pt-BR/content/get-started/quickstart/communicating-on-github.md b/translations/pt-BR/content/get-started/quickstart/communicating-on-github.md index ae87eddf3e8c..746d67c59d29 100644 --- a/translations/pt-BR/content/get-started/quickstart/communicating-on-github.md +++ b/translations/pt-BR/content/get-started/quickstart/communicating-on-github.md @@ -1,6 +1,6 @@ --- -title: Comunicar-se no GitHub -intro: 'Você pode discutir projetos e alterações específicas, bem como ideias mais amplas ou objetivos de equipe, usando diferentes tipos de discussões em {% data variables.product.product_name %}.' +title: Communicating on GitHub +intro: 'You can discuss specific projects and changes, as well as broader ideas or team goals, using different types of discussions on {% data variables.product.product_name %}.' miniTocMaxHeadingLevel: 3 redirect_from: - /github/collaborating-with-issues-and-pull-requests/getting-started/quickstart-for-communicating-on-github @@ -18,137 +18,137 @@ topics: - Issues - Discussions - Fundamentals -ms.openlocfilehash: 6c7461a01cd0bc44bff93b1eb4e8a013d26bc147 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '147408888' --- -## Introdução +## Introduction -{% data variables.product.product_name %} fornece ferramentas de comunicação colaborativa embutidas que permitem que você interaja de perto com sua comunidade. Este guia de início rápido irá mostrar como escolher a ferramenta certa para suas necessidades. +{% data variables.product.product_name %} provides built-in collaborative communication tools allowing you to interact closely with your community. This quickstart guide will show you how to pick the right tool for your needs. -{% ifversion discussions %} Você pode criar problemas, solicitações de pull, {% data variables.product.prodname_discussions %} e discussões em equipe e participar deles, dependendo do tipo de conversa que deseja ter. -{% else %} Você pode criar e participar de problemas, pull requests e discussões de equipe, dependendo do tipo de conversa que você gostaria de ter. +{% ifversion discussions %} +You can create and participate in issues, pull requests, {% data variables.product.prodname_discussions %}, and team discussions, depending on the type of conversation you'd like to have. +{% else %} +You can create and participate in issues, pull requests and team discussions, depending on the type of conversation you'd like to have. {% endif %} ### {% data variables.product.prodname_github_issues %} -- são úteis para discutir detalhes específicos de um projeto como relatórios de erros, melhorias e feedbacks planejados. -- são específicos para um repositório e geralmente têm um proprietário claro. -- muitas vezes são referidos como o sistema de rastreamento de erros de {% data variables.product.prodname_dotcom %}. +- are useful for discussing specific details of a project such as bug reports, planned improvements and feedback. +- are specific to a repository, and usually have a clear owner. +- are often referred to as {% data variables.product.prodname_dotcom %}'s bug-tracking system. -### Solicitações de pull -- permite que você proponha alterações específicas. -- permite que comente diretamente as alterações propostas por outros. -- são específicos para um repositório. +### Pull requests +- allow you to propose specific changes. +- allow you to comment directly on proposed changes suggested by others. +- are specific to a repository. {% ifversion fpt or ghec %} ### {% data variables.product.prodname_discussions %} -- são como um fórum e são mais utilizados para ideias de forma aberta e discussões em que a colaboração é importante. -- poderá incluir muitos repositórios. -- oferecem uma experiência colaborativa fora da base de código, permitindo o debate de ideias e a criação de uma base de conhecimento comunitária. -- frequentemente não têm um proprietário claro. -- muitas vezes não resultam em uma tarefa exequível. +- are like a forum, and are best used for open-form ideas and discussions where collaboration is important. +- may span many repositories. +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas, and the creation of a community knowledge base. +- often don’t have a clear owner. +- often do not result in an actionable task. {% endif %} -### Discussões em equipe -- na página da sua equipe podem ser iniciadas para conversas que abrangem projetos e não pertencem a um problema específico ou pull request. Em vez de abrir uma issue em um repositório para discutir uma ideia, você pode incluir toda a equipe tendo uma conversa em uma discussão de equipe. -- permitem que você realize discussões com sua equipe sobre planejamento, análise, design, pesquisa de usuário e tomada de decisão geral do projeto em um só lugar.{% ifversion ghes or ghae %} -- oferecem uma experiência colaborativa fora do código, o que viabiliza o levantamento de hipóteses. -- frequentemente não têm um proprietário claro. -- muitas vezes não resultam em uma tarefa útil.{% endif %} +### Team discussions +- can be started on your team's page for conversations that span across projects and don't belong in a specific issue or pull request. Instead of opening an issue in a repository to discuss an idea, you can include the entire team by having a conversation in a team discussion. +- allow you to hold discussions with your team about planning, analysis, design, user research and general project decision making in one place.{% ifversion ghes or ghae %} +- provide a collaborative experience outside the codebase, allowing the brainstorming of ideas. +- often don’t have a clear owner. +- often do not result in an actionable task.{% endif %} -## Que ferramenta de discussão devo usar? +## Which discussion tool should I use? -### Cenários para problemas +### Scenarios for issues -- Quero acompanhar as tarefas, melhorias e erros. -- Eu quero arquivar um relatório de erro. -- Quero partilhar o feedback sobre um recurso específico. -- Quero fazer uma pergunta sobre os arquivos do repositório. +- I want to keep track of tasks, enhancements and bugs. +- I want to file a bug report. +- I want to share feedback about a specific feature. +- I want to ask a question about files in the repository. -#### Exemplo de problema +#### Issue example -Este exemplo ilustra como um usuário do {% data variables.product.prodname_dotcom %} criou um problema na nossa documentação de repositório de código aberto para chamar a nossa atenção para um erro e discutir uma correção. +This example illustrates how a {% data variables.product.prodname_dotcom %} user created an issue in our documentation open source repository to make us aware of a bug, and discuss a fix. -![Exemplo de problema](/assets/images/help/issues/issue-example.png) +![Example of issue](/assets/images/help/issues/issue-example.png) -- Um usuário notou que a cor azul do banner na parte superior da página na versão em chinês da documentação do {% data variables.product.prodname_dotcom %} torna o texto no banner ilegível. -- O usuário criou um problema no repositório, identificando o problema e sugerindo uma correção (que se trata de usar uma cor de fundo diferente para o banner). -- Uma discussão se inicia e, eventualmente, será alcançado um consenso sobre a correção a ser aplicada. -- Em seguida, um contribuidor pode criar um pull request com a correção. +- A user noticed that the blue color of the banner at the top of the page in the Chinese version of the {% data variables.product.prodname_dotcom %} Docs makes the text in the banner unreadable. +- The user created an issue in the repository, stating the problem and suggesting a fix (which is, use a different background color for the banner). +- A discussion ensues, and eventually, a consensus will be reached about the fix to apply. +- A contributor can then create a pull request with the fix. -### Cenários para pull requests +### Scenarios for pull requests -- Eu quero corrigir um erro de digitação em um repositório. -- Quero fazer alterações em um repositório. -- Eu quero fazer alterações para consertar um problema. -- Eu quero comentar as alterações sugeridas por outras pessoas. +- I want to fix a typo in a repository. +- I want to make changes to a repository. +- I want to make changes to fix an issue. +- I want to comment on changes suggested by others. -#### Exemplo de solicitação de pull +#### Pull request example -Este exemplo ilustra como um usuário do {% data variables.product.prodname_dotcom %} criou um pull request na nossa documentação do repositório de código aberto para corrigir um erro de digitação. +This example illustrates how a {% data variables.product.prodname_dotcom %} user created a pull request in our documentation open source repository to fix a typo. -Na guia **Conversa** da solicitação de pull, o autor explica o motivo da criação da solicitação de pull. +In the **Conversation** tab of the pull request, the author explains why they created the pull request. -![Exemplo de pull request - aba Conversa](/assets/images/help/pull_requests/pr-conversation-example.png) +![Example of pull request - Conversation tab](/assets/images/help/pull_requests/pr-conversation-example.png) -A guia **Arquivos alterados** da solicitação de pull mostra a correção implementada. +The **Files changed** tab of the pull request shows the implemented fix. -![Exemplo de pull request - Aba de Arquivos alterados](/assets/images/help/pull_requests/pr-files-changed-example.png) +![Example of pull request - Files changed tab](/assets/images/help/pull_requests/pr-files-changed-example.png) -- Este contribuidor observa um erro de digitação no repositório. -- O usuário cria um pull request com a correção. -- Um mantenedor do repositório revisa o pull request, comenta e faz merge nela. +- This contributor notices a typo in the repository. +- The user creates a pull request with the fix. +- A repository maintainer reviews the pull request, comments on it, and merges it. {% ifversion discussions %} -### Cenários para {% data variables.product.prodname_discussions %} +### Scenarios for {% data variables.product.prodname_discussions %} -- Tenho uma pergunta que não é necessariamente relacionada a arquivos específicos no repositório. -- Eu quero compartilhar notícias com meus colaboradores ou com minha equipe. -- Eu quero começar ou participar de uma conversa aberta. -- Eu quero fazer um anúncio à minha comunidade. +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my community. -#### Exemplo de {% data variables.product.prodname_discussions %} +#### {% data variables.product.prodname_discussions %} example -Este exemplo mostra a postagem de boas-vindas de {% data variables.product.prodname_discussions %} para a documentação do repositório de código aberto {% data variables.product.prodname_dotcom %} e ilustra como a equipe quer colaborar com sua comunidade. +This example shows the {% data variables.product.prodname_discussions %} welcome post for the {% data variables.product.prodname_dotcom %} Docs open source repository, and illustrates how the team wants to collaborate with their community. -![Exemplo de {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) +![Example of {% data variables.product.prodname_discussions %}](/assets/images/help/discussions/github-discussions-example.png) -Este mantenedor da comunidade iniciou uma discussão para dar as boas-vindas à comunidade e pedir aos integrantes que se apresentem. Esta postagem promove uma atmosfera de acolhedora para visitantes e contribuidores. A postagem também esclarece que a equipe tem o prazer em ajudar com as contribuições para o repositório. +This community maintainer started a discussion to welcome the community, and to ask members to introduce themselves. This post fosters an inviting atmosphere for visitors and contributors. The post also clarifies that the team's happy to help with contributions to the repository. {% endif %} -### Cenários para discussões em equipe +### Scenarios for team discussions -- Tenho uma pergunta que não é necessariamente relacionada a arquivos específicos no repositório. -- Eu quero compartilhar notícias com meus colaboradores ou com minha equipe. -- Eu quero começar ou participar de uma conversa aberta. -- Eu quero fazer um anúncio à minha equipe. +- I have a question that's not necessarily related to specific files in the repository. +- I want to share news with my collaborators, or my team. +- I want to start or participate in an open-ended conversation. +- I want to make an announcement to my team. -{% ifversion fpt or ghec %} Como você pode ver, as discussões em equipe são muito parecidas com o {% data variables.product.prodname_discussions %}. Para {% data variables.product.prodname_dotcom_the_website %}, recomendamos usar {% data variables.product.prodname_discussions %} como ponto de partida para conversas. Você pode usar {% data variables.product.prodname_discussions %} para colaborar com qualquer comunidade em {% data variables.product.prodname_dotcom %}. Se você faz parte de uma organização e gostaria de iniciar conversas dentro da sua organização ou equipe dentro dessa organização, você deverá usar discussões de equipe. +{% ifversion fpt or ghec %} +As you can see, team discussions are very similar to {% data variables.product.prodname_discussions %}. For {% data variables.product.prodname_dotcom_the_website %}, we recommend using {% data variables.product.prodname_discussions %} as the starting point for conversations. You can use {% data variables.product.prodname_discussions %} to collaborate with any community on {% data variables.product.prodname_dotcom %}. If you are part of an organization, and would like to initiate conversations within your organization or team within that organization, you should use team discussions. {% endif %} -#### Exemplo de discussão em equipe +#### Team discussion example -Este exemplo mostra uma postagem da equipe para a equipe `octo-team`. +This example shows a team post for the `octo-team` team. -![Exemplo de discussão em equipe](/assets/images/help/projects/team-discussions-example.png) +![Example of team discussion](/assets/images/help/projects/team-discussions-example.png) -O membro da equipe `octocat` postou uma discussão em equipe, informando a equipe de várias coisas: -- Um integrante da equipe denominado Mona iniciou eventos remotos de jogos. -- Há uma postagem no blogue que descreve como as equipes usam {% data variables.product.prodname_actions %} para produzir sua documentação. -- Material sobre a "All Hands" de Abril agora está disponível para ver todos os integrantes da equipe. +The `octocat` team member posted a team discussion, informing the team of various things: +- A team member called Mona started remote game events. +- There is a blog post describing how the teams use {% data variables.product.prodname_actions %} to produce their docs. +- Material about the April All Hands is now available for all team members to view. -## Próximas etapas +## Next steps -Estes exemplos mostraram como decidir qual é a melhor ferramenta para suas conversas em {% data variables.product.product_name %}. Mas esse é apenas o começo; há muito mais que você pode fazer para adaptar essas ferramentas às suas necessidades. +These examples showed you how to decide which is the best tool for your conversations on {% data variables.product.product_name %}. But this is only the beginning; there is so much more you can do to tailor these tools to your needs. -Para problemas, por exemplo, você pode marcar problemas com etiquetas para uma pesquisa mais rápida e criar modelos de problemas para ajudar os colaboradores a abrir problemas significativos. Para obter mais informações, confira "[Sobre os modelos de solicitações de pull](/github/managing-your-work-on-github/about-issues#working-with-issues)[ e de problemas](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)". +For issues, for example, you can tag issues with labels for quicker searching and create issue templates to help contributors open meaningful issues. For more information, see "[About issues](/github/managing-your-work-on-github/about-issues#working-with-issues)" and "[About issue and pull request templates](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." -Para pull requests, você pode criar pull requests de rascunho se as suas alterações propostas ainda forem um trabalho em andamento. Não é possível fazer o merge dos pull requests de rascunho até que estejam prontos para revisão. Para obter mais informações, confira "[Sobre as solicitações de pull](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)". +For pull requests, you can create draft pull requests if your proposed changes are still a work in progress. Draft pull requests cannot be merged until they're marked as ready for review. For more information, see "[About pull requests](/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests)." -{% ifversion discussions %} Para o {% data variables.product.prodname_discussions %}, você pode {% ifversion fpt or ghec %} configurar um código de conduta e{% endif %} fixar discuessões que contêm informações importantes para sua comunidade. Para obter mais informações, confira "[Sobre as discussões](/discussions/collaborating-with-your-community-using-discussions/about-discussions)". +{% ifversion discussions %} +For {% data variables.product.prodname_discussions %}, you can{% ifversion fpt or ghec %} set up a code of conduct and{% endif %} pin discussions that contain important information for your community. For more information, see "[About discussions](/discussions/collaborating-with-your-community-using-discussions/about-discussions)." {% endif %} -Para discussões em equipe, você pode editar ou excluir discussões na página de uma equipe, além de poder configurar notificações para discussões em equipe. Para obter mais informações, confira "[Sobre as discussões em equipe](/organizations/collaborating-with-your-team/about-team-discussions)". +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/translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md b/translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md index dc3a8ab79bd7..a4f544484c70 100644 --- a/translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md +++ b/translations/pt-BR/content/get-started/quickstart/git-and-github-learning-resources.md @@ -1,12 +1,12 @@ --- -title: Recursos de aprendizagem Git e GitHub +title: Git and GitHub learning resources redirect_from: - /articles/good-resources-for-learning-git-and-github - /articles/what-are-other-good-resources-for-learning-git-and-github - /articles/git-and-github-learning-resources - /github/getting-started-with-github/git-and-github-learning-resources - /github/getting-started-with-github/quickstart/git-and-github-learning-resources -intro: 'Existem muitos recursos Git e {% data variables.product.product_name %} na Web. Essa é uma lista de nossos preferidos!' +intro: 'There are a lot of helpful Git and {% data variables.product.product_name %} resources on the web. This is a short list of our favorites!' versions: fpt: '*' ghes: '*' @@ -15,55 +15,49 @@ versions: authors: - GitHub shortTitle: Learning resources -ms.openlocfilehash: d8d0457de2842392febee0c90660285e9b1afef8 -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: '146139293' --- -## Usar o Git +## Using Git -Familiarize-se com o Git acessando o [site oficial do projeto Git](https://git-scm.com) e lendo o [livro ProGit](http://git-scm.com/book). Você também pode revisar a [Lista de comandos do Git](https://git-scm.com/docs). +Familiarize yourself with Git by visiting the [official Git project site](https://git-scm.com) and reading the [ProGit book](http://git-scm.com/book). You can also review the [Git command list](https://git-scm.com/docs). -## Usar {% data variables.product.product_name %} +## Using {% data variables.product.product_name %} {% ifversion fpt or ghec %} -O {% data variables.product.prodname_learning %} oferece cursos interativos grátis que são desenvolvidos em {% data variables.product.prodname_dotcom %} e possuem ajuda e respostas automáticas e instantâneas. Aprenda a abrir sua primeira pull request, fazer sua primeira contribuição a um código aberto, criar um site {% data variables.product.prodname_pages %} e muito mais. Para obter mais informações sobre as ofertas de cursos, confira [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). +{% data variables.product.prodname_learning %} offers free interactive courses that are built into {% data variables.product.prodname_dotcom %} with instant automated feedback and help. Learn to open your first pull request, make your first open source contribution, create a {% data variables.product.prodname_pages %} site, and more. For more information about course offerings, see [{% data variables.product.prodname_learning %}]({% data variables.product.prodname_learning_link %}). {% endif %} -Familiarize-se melhor com o {% data variables.product.product_name %} por meio de nossos artigos de [introdução](/categories/getting-started-with-github/). Confira nosso [fluxo do {% data variables.product.prodname_dotcom %}](https://guides.github.com/introduction/flow) para ver uma introdução ao processo. Veja nossos [guias de visão geral](https://guides.github.com) para aprender conceitos básicos. +Become better acquainted with {% data variables.product.product_name %} through our [getting started](/categories/getting-started-with-github/) articles. See our [{% data variables.product.prodname_dotcom %} flow](https://guides.github.com/introduction/flow) for a process introduction. Refer to our [overview guides](https://guides.github.com) to walk through basic concepts. {% data reusables.support.ask-and-answer-forum %} -### Branches, bifurcações e pull requests +### Branches, forks, and pull requests -Saiba mais sobre a [ramificação do Git](http://learngitbranching.js.org/) usando uma ferramenta interativa. Leia mais sobre [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) e [solicitações de pull](/articles/using-pull-requests) e descubra [como usamos as solicitações de pull](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) no {% data variables.product.prodname_dotcom %}. Acesse as referências sobre como usar o {% data variables.product.prodname_dotcom %} na [linha de comando](https://cli.github.com/). +Learn about [Git branching](http://learngitbranching.js.org/) using an interactive tool. Read about [forks](/pull-requests/collaborating-with-pull-requests/working-with-forks/about-forks) and [pull requests](/articles/using-pull-requests) as well as [how we use pull requests](https://github.com/blog/1124-how-we-use-pull-requests-to-build-github) at {% data variables.product.prodname_dotcom %}. Access references about using {% data variables.product.prodname_dotcom %} from the [command line](https://cli.github.com/). -### Fique antenado +### Tune in -Nosso [canal de Treinamento e Guias no YouTube](https://youtube.com/githubguides) do {% data variables.product.prodname_dotcom %} oferece tutoriais sobre [solicitações de pull](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [criação de forks](https://www.youtube.com/watch?v=5oJHRbqEofs), [troca de base](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22) e funções de [redefinição](https://www.youtube.com/watch?v=BKPjPMVB81g). Cada tema é abordado em cinco minutos ou menos. +Our {% data variables.product.prodname_dotcom %} [YouTube Training and Guides channel](https://youtube.com/githubguides) offers tutorials about [pull requests](https://www.youtube.com/watch?v=d5wpJ5VimSU&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=19), [forking](https://www.youtube.com/watch?v=5oJHRbqEofs), [rebase](https://www.youtube.com/watch?v=SxzjZtJwOgo&list=PLg7s6cbtAD15G8lNyoaYDuKZSKyJrgwB-&index=22), and [reset](https://www.youtube.com/watch?v=BKPjPMVB81g) functions. Each topic is covered in 5 minutes or less. -## Treinamento +## Training -### Cursos grátis +### Free courses -O {% data variables.product.product_name %} oferece uma série de [cursos de treinamento interativos sob demanda](https://skills.github.com/), incluindo [Introdução ao {% data variables.product.prodname_dotcom %}](https://github.com/skills/introduction-to-github) e cursos sobre ferramentas específicas do {% data variables.product.product_name %}, como o {% data variables.product.prodname_actions %}. +{% data variables.product.product_name %} offers a series of interactive, [on-demand training courses](https://skills.github.com/) including [Introduction to {% data variables.product.prodname_dotcom %}](https://github.com/skills/introduction-to-github); and courses on {% data variables.product.product_name %} specific tools such as {% data variables.product.prodname_actions %}. -### Programas educacionais online do {% data variables.product.prodname_dotcom %} +### {% data variables.product.prodname_dotcom %}'s web-based educational programs -O {% data variables.product.prodname_dotcom %} oferece [treinamentos](https://services.github.com/#upcoming-events) online com uma abordagem prática baseada em projeto tanto para aqueles que adoram a linha de comando quanto para aqueles que não gostam dela. +{% data variables.product.prodname_dotcom %} offers live [trainings](https://services.github.com/#upcoming-events) with a hands-on, project-based approach for those who love the command line and those who don't. -### Treinamentos para sua empresa +### Training for your company -O {% data variables.product.prodname_dotcom %} oferece [aulas presenciais](https://services.github.com/#offerings) ministradas por nossos educadores altamente experientes. [Fale conosco](https://services.github.com/#contact) para fazer perguntas relacionadas ao treinamento. +{% data variables.product.prodname_dotcom %} offers [in-person classes](https://services.github.com/#offerings) taught by our highly-experienced educators. [Contact us](https://services.github.com/#contact) to ask your training-related questions. ## Extras -Um [curso interativo do Git online](https://www.pluralsight.com/courses/code-school-git-real) do [Pluralsight](https://www.pluralsight.com/codeschool) traz sete níveis com dezenas de exercícios em um formato de jogo divertido. Fique à vontade para adaptar nossos [modelos .gitignore](https://github.com/github/gitignore) de acordo com suas necessidades. +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. -Estenda o alcance do {% data variables.product.prodname_dotcom %} por meio de {% ifversion fpt or ghec %}[integrações](/articles/about-integrations){% else %}integrações{% endif %} ou instalando o [{% data variables.product.prodname_desktop %}](https://desktop.github.com) e o robusto editor de texto [Atom](https://atom.io). +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. -Saiba como iniciar e expandir seu projeto de código aberto com os [Guias de Código Aberto](https://opensource.guide/). +Learn how to launch and grow your open source project with the [Open Source Guides](https://opensource.guide/). diff --git a/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md b/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md index ee4ed80fa280..ffec457383f4 100644 --- a/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md +++ b/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github.md @@ -1,6 +1,6 @@ --- -title: Sobre gravação e formatação no GitHub -intro: O GitHub combina uma sintaxe para formatar texto chamada markdown em estilo GitHub com alguns recursos de escrita exclusivos. +title: About writing and formatting on GitHub +intro: GitHub combines a syntax for formatting text called GitHub Flavored Markdown with a few unique writing features. redirect_from: - /articles/about-writing-and-formatting-on-github - /github/writing-on-github/about-writing-and-formatting-on-github @@ -10,40 +10,36 @@ versions: ghes: '*' ghae: '*' ghec: '*' -shortTitle: Write & format on GitHub -ms.openlocfilehash: 7819ebc6bbf3ffa8696c87f82745a19c103c8134 -ms.sourcegitcommit: 478f2931167988096ae6478a257f492ecaa11794 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/09/2022 -ms.locfileid: '147860831' +shortTitle: About writing & formatting --- -[Markdown](http://daringfireball.net/projects/markdown/) é uma sintaxe fácil de ler e de gravar para formatar textos sem formatação. +[Markdown](http://daringfireball.net/projects/markdown/) is an easy-to-read, easy-to-write syntax for formatting plain text. -Adicionamos algumas funcionalidades personalizadas para criar o markdown em estilo {% data variables.product.prodname_dotcom %}, usadas para formatar prosa e código em nosso site. +We've added some custom functionality to create {% data variables.product.prodname_dotcom %} Flavored Markdown, used to format prose and code across our site. -Você também pode interagir com outros usuários em solicitações de pull e problemas usando recursos como [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [referências de problemas e de RP](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests) e [emojis](/articles/basic-writing-and-formatting-syntax/#using-emoji). +You can also interact with other users in pull requests and issues using features like [@mentions](/articles/basic-writing-and-formatting-syntax/#mentioning-people-and-teams), [issue and PR references](/articles/basic-writing-and-formatting-syntax/#referencing-issues-and-pull-requests), and [emoji](/articles/basic-writing-and-formatting-syntax/#using-emoji). -## Barra de ferramentas de formatação de texto +## Text formatting toolbar -Cada campo de comentário no {% data variables.product.product_name %} contém uma barra de ferramentas de formatação de texto, permitindo que você formate texto sem precisar aprender a sintaxe markdown. Além da formatação Markdown, como estilos em negrito e itálico e criação de cabeçalhos, links e listas, a barra de ferramentas inclui recursos específicos do {% data variables.product.product_name %}, como @mentions, listas de tarefas e links para problemas e solicitações de pull. +Every comment field on {% data variables.product.product_name %} contains a text formatting toolbar, allowing you to format your text without learning Markdown syntax. In addition to Markdown formatting like bold and italic styles and creating headers, links, and lists, the toolbar includes {% data variables.product.product_name %}-specific features such as @mentions, task lists, and links to issues and pull requests. {% ifversion fixed-width-font-gfm-fields %} -## Habilitando fontes de largura fixa no editor +## Enabling fixed-width fonts in the editor -Você pode habilitar uma fonte de largura fixa em cada campo de comentário em {% data variables.product.product_name %}. Cada caractere em uma largura fixa, ou em monoespaço, a fonte ocupa o mesmo espaço horizontal que pode facilitar a edição de estruturas avançadas de Markdown, como tabelas e trechos de código. +You can enable a fixed-width font in every comment field on {% data variables.product.product_name %}. Each character in a fixed-width, or monospace, font occupies the same horizontal space which can make it easier to edit advanced Markdown structures such as tables and code snippets. -![Captura de tela que mostra o campo comentário de {% data variables.product.product_name %} com as fontes de largura fixa habilitadas](/assets/images/help/writing/fixed-width-example.png) +![Screenshot showing the {% data variables.product.product_name %} comment field with fixed-width fonts enabled](/assets/images/help/writing/fixed-width-example.png) -{% data reusables.user-settings.access_settings %} {% data reusables.user-settings.appearance-settings %} -1. Em "Preferência de fonte do editor Markdown", selecione **Usar uma fonte de largura fixa (com espaçamento uniforme) ao editar Markdown**. - ![Captura de tela que mostra o campo de comentário do {% data variables.product.product_name %} com as fontes de largura fixa habilitadas](/assets/images/help/writing/enable-fixed-width.png) +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.appearance-settings %} +1. Under "Markdown editor font preference", select **Use a fixed-width (monospace) font when editing Markdown**. + ![Screenshot showing the {% data variables.product.product_name %} comment field with fixed width fonts enabled](/assets/images/help/writing/enable-fixed-width.png) {% endif %} -## Leitura adicional +## Further reading -- [Especificações do {% data variables.product.prodname_dotcom %} Flavored Markdown](https://github.github.com/gfm/) -- "[Sintaxe básica de escrita e formatação](/articles/basic-writing-and-formatting-syntax)" -- "[Como trabalhar com formatação avançada](/articles/working-with-advanced-formatting)" +- [{% 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/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index a7321a27c974..b229b71ca3b2 100644 --- a/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/translations/pt-BR/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/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md b/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md index 6e7830899a1a..5cc3a9747c2a 100644 --- a/translations/pt-BR/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/index.md +++ b/translations/pt-BR/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/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md b/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md index 44fc59d19057..5f0436ff5f0c 100644 --- a/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md +++ b/translations/pt-BR/content/issues/planning-and-tracking-with-projects/automating-your-project/using-the-api-to-manage-projects.md @@ -70,8 +70,8 @@ You can find the node ID of an organization project if you know the organization ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{organization(login: \"ORGANIZATION\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -79,8 +79,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION"){ - projectV2(number: NUMBER) { + organization(login: "ORGANIZATION"){ + projectV2(number: NUMBER) { id } } @@ -94,8 +94,8 @@ You can also find the node ID of all projects in your organization. The followin ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{organization(login: \"ORGANIZATION\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{organization(login: \"ORGANIZATION") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -103,7 +103,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - organization(login: "ORGANIZATION") { + organization(login: "ORGANIZATION") { projectsV2(first: 20) { nodes { id @@ -125,8 +125,8 @@ You can find the node ID of a user project if you know the project number. Repla ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{user(login: \"USER\") {projectV2(number: NUMBER){id}}}"}' ``` {% endcurl %} @@ -134,8 +134,8 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER"){ - projectV2(number: NUMBER) { + user(login: "USER"){ + projectV2(number: NUMBER) { id } } @@ -149,8 +149,8 @@ You can also find the node ID for all of your projects. The following example wi ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"{user(login: \"USER\") {projectsV2(first: 20) {nodes {id title}}}}"}' ``` {% endcurl %} @@ -158,7 +158,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - user(login: "USER") { + user(login: "USER") { projectsV2(first: 20) { nodes { id @@ -180,8 +180,8 @@ The following example will return the ID, name, settings, and configuration for ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2Field { id name } ... on ProjectV2IterationField { id name configuration { iterations { startDate id }}} ... on ProjectV2SingleSelectField { id name options { id name }}}}}}}"}' ``` {% endcurl %} @@ -189,7 +189,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -284,8 +284,8 @@ If you just need the name and ID of a field, and do not need information about i ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { fields(first: 20) { nodes { ... on ProjectV2FieldCommon { id name }}}}}}"}' ``` {% endcurl %} @@ -293,7 +293,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { fields(first: 20) { nodes { @@ -354,8 +354,8 @@ The following example will return the first 20 issues, pull requests, and draft ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"query{ node(id: \"PROJECT_ID\") { ... on ProjectV2 { items(first: 20) { nodes{ id fieldValues(first: 8) { nodes{ ... on ProjectV2ItemFieldTextValue { text field { ... on ProjectV2FieldCommon { name }}} ... on ProjectV2ItemFieldDateValue { date field { ... on ProjectV2FieldCommon { name } } } ... on ProjectV2ItemFieldSingleSelectValue { name field { ... on ProjectV2FieldCommon { name }}}}} content{ ... on DraftIssue { title body } ...on Issue { title assignees(first: 10) { nodes{ login }}} ...on PullRequest { title assignees(first: 10) { nodes{ login }}}}}}}}}"}' ``` {% endcurl %} @@ -363,7 +363,7 @@ curl --request POST \ ```shell gh api graphql -f query=' query{ - node(id: "PROJECT_ID") { + node(id: "PROJECT_ID") { ... on ProjectV2 { items(first: 20) { nodes{ @@ -446,8 +446,8 @@ The following example will add an issue or pull request to your project. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2ItemById(input: {projectId: \"PROJECT_ID\" contentId: \"CONTENT_ID\"}) {item {id}}}"}' ``` {% endcurl %} @@ -455,7 +455,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { + addProjectV2ItemById(input: {projectId: "PROJECT_ID" contentId: "CONTENT_ID"}) { item { id } @@ -488,8 +488,8 @@ The following example will add a draft issue to your project. Replace `PROJECT_I ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) {projectItem {id}}}"}' ``` {% endcurl %} @@ -497,7 +497,7 @@ curl --request POST \ ```shell gh api graphql -f query=' mutation { - addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { + addProjectV2DraftIssue(input: {projectId: "PROJECT_ID" title: "TITLE" body: "BODY"}) { projectItem { id } @@ -528,8 +528,8 @@ The following example will update your project's settings. Replace `PROJECT_ID` ```shell curl --request POST \ --url https://api.github.com/graphql \ ---header 'Authorization: Bearer TOKEN' \ ---data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' +--header 'Authorization: Bearer TOKEN' \ +--data '{"query":"mutation { updateProjectV2(input: { projectId: \"PROJECT_ID\", title: \"Project title\", public: false, readme: \"# Project README\n\nA long description\", shortDescription: \"A short description\"}) { projectV2 { id, title, readme, shortDescription }}}"}' ``` {% endcurl %} @@ -539,7 +539,7 @@ gh api graphql -f query=' mutation { updateProjectV2( input: { - projectId: "PROJECT_ID", + projectId: "PROJECT_ID", title: "Project title", public: false, readme: "# Project README\n\nA long description", @@ -565,8 +565,8 @@ The following example will update the value of a text field for an item. Replace ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { text: "Updated text" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -576,9 +576,9 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { text: "Updated text" } @@ -619,8 +619,8 @@ The following example will update the value of a single select field for an item ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -630,11 +630,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - singleSelectOptionId: "OPTION_ID" + singleSelectOptionId: "OPTION_ID" } } ) { @@ -659,8 +659,8 @@ The following example will update the value of an iteration field for an item. ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {updateProjectV2ItemFieldValue( input: { projectId: "PROJECT_ID" itemId: "ITEM_ID" fieldId: "FIELD_ID" value: { singleSelectOptionId: "OPTION_ID" }}) { projectV2Item { id }}}"}' ``` {% endcurl %} @@ -670,11 +670,11 @@ gh api graphql -f query=' mutation { updateProjectV2ItemFieldValue( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" - fieldId: "FIELD_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" + fieldId: "FIELD_ID" value: { - iterationId: "ITERATION_ID" + iterationId: "ITERATION_ID" } } ) { @@ -694,8 +694,8 @@ The following example will delete an item from a project. Replace `PROJECT_ID` w ```shell curl --request POST \ --url https://api.github.com/graphql \ - --header 'Authorization: Bearer TOKEN' \ - --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' + --header 'Authorization: Bearer TOKEN' \ + --data '{"query":"mutation {deleteProjectV2Item(input: {projectId: \"PROJECT_ID\" itemId: \"ITEM_ID\"}) {deletedItemId}}"}' ``` {% endcurl %} @@ -705,8 +705,8 @@ gh api graphql -f query=' mutation { deleteProjectV2Item( input: { - projectId: "PROJECT_ID" - itemId: "ITEM_ID" + projectId: "PROJECT_ID" + itemId: "ITEM_ID" } ) { deletedItemId diff --git a/translations/pt-BR/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md b/translations/pt-BR/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md index aae7367309e0..adbebde7eee8 100644 --- a/translations/pt-BR/content/issues/tracking-your-work-with-issues/filtering-and-searching-issues-and-pull-requests.md +++ b/translations/pt-BR/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/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e1c0cc329d27..44bb21d7474a 100644 --- a/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/translations/pt-BR/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -62,11 +62,11 @@ For more information on Punycodes, see [Internationalized domain name](https://e {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM. IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . + > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -104,19 +104,19 @@ To set up an apex domain, such as `example.com`, you must configure a custom dom 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. - For `A` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t A - > EXAMPLE.COM 3600 IN A 185.199.108.153 - > EXAMPLE.COM 3600 IN A 185.199.109.153 - > EXAMPLE.COM 3600 IN A 185.199.110.153 - > EXAMPLE.COM 3600 IN A 185.199.111.153 + $ dig EXAMPLE.COM +noall +answer -t A + > EXAMPLE.COM 3600 IN A 185.199.108.153 + > EXAMPLE.COM 3600 IN A 185.199.109.153 + > EXAMPLE.COM 3600 IN A 185.199.110.153 + > EXAMPLE.COM 3600 IN A 185.199.111.153 ``` - For `AAAA` records. ```shell - $ dig EXAMPLE.COM +noall +answer -t AAAA - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 - > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 + $ dig EXAMPLE.COM +noall +answer -t AAAA + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8000::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8001::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8002::153 + > EXAMPLE.COM 3600 IN AAAA 2606:50c0:8003::153 ``` {% data reusables.pages.build-locally-download-cname %} {% data reusables.pages.enforce-https-custom-domain %} @@ -132,11 +132,11 @@ After you configure the apex domain, you must configure a CNAME record with your 1. Navigate to your DNS provider and create a `CNAME` record that points `www.example.com` to the default domain for your site: `.github.io` or `.github.io`. Do not include the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} 2. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your `www` subdomain variant. ```shell - $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd - > ;WWW.EXAMPLE.COM. IN A - > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. - > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER . - > GITHUB-PAGES-SERVER . 22 IN A 192.0.2.1 + $ dig WWW.EXAMPLE.COM +nostats +nocomments +nocmd + > ;WWW.EXAMPLE.COM IN A + > WWW.EXAMPLE.COM. 3592 IN CNAME YOUR-USERNAME.github.io. + > YOUR-USERNAME.github.io. 43192 IN CNAME GITHUB-PAGES-SERVER. + > GITHUB-PAGES-SERVER. 22 IN A 192.0.2.1 ``` ## Removing a custom domain diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md index 36e34a57def9..a53dcfa122db 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line.md @@ -1,6 +1,6 @@ --- -title: Resolver um conflito de merge usando a linha de comando -intro: Você pode resolver conflitos de merge usando a linha de comando e um editor de texto. +title: Resolving a merge conflict using the command line +intro: You can resolve merge conflicts using the command line and a text editor. redirect_from: - /github/collaborating-with-issues-and-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-using-the-command-line - /articles/resolving-a-merge-conflict-from-the-command-line @@ -15,33 +15,27 @@ versions: topics: - Pull requests shortTitle: Resolve merge conflicts in Git -ms.openlocfilehash: 1d4ff97c2a93d3e5a7aebaa8752810e284203bc1 -ms.sourcegitcommit: fcf3546b7cc208155fb8acdf68b81be28afc3d2d -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/11/2022 -ms.locfileid: '147883454' --- -Os conflitos de merge ocorrem quando alterações concorrentes são feitas na mesma linha de um arquivo ou quando uma pessoa edita um arquivo e outra pessoa exclui o mesmo arquivo. Para obter mais informações, confira "[Sobre os conflitos de mesclagem](/articles/about-merge-conflicts/)". +Merge conflicts occur when competing changes are made to the same line of a file, or when one person edits a file and another person deletes the same file. For more information, see "[About merge conflicts](/articles/about-merge-conflicts/)." {% tip %} -**Dica:** use o editor de conflitos do {% data variables.product.product_name %} para resolver conflitos de mesclagem de alterações de linha concorrentes entre branches que fazem parte de uma solicitação de pull. Para obter mais informações, confira "[Como resolver um conflito de mesclagem no GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)". +**Tip:** You can use the conflict editor on {% data variables.product.product_name %} to resolve competing line change merge conflicts between branches that are part of a pull request. For more information, see "[Resolving a merge conflict on GitHub](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/resolving-a-merge-conflict-on-github)." {% endtip %} -## Conflitos de merge de alterações diferentes na linha +## Competing line change merge conflicts -Para resolver um conflito de merge causado por alterações diferentes na linha, você deve escolher quais alterações dos diferentes branches incorporar em um novo commit. +To resolve a merge conflict caused by competing line changes, you must choose which changes to incorporate from the different branches in a new commit. -Por exemplo, se você e outra pessoa editarem o arquivo _styleguide.md_ nas mesmas linhas em branches diferentes do mesmo repositório Git, você receberá um erro de conflito de mesclagem ao tentar mesclar esses branches. Você deve resolver esse conflito de merge com um novo commit antes de fazer merge desses branches. +For example, if you and another person both edited the file _styleguide.md_ on the same lines in different branches of the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navegue até o repositório Git local que tem o conflito de merge. +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -3. Gere uma lista dos arquivos afetados pelo conflito de merge. Neste exemplo, o arquivo *styleguide.md* tem um conflito de mesclagem. +3. Generate a list of the files affected by the merge conflict. In this example, the file *styleguide.md* has a merge conflict. ```shell $ git status > # On branch branch-b @@ -55,8 +49,8 @@ Por exemplo, se você e outra pessoa editarem o arquivo _styleguide.md_ nas mesm > # > no changes added to commit (use "git add" and/or "git commit -a") ``` -4. Abra seu editor de texto favorito, como o [Atom](https://atom.io/), e procure o arquivo que contém conflitos de mesclagem. -5. Para ver o início do conflito de mesclagem no arquivo, pesquise o marcador de conflito `<<<<<<<` no arquivo. Ao abrir o arquivo no editor de texto, você verá as alterações do branch HEAD ou base após a linha `<<<<<<< HEAD`. Em seguida, você verá `=======`, o que divide as alterações das alterações no outro branch, seguido de `>>>>>>> BRANCH-NAME`. Neste exemplo, uma pessoa escreveu "abra um problema" no branch HEAD ou base e outra pessoa escreveu "faça sua pergunta no IRC" no branch de comparação ou `branch-a`. +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`. ``` If you have questions, please @@ -66,34 +60,34 @@ Por exemplo, se você e outra pessoa editarem o arquivo _styleguide.md_ nas mesm ask your question in IRC. >>>>>>> branch-a ``` -{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} Neste exemplo, as duas alterações são incorporadas ao merge final: +{% data reusables.pull_requests.decide-how-to-resolve-competing-line-change-merge-conflict %} In this example, both changes are incorporated into the final merge: ```shell If you have questions, please open an issue or ask in our IRC channel if it's more urgent. ``` -7. Adicione ou faça stage das alterações. +7. Add or stage your changes. ```shell $ git add . ``` -8. Faça o commit das suas alterações com um comentário. +8. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by incorporating both suggestions." ``` -Agora você pode mesclar os branches na linha de comando ou [efetuar push das alterações para o repositório remoto](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) no {% data variables.product.product_name %} e [mesclar as alterações](/articles/merging-a-pull-request/) em uma solicitação de pull. +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## Conflitos de merge de arquivo removido +## Removed file merge conflicts -Para resolver um conflito de merge causado por alterações concorrentes em um arquivo, quando uma pessoa exclui um arquivo em um branch e outra pessoa edita o mesmo arquivo, você deve escolher se deseja excluir ou manter o arquivo removido em um novo commit. +To resolve a merge conflict caused by competing changes to a file, where a person deletes a file in one branch and another person edits the same file, you must choose whether to delete or keep the removed file in a new commit. -Por exemplo, se você editar um arquivo, como *LEIAME.md*, e outra pessoa remover o mesmo arquivo em outro branch no mesmo repositório Git, você receberá um erro de conflito de mesclagem ao tentar mesclar esses branches. Você deve resolver esse conflito de merge com um novo commit antes de fazer merge desses branches. +For example, if you edited a file, such as *README.md*, and another person removed the same file in another branch in the same Git repository, you'll get a merge conflict error when you try to merge these branches. You must resolve this merge conflict with a new commit before you can merge these branches. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Navegue até o repositório Git local que tem o conflito de merge. +2. Navigate into the local Git repository that has the merge conflict. ```shell - cd REPOSITORY-NAME + cd REPOSITORY-NAME ``` -2. Gere uma lista dos arquivos afetados pelo conflito de merge. Neste exemplo, o arquivo *LEIAME.md* tem um conflito de mesclagem. +2. Generate a list of the files affected by the merge conflict. In this example, the file *README.md* has a merge conflict. ```shell $ git status > # On branch main @@ -106,32 +100,32 @@ Por exemplo, se você editar um arquivo, como *LEIAME.md*, e outra pessoa remove > # Unmerged paths: > # (use "git add/rm ..." as appropriate to mark resolution) > # - > # deleted by us: README.md + > # deleted by us: README.md > # > # no changes added to commit (use "git add" and/or "git commit -a") ``` -3. Abra seu editor de texto favorito, como o [Atom](https://atom.io/), e procure o arquivo que contém conflitos de mesclagem. -6. Decida se você deseja manter o arquivo removido. Você pode ver as alterações mais recentes feitas no arquivo removido no editor de texto. +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. - Para adicionar o arquivo removido de volta ao repositório: + To add the removed file back to your repository: ```shell $ git add README.md ``` - Para remover o arquivo do seu repositório: + To remove this file from your repository: ```shell $ git rm README.md > README.md: needs merge > rm 'README.md' ``` -7. Faça o commit das suas alterações com um comentário. +7. Commit your changes with a comment. ```shell $ git commit -m "Resolved merge conflict by keeping README.md file." > [branch-d 6f89e49] Merge branch 'branch-c' into branch-d ``` -Agora você pode mesclar os branches na linha de comando ou [efetuar push das alterações para o repositório remoto](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) no {% data variables.product.product_name %} e [mesclar as alterações](/articles/merging-a-pull-request/) em uma solicitação de pull. +You can now merge the branches on the command line or [push your changes to your remote repository](/github/getting-started-with-github/pushing-commits-to-a-remote-repository/) on {% data variables.product.product_name %} and [merge your changes](/articles/merging-a-pull-request/) in a pull request. -## Leitura adicional +## Further reading -- "[Sobre os conflitos de mesclagem](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" -- "[Como fazer check-out local de solicitações de pull](/articles/checking-out-pull-requests-locally/)" +- "[About merge conflicts](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts/about-merge-conflicts)" +- "[Checking out pull requests locally](/articles/checking-out-pull-requests-locally/)" diff --git a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md index ca86371e9b61..a137dad617f8 100644 --- a/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md +++ b/translations/pt-BR/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request.md @@ -83,7 +83,7 @@ If you decide you don't want the changes in a topic branch to be merged to the u To merge a pull request, use the `gh pr merge` subcommand. Replace `pull-request` with the number, URL, or head branch of the pull request. ```shell -gh pr merge pull-request +gh pr merge PULL-REQUEST ``` Follow the interactive prompts to complete the merge. For more information about the merge methods that you can choose, see "[About pull request merges](/github/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges)." diff --git a/translations/pt-BR/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md b/translations/pt-BR/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md index 75f9b9672317..2805786381d2 100644 --- a/translations/pt-BR/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md +++ b/translations/pt-BR/content/repositories/releasing-projects-on-github/managing-releases-in-a-repository.md @@ -90,7 +90,7 @@ You can choose whether {% data variables.large_files.product_name_long %} ({% da 1. To create a release, use the `gh release create` subcommand. Replace `tag` with the desired tag for the release. ```shell - gh release create tag + gh release create TAG ``` 2. Follow the interactive prompts. Alternatively, you can specify arguments to skip these prompts. For more information about possible arguments, see [the {% data variables.product.prodname_cli %} manual](https://cli.github.com/manual/gh_release_create). For example, this command creates a prerelease with the specified title and notes. @@ -153,7 +153,7 @@ Releases cannot currently be edited with {% data variables.product.prodname_cli 1. To delete a release, use the `gh release delete` subcommand. Replace `tag` with the tag of the release to delete. Use the `-y` flag to skip confirmation. ```shell - gh release delete tag -y + gh release delete TAG -y ``` {% endcli %} diff --git a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md index 2621f90997af..229230ac9802 100644 --- a/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md +++ b/translations/pt-BR/content/repositories/working-with-files/using-files/working-with-non-code-files.md @@ -340,7 +340,7 @@ To view a fully interactive version of your Jupyter Notebook, you can set up a n If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert): ```shell -$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb +$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb ``` ### Further reading diff --git a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md index 083950084df8..a744b76793e0 100644 --- a/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md +++ b/translations/pt-BR/content/rest/guides/getting-started-with-the-rest-api.md @@ -163,7 +163,7 @@ With cURL, you will send an `Authorization` header with your token. Replace `YOU ```shell curl --request GET \ --url "https://api.github.com/octocat" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% note %} @@ -326,7 +326,7 @@ To send a header with cURL, use the `--header` or `-H` flag followed by the head curl --request GET \ --url "https://api.github.com/octocat" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -390,7 +390,7 @@ To get issues from the `octocat/Spoon-Knife` repository, replace `{owner}` with curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -443,7 +443,7 @@ For cURL, add a `?` to the end of the path, then append your query parameter nam curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2&sort=updated&direction=asc" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -495,7 +495,7 @@ For cURL, use the `--data` flag to pass the body parameters in a JSON object. curl --request POST \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --data '{ "title": "Created with the REST API", "body": "This is a test issue created by the REST API" @@ -593,7 +593,7 @@ For example, this request: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" \ +--header "Authorization: Bearer YOUR-TOKEN" \ --include ``` @@ -661,7 +661,7 @@ await octokit.request("GET /repos/{owner}/{repo}/issues", { curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" +--header "Authorization: Bearer YOUR-TOKEN" ``` {% endcurl %} @@ -730,7 +730,7 @@ For example, you can use `>` to redirect the response to a file: curl --request GET \ --url "https://api.github.com/repos/octocat/Spoon-Knife/issues?per_page=2" \ --header "Accept: application/vnd.github.v3+json" \ ---header "Authorization: Bearer YOUR-TOKEN" > data.json +--header "Authorization: Bearer YOUR-TOKEN" > data.json ``` Then you can use jq to get the title and author ID of each issue: diff --git a/translations/pt-BR/content/rest/overview/other-authentication-methods.md b/translations/pt-BR/content/rest/overview/other-authentication-methods.md index d8147fdb5d4f..9cebcf591a3f 100644 --- a/translations/pt-BR/content/rest/overview/other-authentication-methods.md +++ b/translations/pt-BR/content/rest/overview/other-authentication-methods.md @@ -45,7 +45,7 @@ response. The solution is to manually craft the `Authorization` header. We recommend you use OAuth tokens to authenticate to the GitHub API. OAuth tokens include [personal access tokens][personal-access-tokens] and enable the user to revoke access at any time. ```shell -$ curl -u username:token {% data variables.product.api_url_pre %}/user +$ curl -u USERNAME:TOKEN {% data variables.product.api_url_pre %}/user ``` This approach is useful if your tools only support Basic Authentication but you want to take advantage of OAuth access token security features. @@ -71,7 +71,7 @@ would authenticate you if you replace `` with your {% data variables.p (cURL will prompt you to enter the password.) ```shell -$ curl -u username {% data variables.product.api_url_pre %}/user +$ curl -u USERNAME {% data variables.product.api_url_pre %}/user ``` If you have two-factor authentication enabled, make sure you understand how to [work with two-factor authentication](/rest/overview/other-authentication-methods#working-with-two-factor-authentication). @@ -95,7 +95,7 @@ If you have two-factor authentication enabled, make sure you understand how to [ If you're using the API to access an organization that enforces [SAML SSO][saml-sso] for authentication, you'll need to create a personal access token (PAT) and [authorize the token][allowlist] for that organization. Visit the URL specified in `X-GitHub-SSO` to authorize the token for the organization. ```shell -$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/repos/octodocs-test/test > X-GitHub-SSO: required; url=https://github.com/orgs/octodocs-test/sso?authorization_request=AZSCKtL4U8yX1H3sCQIVnVgmjmon5fWxks5YrqhJgah0b2tlbl9pZM4EuMz4 { @@ -107,7 +107,7 @@ $ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.ap When requesting data that could come from multiple organizations (for example, [requesting a list of issues created by the user][user-issues]), the `X-GitHub-SSO` header indicates which organizations require you to authorize your personal access token: ```shell -$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues +$ curl -v -H "Authorization: Bearer TOKEN" {% data variables.product.api_url_pre %}/user/issues > X-GitHub-SSO: partial-results; organizations=21955855,20582480 ``` @@ -136,9 +136,9 @@ This header tells you how your account receives its two-factor authentication co ```shell $ curl --request POST \ --url https://api.github.com/authorizations \ - --header 'authorization: Basic PASSWORD' \ + --header 'authorization: Basic PASSWORD' \ --header 'content-type: application/json' \ - --header 'x-github-otp: OTP' \ + --header 'x-github-otp: OTP' \ --data '{"scopes": ["public_repo"], "note": "test"}' ``` {% endif %} diff --git a/translations/pt-BR/content/rest/overview/resources-in-the-rest-api.md b/translations/pt-BR/content/rest/overview/resources-in-the-rest-api.md index 033f0ccd7897..0432d216c945 100644 --- a/translations/pt-BR/content/rest/overview/resources-in-the-rest-api.md +++ b/translations/pt-BR/content/rest/overview/resources-in-the-rest-api.md @@ -91,7 +91,7 @@ $ curl -u "username" {% data variables.product.api_url_pre %} ### OAuth2 token (sent in a header) ```shell -$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} +$ curl -H "Authorization: Bearer OAUTH-TOKEN" {% data variables.product.api_url_pre %} ``` {% note %} @@ -150,7 +150,7 @@ the API will temporarily reject all authentication attempts for that user ```shell $ curl -i {% data variables.product.api_url_pre %} -u {% ifversion fpt or ghae or ghec %} --u valid_username:valid_token {% endif %}{% ifversion ghes %}-u valid_username:valid_password {% endif %} +-u VALID_USERNAME:VALID_TOKEN {% endif %}{% ifversion ghes %}-u VALID_USERNAME:VALID_PASSWORD {% endif %} > HTTP/2 403 > { > "message": "Maximum number of login attempts exceeded. Please try again later.", @@ -185,7 +185,7 @@ You can issue a `GET` request to the root endpoint to get all the endpoint categ ```shell $ curl {% ifversion fpt or ghae or ghec %} --u username:token {% endif %}{% ifversion ghes %}-u username:password {% endif %}{% data variables.product.api_url_pre %} +-u USERNAME:TOKEN {% endif %}{% ifversion ghes %}-u USERNAME:PASSWORD {% endif %}{% data variables.product.api_url_pre %} ``` ## GraphQL global node IDs diff --git a/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index dcf929a8575b..4e6d036ae355 100644 --- a/translations/pt-BR/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/translations/pt-BR/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/translations/pt-BR/data/reusables/actions/link-to-example-library.md b/translations/pt-BR/data/reusables/actions/link-to-example-library.md deleted file mode 100644 index 5e5b387b765f..000000000000 --- a/translations/pt-BR/data/reusables/actions/link-to-example-library.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -ms.openlocfilehash: ad73c4455042d29d72d3f76dbbdc512487c9303a -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: "146139462" ---- -Para obter exemplos que demonstram recursos mais complexos do {% data variables.product.prodname_actions %}, confira " [Exemplos](/actions/examples)". Você pode ver exemplos detalhados que explicam como testar seu código em um executor, acessar a CLI do {% data variables.product.prodname_dotcom %} e usar recursos avançados, como simultaneidade e matrizes de teste. diff --git a/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md b/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md index 4f150af299bd..c89126ae764b 100644 --- a/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md +++ b/translations/pt-BR/data/reusables/codespaces/creating-a-codespace-in-vscode.md @@ -15,6 +15,8 @@ After you connect your account on {% data variables.product.product_location %} ![Searching for repository to create a new codespace](/assets/images/help/codespaces/choose-repository-vscode.png) + If codespaces are billable for the repository you choose, a message will be displayed in subsequent prompts telling you who will pay for the codespace. + 4. Click the branch you want to develop on. ![Searching for a branch to create a new codespace](/assets/images/help/codespaces/choose-branch-vscode.png) diff --git a/translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md b/translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md index 6b38b0df18f7..4f702e6e70f0 100644 --- a/translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md +++ b/translations/pt-BR/data/reusables/notifications/vulnerable-dependency-notification-options.md @@ -1,27 +1,22 @@ ---- -ms.openlocfilehash: 5120f840aab87ca243eed66c5bb6256e80aefeea -ms.sourcegitcommit: 47bd0e48c7dba1dde49baff60bc1eddc91ab10c5 -ms.translationtype: HT -ms.contentlocale: pt-BR -ms.lasthandoff: 09/05/2022 -ms.locfileid: "147064175" ---- -{% ifversion fpt or ghec %}Por padrão, você receberá notificações:{% endif %}{% ifversion ghes or ghae %}Por padrão, se o proprietário da empresa tiver configurado um email para notificações na sua instância, você receberá {% data variables.product.prodname_dependabot_alerts %}:{% endif %} +{% ifversion fpt or ghec %}By default, you will receive notifications:{% endif %}{% ifversion ghes or ghae %}By default, if your enterprise owner has configured email for notifications on your instance, you will receive {% data variables.product.prodname_dependabot_alerts %}:{% endif %} -- por email, um email é enviado quando o {% data variables.product.prodname_dependabot %} está habilitado em um repositório, quando é feito commit de um novo arquivo de manifesto no repositório e quando uma nova vulnerabilidade com uma severidade crítica ou alta é encontrada (opção **Enviar um email sempre que uma vulnerabilidade for encontrada**). -- na interface do usuário, um aviso será mostrado nas exibições de arquivo e de código do repositório se houver dependências não seguras (opção **Alertas da interface do usuário**). -- na linha de comando, são exibidos avisos como retornos de chamada quando você efetua push para repositórios com dependências não seguras (opção **Linha de Comando**). -- na caixa de entrada, como notificações da Web. Uma notificação da Web é enviada quando o {% data variables.product.prodname_dependabot %} está habilitado em um repositório, quando é feito commit de um novo arquivo de manifesto e quando uma nova vulnerabilidade com uma severidade crítica ou alta é encontrada (opção **Web**).{% ifversion not ghae %} -- em {% data variables.product.prodname_mobile %}, como notificações da web. Para obter mais informações, confira "[Como habilitar notificações por push com o GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)".{% endif %} +- by email, an email is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Email each time a vulnerability is found** option). +- in the user interface, a warning is shown in your repository's file and code views if there are any insecure dependencies (**UI alerts** option). +- on the command line, warnings are displayed as callbacks when you push to repositories with any insecure dependencies (**Command Line** option). +- in your inbox, as web notifications. A web notification is sent when {% data variables.product.prodname_dependabot %} is enabled for a repository, when a new manifest file is committed to the repository, and when a new vulnerability with a critical or high severity is found (**Web** option).{% ifversion not ghae %} +- on {% data variables.product.prodname_mobile %}, as web notifications. For more information, see "[Enabling push notifications with GitHub Mobile](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications#enabling-push-notifications-with-github-mobile)."{% endif %} {% note %} -**Observação:** as notificações por email e da Web{% ifversion not ghae %}/do {% data variables.product.prodname_mobile %}{% endif %} são: +**Note:** The email and web{% ifversion not ghae %}/{% data variables.product.prodname_mobile %}{% endif %} notifications are: -- _por repositório_, quando o {% data variables.product.prodname_dependabot %} está habilitado no repositório ou quando é feito commit de um novo arquivo de manifesto no repositório. +- _per repository_ when {% data variables.product.prodname_dependabot %} is enabled on the repository, or when a new manifest file is committed to the repository. -- _por organização_, quando uma nova vulnerabilidade é descoberta. +- _per organization_ when a new vulnerability is discovered. {% endnote %} -Você pode personalizar a maneira como recebe notificações sobre os {% data variables.product.prodname_dependabot_alerts %}. Por exemplo, você pode receber um email de resumo semanal de alertas para até dez dos seus repositórios usando as opções **Enviar um email de resumo das vulnerabilidades** e **Resumo de email de segurança semanal**. +{% ifversion update-notification-settings-22 %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a daily or weekly digest email summarizing alerts for up to 10 of your repositories using the **Email weekly digest** option. +{% else %} +You can customize the way you are notified about {% data variables.product.prodname_dependabot_alerts %}. For example, you can receive a weekly digest email summarizing alerts for up to 10 of your repositories using the **Email a digest summary of vulnerabilities** and **Weekly security email digest** options.{% endif %}