diff --git a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md index 5290ecd224..9ae38de88d 100644 --- a/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md +++ b/content/account-and-profile/setting-up-and-managing-your-github-profile/managing-contribution-settings-on-your-profile/viewing-contributions-on-your-profile.md @@ -60,7 +60,7 @@ Your contributions calendar shows your contribution activity. ### Viewing contributions from specific times - Click on a day's square to show the contributions made during that 24-hour period. -- Press *Shift* and click on another day's square to show contributions made during that time span. +- Press _Shift_ and click on another day's square to show contributions made during that time span. {% note %} diff --git a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md index 119574efdc..f3a02d49fb 100644 --- a/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md +++ b/content/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-email-preferences/managing-marketing-emails-from-github.md @@ -24,7 +24,7 @@ shortTitle: Marketing emails {% data reusables.user-settings.access_settings %} {% data reusables.user-settings.emails %} -3. Under *Email preferences*, select **Only receive account related emails, and those I subscribe to**. +3. Under _Email preferences_, select **Only receive account related emails, and those I subscribe to**. 4. Click **Save email preferences**. ## Further reading diff --git a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md index 783e5d9d67..6bb2ddc8f7 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-nodejs.md @@ -137,7 +137,7 @@ If you don't specify a Node.js version, {% data variables.product.prodname_dotco ### Example using npm -This example installs the dependencies defined in the *package.json* file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). +This example installs the dependencies defined in the _package.json_ file. For more information, see [`npm install`](https://docs.npmjs.com/cli/install). ```yaml copy steps: @@ -150,7 +150,7 @@ steps: run: npm install ``` -Using `npm ci` installs the versions in the *package-lock.json* or *npm-shrinkwrap.json* file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." +Using `npm ci` installs the versions in the _package-lock.json_ or _npm-shrinkwrap.json_ file and prevents updates to the lock file. Using `npm ci` is generally faster than running `npm install`. For more information, see [`npm ci`](https://docs.npmjs.com/cli/ci.html) and "[Introducing `npm ci` for faster, more reliable builds](https://blog.npmjs.org/post/171556855892/introducing-npm-ci-for-faster-more-reliable)." ```yaml copy steps: @@ -165,7 +165,7 @@ steps: ### Example using Yarn -This example installs the dependencies defined in the *package.json* file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). +This example installs the dependencies defined in the _package.json_ file. For more information, see [`yarn install`](https://yarnpkg.com/en/docs/cli/install). ```yaml copy steps: @@ -197,9 +197,9 @@ steps: To authenticate to your private registry, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." -In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the *.npmrc* file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an *.npmrc* file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token. +In the example below, the secret `NPM_TOKEN` stores the npm authentication token. The `setup-node` action configures the _.npmrc_ file to read the npm authentication token from the `NODE_AUTH_TOKEN` environment variable. When using the `setup-node` action to create an _.npmrc_ file, you must set the `NODE_AUTH_TOKEN` environment variable with the secret that contains your npm authentication token. -Before installing dependencies, use the `setup-node` action to create the *.npmrc* file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). +Before installing dependencies, use the `setup-node` action to create the _.npmrc_ file. The action has two input parameters. The `node-version` parameter sets the Node.js version, and the `registry-url` parameter sets the default registry. If your package registry uses scopes, you must use the `scope` parameter. For more information, see [`npm-scope`](https://docs.npmjs.com/misc/scope). ```yaml copy steps: @@ -217,7 +217,7 @@ steps: NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %} ``` -The example above creates an *.npmrc* file with the following contents: +The example above creates an _.npmrc_ file with the following contents: ```ini //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} @@ -283,7 +283,7 @@ If you have a custom requirement or need finer controls for caching, you can use ## Building and testing your code -You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your *package.json* file and `npm test` to run your test suite, you would add those commands in your workflow file. +You can use the same commands that you use locally to build and test your code. For example, if you run `npm run build` to run build steps defined in your _package.json_ file and `npm test` to run your test suite, you would add those commands in your workflow file. ```yaml copy steps: diff --git a/content/actions/automating-builds-and-tests/building-and-testing-python.md b/content/actions/automating-builds-and-tests/building-and-testing-python.md index 1397eb7206..2840e8b009 100644 --- a/content/actions/automating-builds-and-tests/building-and-testing-python.md +++ b/content/actions/automating-builds-and-tests/building-and-testing-python.md @@ -213,7 +213,7 @@ steps: ### Requirements file -After you update `pip`, a typical next step is to install dependencies from *requirements.txt*. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file). +After you update `pip`, a typical next step is to install dependencies from _requirements.txt_. For more information, see [pip](https://pip.pypa.io/en/stable/cli/pip_install/#example-requirements-file). ```yaml copy steps: diff --git a/content/actions/creating-actions/dockerfile-support-for-github-actions.md b/content/actions/creating-actions/dockerfile-support-for-github-actions.md index 7caeef5123..1488948e86 100644 --- a/content/actions/creating-actions/dockerfile-support-for-github-actions.md +++ b/content/actions/creating-actions/dockerfile-support-for-github-actions.md @@ -62,7 +62,7 @@ ENTRYPOINT ["sh", "-c", "echo $GITHUB_SHA"] To supply `args` defined in the action's metadata file to a Docker container that uses the _exec_ form in the `ENTRYPOINT`, we recommend creating a shell script called `entrypoint.sh` that you call from the `ENTRYPOINT` instruction: -#### Example *Dockerfile* +#### Example _Dockerfile_ ```dockerfile # Container image that runs your code @@ -75,7 +75,7 @@ COPY entrypoint.sh /entrypoint.sh ENTRYPOINT ["/entrypoint.sh"] ``` -#### Example *entrypoint.sh* file +#### Example _entrypoint.sh_ file Using the example Dockerfile above, {% data variables.product.product_name %} will send the `args` configured in the action's metadata file as arguments to `entrypoint.sh`. Add the `#!/bin/sh` [shebang](https://en.wikipedia.org/wiki/Shebang_(Unix)) at the top of the `entrypoint.sh` file to explicitly use the system's [POSIX](https://en.wikipedia.org/wiki/POSIX)-compliant shell. diff --git a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md index 8b1ec9c824..0421a37d03 100644 --- a/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/managing-self-hosted-runners/monitoring-and-troubleshooting-self-hosted-runners.md @@ -100,13 +100,13 @@ export GITHUB_ACTIONS_RUNNER_TLS_NO_VERIFY=1 ## Reviewing the self-hosted runner application log files -You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with *Runner_*, and is followed by a UTC timestamp of when the application was started. +You can monitor the status of the self-hosted runner application and its activities. Log files are kept in the `_diag` directory where you installed the runner application, and a new log is generated each time the application is started. The filename begins with _Runner__, and is followed by a UTC timestamp of when the application was started. -For detailed logs on workflow job executions, see the next section describing the *Worker_* files. +For detailed logs on workflow job executions, see the next section describing the _Worker__ files. ## Reviewing a job's log file -The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with *Worker_*. +The self-hosted runner application creates a detailed log file for each job that it processes. These files are stored in the `_diag` directory where you installed the runner application, and the filename begins with _Worker__. {% linux %} @@ -220,7 +220,7 @@ PS C:\actions-runner> Get-EventLog -LogName Application -Source ActionsRunnerSer We recommend that you regularly check the automatic update process, as the self-hosted runner will not be able to process jobs if it falls below a certain version threshold. The self-hosted runner application automatically updates itself, but note that this process does not include any updates to the operating system or other software; you will need to separately manage these updates. -You can view the update activities in the *Runner_* log files. For example: +You can view the update activities in the _Runner__ log files. For example: ```shell [Feb 12 12:37:07 INFO SelfUpdater] An update is available. diff --git a/content/actions/migrating-to-github-actions/manual-migrations/migrating-from-circleci-to-github-actions.md b/content/actions/migrating-to-github-actions/manual-migrations/migrating-from-circleci-to-github-actions.md index 5aea6509ef..c5bdabf5ff 100644 --- a/content/actions/migrating-to-github-actions/manual-migrations/migrating-from-circleci-to-github-actions.md +++ b/content/actions/migrating-to-github-actions/manual-migrations/migrating-from-circleci-to-github-actions.md @@ -36,13 +36,13 @@ For more information, see "[AUTOTITLE](/actions/learn-github-actions/understandi When migrating from CircleCI, consider the following differences: - CircleCI’s automatic test parallelism automatically groups tests according to user-specified rules or historical timing information. This functionality is not built into {% data variables.product.prodname_actions %}. -- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %} +- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your _Dockerfile_. {% ifversion ghae %}{% data reusables.actions.self-hosted-runners-software %} {% else %}For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners#docker-container-filesystem)." {% endif %} ## Migrating workflows and jobs -CircleCI defines `workflows` in the *config.yml* file, which allows you to configure more than one workflow. {% data variables.product.product_name %} requires one workflow file per workflow, and as a consequence, does not require you to declare `workflows`. You'll need to create a new workflow file for each workflow configured in *config.yml*. +CircleCI defines `workflows` in the _config.yml_ file, which allows you to configure more than one workflow. {% data variables.product.product_name %} requires one workflow file per workflow, and as a consequence, does not require you to declare `workflows`. You'll need to create a new workflow file for each workflow configured in _config.yml_. Both CircleCI and {% data variables.product.prodname_actions %} configure `jobs` in the configuration file using similar syntax. If you configure any dependencies between jobs using `requires` in your CircleCI workflow, you can use the equivalent {% data variables.product.prodname_actions %} `needs` syntax. For more information, see "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idneeds)." @@ -162,7 +162,7 @@ For more information, see "[AUTOTITLE](/actions/using-workflows/storing-workflow Both systems enable you to include additional containers for databases, caching, or other dependencies. -In CircleCI, the first image listed in the *config.yaml* is the primary image used to run commands. {% data variables.product.prodname_actions %} uses explicit sections: use `container` for the primary container, and list additional containers in `services`. +In CircleCI, the first image listed in the _config.yaml_ is the primary image used to run commands. {% data variables.product.prodname_actions %} uses explicit sections: use `container` for the primary container, and list additional containers in `services`. Below is an example in CircleCI and {% data variables.product.prodname_actions %} configuration syntax. @@ -274,7 +274,7 @@ For more information, see "[AUTOTITLE](/actions/using-containerized-services/abo ## Complete Example -Below is a real-world example. The left shows the actual CircleCI *config.yml* for the [thoughtbot/administrator](https://github.com/thoughtbot/administrate) repository. The right shows the {% data variables.product.prodname_actions %} equivalent. +Below is a real-world example. The left shows the actual CircleCI _config.yml_ for the [thoughtbot/administrator](https://github.com/thoughtbot/administrate) repository. The right shows the {% data variables.product.prodname_actions %} equivalent. ### Complete example for CircleCI diff --git a/content/actions/publishing-packages/publishing-nodejs-packages.md b/content/actions/publishing-packages/publishing-nodejs-packages.md index c2f2460ad1..eeb0047313 100644 --- a/content/actions/publishing-packages/publishing-nodejs-packages.md +++ b/content/actions/publishing-packages/publishing-nodejs-packages.md @@ -40,13 +40,13 @@ You may also find it helpful to have a basic understanding of the following: ## About package configuration - The `name` and `version` fields in the *package.json* file create a unique identifier that registries use to link your package to a registry. You can add a summary for the package listing page by including a `description` field in the *package.json* file. For more information, see "[Creating a package.json file](https://docs.npmjs.com/creating-a-package-json-file)" and "[Creating Node.js modules](https://docs.npmjs.com/creating-node-js-modules)" in the npm documentation. + The `name` and `version` fields in the _package.json_ file create a unique identifier that registries use to link your package to a registry. You can add a summary for the package listing page by including a `description` field in the _package.json_ file. For more information, see "[Creating a package.json file](https://docs.npmjs.com/creating-a-package-json-file)" and "[Creating Node.js modules](https://docs.npmjs.com/creating-node-js-modules)" in the npm documentation. -When a local *.npmrc* file exists and has a `registry` value specified, the `npm publish` command uses the registry configured in the *.npmrc* file. {% data reusables.actions.setup-node-intro %} +When a local _.npmrc_ file exists and has a `registry` value specified, the `npm publish` command uses the registry configured in the _.npmrc_ file. {% data reusables.actions.setup-node-intro %} You can specify the Node.js version installed on the runner using the `setup-node` action. -If you add steps in your workflow to configure the `publishConfig` fields in your *package.json* file, you don't need to specify the registry-url using the `setup-node` action, but you will be limited to publishing the package to one registry. For more information, see "[publishConfig](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#publishconfig)" in the npm documentation. +If you add steps in your workflow to configure the `publishConfig` fields in your _package.json_ file, you don't need to specify the registry-url using the `setup-node` action, but you will be limited to publishing the package to one registry. For more information, see "[publishConfig](https://docs.npmjs.com/cli/v9/configuring-npm/package-json#publishconfig)" in the npm documentation. ## Publishing packages to the npm registry @@ -54,11 +54,11 @@ You can trigger a workflow to publish your package every time you publish a new To perform authenticated operations against the npm registry in your workflow, you'll need to store your npm authentication token as a secret. For example, create a repository secret called `NPM_TOKEN`. For more information, see "[AUTOTITLE](/actions/security-guides/encrypted-secrets)." -By default, npm uses the `name` field of the *package.json* file to determine the name of your published package. When publishing to a global namespace, you only need to include the package name. For example, you would publish a package named `my-package` to `https://www.npmjs.com/package/my-package`. +By default, npm uses the `name` field of the _package.json_ file to determine the name of your published package. When publishing to a global namespace, you only need to include the package name. For example, you would publish a package named `my-package` to `https://www.npmjs.com/package/my-package`. -If you're publishing a package that includes a scope prefix, include the scope in the name of your *package.json* file. For example, if your npm scope prefix is "octocat" and the package name is "hello-world", the `name` in your *package.json* file should be `@octocat/hello-world`. If your npm package uses a scope prefix and the package is public, you need to use the option `npm publish --access public`. This is an option that npm requires to prevent someone from publishing a private package unintentionally. +If you're publishing a package that includes a scope prefix, include the scope in the name of your _package.json_ file. For example, if your npm scope prefix is "octocat" and the package name is "hello-world", the `name` in your _package.json_ file should be `@octocat/hello-world`. If your npm package uses a scope prefix and the package is public, you need to use the option `npm publish --access public`. This is an option that npm requires to prevent someone from publishing a private package unintentionally. -This example stores the `NPM_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. +This example stores the `NPM_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an _.npmrc_ file, it references the token from the `NODE_AUTH_TOKEN` environment variable. ```yaml copy name: Publish Package to npmjs @@ -81,7 +81,7 @@ jobs: NODE_AUTH_TOKEN: {% raw %}${{ secrets.NPM_TOKEN }}{% endraw %} ``` -In the example above, the `setup-node` action creates an *.npmrc* file on the runner with the following contents: +In the example above, the `setup-node` action creates an _.npmrc_ file on the runner with the following contents: ```ini //registry.npmjs.org/:_authToken=${NODE_AUTH_TOKEN} @@ -97,9 +97,9 @@ You can trigger a workflow to publish your package every time you publish a new ### Configuring the destination repository -Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your *package.json* file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the *package.json* file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. +Linking your package to {% data variables.product.prodname_registry %} using the `repository` key is optional. If you choose not to provide the `repository` key in your _package.json_ file, then {% data variables.product.prodname_registry %} publishes a package in the {% data variables.product.prodname_dotcom %} repository you specify in the `name` field of the _package.json_ file. For example, a package named `@my-org/test` is published to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If the `url` specified in the `repository` key is invalid, your package may still be published however it won't be linked to the repository source as intended. -If you do provide the `repository` key in your *package.json* file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below *package.json* results in a package named `my-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. +If you do provide the `repository` key in your _package.json_ file, then the repository in that key is used as the destination npm registry for {% data variables.product.prodname_registry %}. For example, publishing the below _package.json_ results in a package named `my-package` published to the `octocat/my-other-repo` {% data variables.product.prodname_dotcom %} repository. Once published, only the repository source is updated, and the package doesn't inherit any permissions from the destination repository. ```json { @@ -118,7 +118,7 @@ If you want to publish your package to a different repository, you must use a {% ### Example workflow -This example stores the `GITHUB_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an *.npmrc* file, it references the token from the `NODE_AUTH_TOKEN` environment variable. +This example stores the `GITHUB_TOKEN` secret in the `NODE_AUTH_TOKEN` environment variable. When the `setup-node` action creates an _.npmrc_ file, it references the token from the `NODE_AUTH_TOKEN` environment variable. ```yaml copy name: Publish package to GitHub Packages @@ -146,7 +146,7 @@ jobs: NODE_AUTH_TOKEN: {% raw %}${{ secrets.GITHUB_TOKEN }}{% endraw %} ``` -The `setup-node` action creates an *.npmrc* file on the runner. When you use the `scope` input to the `setup-node` action, the *.npmrc* file includes the scope prefix. By default, the `setup-node` action sets the scope in the *.npmrc* file to the account that contains that workflow file. +The `setup-node` action creates an _.npmrc_ file on the runner. When you use the `scope` input to the `setup-node` action, the _.npmrc_ file includes the scope prefix. By default, the `setup-node` action sets the scope in the _.npmrc_ file to the account that contains that workflow file. ```ini //npm.pkg.github.com/:_authToken=${NODE_AUTH_TOKEN} diff --git a/content/actions/using-containerized-services/creating-postgresql-service-containers.md b/content/actions/using-containerized-services/creating-postgresql-service-containers.md index bcff54a206..a2e2a5534a 100644 --- a/content/actions/using-containerized-services/creating-postgresql-service-containers.md +++ b/content/actions/using-containerized-services/creating-postgresql-service-containers.md @@ -283,7 +283,7 @@ steps: You can test your workflow using the following script, which connects to the PostgreSQL service and adds a new table with some placeholder data. The script then prints the values stored in the PostgreSQL table to the terminal. Your script can use any language you'd like, but this example uses Node.js and the `pg` npm module. For more information, see the [npm pg module](https://www.npmjs.com/package/pg). -You can modify *client.js* to include any PostgreSQL operations needed by your workflow. In this example, the script connects to the PostgreSQL service, adds a table to the `postgres` database, inserts some placeholder data, and then retrieves the data. +You can modify _client.js_ to include any PostgreSQL operations needed by your workflow. In this example, the script connects to the PostgreSQL service, adds a table to the `postgres` database, inserts some placeholder data, and then retrieves the data. {% data reusables.actions.service-container-add-script %} diff --git a/content/actions/using-containerized-services/creating-redis-service-containers.md b/content/actions/using-containerized-services/creating-redis-service-containers.md index 9da41bbe7e..788a900389 100644 --- a/content/actions/using-containerized-services/creating-redis-service-containers.md +++ b/content/actions/using-containerized-services/creating-redis-service-containers.md @@ -270,7 +270,7 @@ steps: You can test your workflow using the following script, which creates a Redis client and populates the client with some placeholder data. The script then prints the values stored in the Redis client to the terminal. Your script can use any language you'd like, but this example uses Node.js and the `redis` npm module. For more information, see the [npm redis module](https://www.npmjs.com/package/redis). -You can modify *client.js* to include any Redis operations needed by your workflow. In this example, the script creates the Redis client instance, adds placeholder data, then retrieves the data. +You can modify _client.js_ to include any Redis operations needed by your workflow. In this example, the script creates the Redis client instance, adds placeholder data, then retrieves the data. {% data reusables.actions.service-container-add-script %} diff --git a/content/actions/using-workflows/events-that-trigger-workflows.md b/content/actions/using-workflows/events-that-trigger-workflows.md index 51df5c4fd1..43ead6004c 100644 --- a/content/actions/using-workflows/events-that-trigger-workflows.md +++ b/content/actions/using-workflows/events-that-trigger-workflows.md @@ -1085,7 +1085,7 @@ on: {% note %} -**Note:** The `prereleased` type will not trigger for pre-releases published from draft releases, but the `published` type will trigger. If you want a workflow to run when stable *and* pre-releases publish, subscribe to `published` instead of `released` and `prereleased`. +**Note:** The `prereleased` type will not trigger for pre-releases published from draft releases, but the `published` type will trigger. If you want a workflow to run when stable _and_ pre-releases publish, subscribe to `published` instead of `released` and `prereleased`. {% endnote %} diff --git a/content/admin/configuration/configuring-network-settings/configuring-tls.md b/content/admin/configuration/configuring-network-settings/configuring-tls.md index a6ac231226..fbe970c550 100644 --- a/content/admin/configuration/configuring-network-settings/configuring-tls.md +++ b/content/admin/configuration/configuring-network-settings/configuring-tls.md @@ -46,8 +46,8 @@ Your key must be an RSA key and must not have a passphrase. For more information {% data reusables.enterprise_management_console.privacy %} {% data reusables.enterprise_management_console.select-tls-only %} 4. Under "TLS Protocol support", select the protocols you want to allow. -5. Under "Certificate", click **Choose File**, then choose a TLS certificate or certificate chain (in PEM format) to install. This file will usually have a *.pem*, *.crt*, or *.cer* extension. -6. Under "Unencrypted key", click **Choose File**, then choose an RSA key (in PEM format) to install. This file will usually have a *.key* extension. +5. Under "Certificate", click **Choose File**, then choose a TLS certificate or certificate chain (in PEM format) to install. This file will usually have a _.pem_, _.crt_, or _.cer_ extension. +6. Under "Unencrypted key", click **Choose File**, then choose an RSA key (in PEM format) to install. This file will usually have a _.key_ extension. {% data reusables.enterprise_management_console.save-settings %} 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 b40765257a..7752f905ed 100644 --- a/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md +++ b/content/admin/configuration/configuring-your-enterprise/command-line-utilities.md @@ -492,7 +492,7 @@ SSL-Session: Verify return code: 0 (ok) ``` -If, on the other hand, the remote server's SSL certificate can *not* be verified, your `SSL-Session` should have a nonzero return code: +If, on the other hand, the remote server's SSL certificate can _not_ be verified, your `SSL-Session` should have a nonzero return code: ``` SSL-Session: @@ -634,7 +634,7 @@ $ ghe-cluster-status This utility creates a support bundle tarball containing important logs from each of the nodes in either a Geo-replication or Clustering configuration. -By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support. +By default, the command creates the tarball in _/tmp_, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from _/setup/support_ doesn't work. You must use this command if you want to generate an _extended_ bundle, containing older logs. You can also use this command to upload the cluster support bundle directly to {% data variables.product.prodname_enterprise %} support. {% data reusables.enterprise.bundle-utility-period-argument-availability-note %} @@ -1047,7 +1047,7 @@ ghe-diagnostics {% data reusables.enterprise_enterprise_support.use_ghe_cluster_support_bundle %} This utility creates a support bundle tarball containing important logs from your instance. -By default, the command creates the tarball in */tmp*, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from */setup/support* doesn't work. You must use this command if you want to generate an *extended* bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support. +By default, the command creates the tarball in _/tmp_, but you can also have it `cat` the tarball to `STDOUT` for easy streaming over SSH. This is helpful in the case where the web UI is unresponsive or downloading a support bundle from _/setup/support_ doesn't work. You must use this command if you want to generate an _extended_ bundle, containing older logs. You can also use this command to upload the support bundle directly to {% data variables.product.prodname_enterprise %} support. {% data reusables.enterprise.bundle-utility-period-argument-availability-note %} @@ -1133,9 +1133,9 @@ ghe-migrations -refresh_rate SECONDS ### ghe-update-check -This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to */var/lib/ghe-updates*. An administrator can then [perform the upgrade](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources). +This utility will check to see if a new patch release of {% data variables.product.prodname_enterprise %} is available. If it is, and if space is available on your instance, it will download the package. By default, it's saved to _/var/lib/ghe-updates_. An administrator can then [perform the upgrade](/admin/enterprise-management/updating-the-virtual-machine-and-physical-resources). -A file containing the status of the download is available at */var/lib/ghe-updates/ghe-update-check.status*. +A file containing the status of the download is available at _/var/lib/ghe-updates/ghe-update-check.status_. To check for the latest {% data variables.product.prodname_enterprise %} release, use the `-i` switch. 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 bfc78c5e06..3f61b91efc 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 @@ -58,21 +58,21 @@ Then, when told to fetch `https://github.example.com/myorg/myrepo`, Git will ins ``` $ ghe-repl-node --datacenter DC-NAME ``` -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. +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 ``` {% else %} 1. To configure the repository cache, use the `ghe-repl-node` command and include the necessary parameters. - - Set a `cache-location` for the repository cache, replacing *CACHE-LOCATION* with an alphanumeric identifier, such as the region where the cache is deployed. The *CACHE-LOCATION* value must not be any of the subdomains reserved for use with subdomain isolation, such as `assets` or `media`. For a list of reserved names, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation#about-subdomain-isolation)." - - Set a `cache-domain` for the repository cache, replacing *EXTERNAL-CACHE-DOMAIN* with the hostname Git clients will use to access the repository cache. If you do not specify a `cache-domain`, {% data variables.product.product_name %} will prepend the *CACHE-LOCATION* value as a subdomain to the hostname configured for your instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-a-hostname)." + - Set a `cache-location` for the repository cache, replacing _CACHE-LOCATION_ with an alphanumeric identifier, such as the region where the cache is deployed. The _CACHE-LOCATION_ value must not be any of the subdomains reserved for use with subdomain isolation, such as `assets` or `media`. For a list of reserved names, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/enabling-subdomain-isolation#about-subdomain-isolation)." + - Set a `cache-domain` for the repository cache, replacing _EXTERNAL-CACHE-DOMAIN_ with the hostname Git clients will use to access the repository cache. If you do not specify a `cache-domain`, {% data variables.product.product_name %} will prepend the _CACHE-LOCATION_ value as a subdomain to the hostname configured for your instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-network-settings/configuring-a-hostname)." - If you haven't already, set the datacenter name on the primary and any replica appliances, replacing DC-NAME with a datacenter name. ``` $ ghe-repl-node --datacenter DC-NAME ``` - - New caches will attempt to seed from another cache in the same datacenter. Set a `datacenter` for the repository cache, replacing *REPLICA-DC-NAME* with the name of the datacenter where you're deploying the node. + - New caches will attempt to seed from another cache in the same datacenter. Set a `datacenter` for the repository cache, replacing _REPLICA-DC-NAME_ with the name of the datacenter where you're deploying the node. ```shell $ ghe-repl-node --cache CACHE-LOCATION --cache-domain EXTERNAL-CACHE-DOMAIN --datacenter REPLICA-DC-NAME diff --git a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md index c59497071c..ccca58675c 100644 --- a/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/monitoring-the-health-of-your-cluster.md @@ -83,7 +83,7 @@ You can configure [Nagios](https://www.nagios.org/) to monitor {% data variables 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....` +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....` 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. 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 e2e3e24e06..50334fbb24 100644 --- a/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md +++ b/content/admin/enterprise-management/configuring-clustering/upgrading-a-cluster.md @@ -37,7 +37,7 @@ Use an upgrade package to upgrade a {% data variables.product.prodname_ghe_serve 1. Review [Cluster network configuration](/admin/enterprise-management/configuring-clustering/cluster-network-configuration) for the version you are upgrading to, and update your configuration as needed. 2. Back up your data with [{% data variables.product.prodname_enterprise_backup_utilities %}](https://github.com/github/backup-utils#readme). 3. Schedule a maintenance window for end users of your {% data variables.product.prodname_ghe_server %} cluster, as it will be unavailable for normal use during the upgrade. Maintenance mode blocks user access and prevents data changes while the cluster upgrade is in progress. -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. +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" diff --git a/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md b/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md index 0c216af47e..8c215b8008 100644 --- a/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md +++ b/content/admin/enterprise-management/monitoring-your-appliance/configuring-collectd.md @@ -23,7 +23,7 @@ If you haven't already set up an external `collectd` server, you will need to do 1. Log into your `collectd` server. 2. Create or edit the `collectd` configuration file to load the network plugin and populate the server and port directives with the proper values. On most distributions, this is located at `/etc/collectd/collectd.conf` -An example *collectd.conf* to run a `collectd` server: +An example _collectd.conf_ to run a `collectd` server: LoadPlugin network ... 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 86d0e927f3..fee9e82f85 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 @@ -142,7 +142,7 @@ If the upgrade target you're presented with is a feature release instead of a pa {% data reusables.enterprise_installation.download-note %} {% data reusables.enterprise_installation.ssh-into-instance %} -1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Copy the URL for the upgrade hotpackage (*.hpkg* file). +1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Copy the URL for the upgrade hotpackage (_.hpkg_ file). {% data reusables.enterprise_installation.download-package %} 1. Run the `ghe-upgrade` command using the package file name: ```shell @@ -183,7 +183,7 @@ While you can use a hotpatch to upgrade to the latest patch release within a fea {% data reusables.enterprise_installation.download-note %} {% data reusables.enterprise_installation.ssh-into-instance %} -1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Select the appropriate platform and copy the URL for the upgrade package (*.pkg* file). +1. {% data reusables.enterprise_installation.enterprise-download-upgrade-pkg %} Select the appropriate platform and copy the URL for the upgrade package (_.pkg_ file). {% data reusables.enterprise_installation.download-package %} 1. Enable maintenance mode and wait for all active processes to complete on the {% data variables.product.prodname_ghe_server %} instance. For more information, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/enabling-and-scheduling-maintenance-mode)." diff --git a/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md b/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md index 2c112f9426..7b242a903a 100644 --- a/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md +++ b/content/admin/github-actions/managing-access-to-actions-from-githubcom/using-the-latest-version-of-the-official-bundled-actions.md @@ -29,8 +29,8 @@ You can use {% data variables.product.prodname_github_connect %} to allow {% dat Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using `v1` of the `actions/checkout` action, and you need to use `{% data reusables.actions.action-checkout %}` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: -1. From an enterprise owner account on {% data variables.product.product_name %}, navigate to the repository you want to delete from the *actions* organization (in this example `checkout`). -1. By default, site administrators are not owners of the bundled *actions* organization. To get the access required to delete the `checkout` repository, you must use the site admin tools. Click {% octicon "rocket" aria-label="Site admin" %} in the upper-right corner of any page in that repository. +1. From an enterprise owner account on {% data variables.product.product_name %}, navigate to the repository you want to delete from the _actions_ organization (in this example `checkout`). +1. By default, site administrators are not owners of the bundled _actions_ organization. To get the access required to delete the `checkout` repository, you must use the site admin tools. Click {% octicon "rocket" aria-label="Site admin" %} in the upper-right corner of any page in that repository. 1. Click {% octicon "shield-lock" aria-hidden="true" %} **Security** to see an overview of the security for the repository. ![Screenshot of the site admin details for a repository. The "Security" link is highlighted with an orange outline.](/assets/images/enterprise/site-admin-settings/access-repo-security-info.png) diff --git a/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap.md b/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap.md index 6757dbb98c..408488c1d3 100644 --- a/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap.md +++ b/content/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap.md @@ -78,7 +78,7 @@ Use these attributes to finish configuring LDAP for {% data variables.location.p | `Domain search password` | {% octicon "x" aria-label="Optional" %} | The password for the domain search user. | | `Administrators group` | {% octicon "x" aria-label="Optional" %} | Users in this group are promoted to site administrators when signing into your appliance. If you don't configure an LDAP Administrators group, the first LDAP user account that signs into your appliance will be automatically promoted to a site administrator. | | `Domain base` | {% octicon "check" aria-label="Required" %} | The fully qualified `Distinguished Name` (DN) of an LDAP subtree you want to search for users and groups. You can add as many as you like; however, each group must be defined in the same domain base as the users that belong to it. If you specify restricted user groups, only users that belong to those groups will be in scope. We recommend that you specify the top level of your LDAP directory tree as your domain base and use restricted user groups to control access. | -| `Restricted user groups` | {% octicon "x" aria-label="Optional" %} | If specified, only users in these groups will be allowed to log in. You only need to specify the common names (CNs) of the groups, and you can add as many groups as you like. If no groups are specified, *all* users within the scope of the specified domain base will be able to sign in to your {% data variables.product.prodname_ghe_server %} instance. | +| `Restricted user groups` | {% octicon "x" aria-label="Optional" %} | If specified, only users in these groups will be allowed to log in. You only need to specify the common names (CNs) of the groups, and you can add as many groups as you like. If no groups are specified, _all_ users within the scope of the specified domain base will be able to sign in to your {% data variables.product.prodname_ghe_server %} instance. | | `User ID` | {% octicon "check" aria-label="Required" %} | The LDAP attribute that identifies the LDAP user who attempts authentication. Once a mapping is established, users may change their {% data variables.product.prodname_ghe_server %} usernames. This field should be `sAMAccountName` for most Active Directory installations, but it may be `uid` for other LDAP solutions, such as OpenLDAP. The default value is `uid`. | | `Profile name` | {% octicon "x" aria-label="Optional" %} | The name that will appear on the user's {% data variables.product.prodname_ghe_server %} profile page. Unless LDAP Sync is enabled, users may change their profile names. | | `Emails` | {% octicon "x" aria-label="Optional" %} | The email addresses for a user's {% data variables.product.prodname_ghe_server %} account. | @@ -165,10 +165,10 @@ When LDAP Sync is enabled, site admins and organization owners can search the LD This has the potential to disclose sensitive organizational information to contractors or other unprivileged users, including: -- The existence of specific LDAP Groups visible to the *Domain search user*. +- The existence of specific LDAP Groups visible to the _Domain search user_. - Members of the LDAP group who have {% data variables.product.prodname_ghe_server %} user accounts, which is disclosed when creating a team synced with that LDAP group. -If disclosing such information is not desired, your company or organization should restrict the permissions of the configured *Domain search user* in the admin console. If such restriction isn't possible, contact {% data variables.contact.contact_ent_support %}. +If disclosing such information is not desired, your company or organization should restrict the permissions of the configured _Domain search user_ in the admin console. If such restriction isn't possible, contact {% data variables.contact.contact_ent_support %}. {% endwarning %} diff --git a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md index 5daea8baca..e1bab2bd1f 100644 --- a/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md +++ b/content/admin/monitoring-activity-in-your-enterprise/reviewing-audit-logs-for-your-enterprise/audit-log-events-for-your-enterprise.md @@ -646,9 +646,9 @@ Before you'll see `git` category actions, you must enable Git events in the audi | Action | Description |--------|------------- -| `migration.create` | A migration file was created for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance. -| `migration.destroy_file` | A migration file for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance was deleted. -| `migration.download` | A migration file for transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance was downloaded. +| `migration.create` | A migration file was created for transferring data from a _source_ location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a _target_ {% data variables.product.prodname_ghe_server %} instance. +| `migration.destroy_file` | A migration file for transferring data from a _source_ location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a _target_ {% data variables.product.prodname_ghe_server %} instance was deleted. +| `migration.download` | A migration file for transferring data from a _source_ location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a _target_ {% data variables.product.prodname_ghe_server %} instance was downloaded. {%- endif %} ## `oauth_access` category actions diff --git a/content/admin/overview/system-overview.md b/content/admin/overview/system-overview.md index caf9da6a55..de4fc22b41 100644 --- a/content/admin/overview/system-overview.md +++ b/content/admin/overview/system-overview.md @@ -21,7 +21,7 @@ topics: ## Storage architecture -{% data variables.product.product_name %} requires two storage volumes, one mounted to the *root filesystem* path (`/`) and the other to the *user filesystem* path (`/data/user`). This architecture simplifies the upgrade, rollback, and recovery procedures by separating the running software environment from persistent application data. +{% data variables.product.product_name %} requires two storage volumes, one mounted to the _root filesystem_ path (`/`) and the other to the _user filesystem_ path (`/data/user`). This architecture simplifies the upgrade, rollback, and recovery procedures by separating the running software environment from persistent application data. The root filesystem is included in the distributed machine image. It contains the base operating system and the {% data variables.product.product_name %} application environment. The root filesystem should be treated as ephemeral. Any data on the root filesystem will be replaced when upgrading to future {% data variables.product.product_name %} releases. diff --git a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md index c78cdfd39a..4e08b643e6 100644 --- a/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md +++ b/content/admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment.md @@ -74,7 +74,7 @@ You can use a Linux container management tool to build a pre-receive hook enviro {% endnote %} -For more information about creating a chroot environment see "[Chroot](https://wiki.debian.org/chroot)" from the *Debian Wiki*, "[BasicChroot](https://help.ubuntu.com/community/BasicChroot)" from the *Ubuntu Community Help Wiki*, or "[Installing Alpine Linux in a chroot](https://wiki.alpinelinux.org/wiki/Installing_Alpine_Linux_in_a_chroot)" from the *Alpine Linux Wiki*. +For more information about creating a chroot environment see "[Chroot](https://wiki.debian.org/chroot)" from the _Debian Wiki_, "[BasicChroot](https://help.ubuntu.com/community/BasicChroot)" from the _Ubuntu Community Help Wiki_, or "[Installing Alpine Linux in a chroot](https://wiki.alpinelinux.org/wiki/Installing_Alpine_Linux_in_a_chroot)" from the _Alpine Linux Wiki_. ## Uploading a pre-receive hook environment on {% data variables.product.prodname_ghe_server %} 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 c057a08745..c03890f0a3 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 @@ -35,7 +35,7 @@ This string represents the following arguments. | `` | New object name to be stored in the ref.
When you delete a ref, the value is 40 zeroes. | | `` | The full name of the ref. | -For more information about `git-receive-pack`, see "[git-receive-pack](https://git-scm.com/docs/git-receive-pack)" in the Git documentation. For more information about refs, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in *Pro Git*. +For more information about `git-receive-pack`, see "[git-receive-pack](https://git-scm.com/docs/git-receive-pack)" in the Git documentation. For more information about refs, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in _Pro Git_. ### Output (`stdout`) @@ -259,4 +259,4 @@ You can test a pre-receive hook script locally before you create or update it on Notice that the push was rejected after executing the pre-receive hook and echoing the output from the script. ## Further reading -- "[Customizing Git - An Example Git-Enforced Policy](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)" from the *Pro Git website* +- "[Customizing Git - An Example Git-Enforced Policy](https://git-scm.com/book/en/v2/Customizing-Git-An-Example-Git-Enforced-Policy)" from the _Pro Git website_ diff --git a/content/admin/user-management/managing-users-in-your-enterprise/rebuilding-contributions-data.md b/content/admin/user-management/managing-users-in-your-enterprise/rebuilding-contributions-data.md index 3759685388..43a8617745 100644 --- a/content/admin/user-management/managing-users-in-your-enterprise/rebuilding-contributions-data.md +++ b/content/admin/user-management/managing-users-in-your-enterprise/rebuilding-contributions-data.md @@ -14,7 +14,7 @@ topics: - User account shortTitle: Rebuild contributions --- -Whenever a commit is pushed to {% data variables.product.prodname_enterprise %}, it is linked to a user account if they are both associated with the same email address. However, existing commits are *not* retroactively linked when a user registers a new email address or creates a new account. +Whenever a commit is pushed to {% data variables.product.prodname_enterprise %}, it is linked to a user account if they are both associated with the same email address. However, existing commits are _not_ retroactively linked when a user registers a new email address or creates a new account. {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.search-user %} diff --git a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md index 712d96c774..34d904ee53 100644 --- a/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md +++ b/content/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps.md @@ -51,11 +51,11 @@ Name | Description **`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% ifversion ghes or ghae %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/enterprise-admin).{% endif %} **`repo`** | Grants full access to public{% ifversion ghec or ghes or ghae %}, internal,{% endif %} and private repositories including read and write access to code, commit statuses, repository invitations, collaborators, deployment statuses, and repository webhooks. **Note**: In addition to repository related resources, the `repo` scope also grants access to manage organization-owned resources including projects, invitations, team memberships and webhooks. This scope also grants the ability to manage projects owned by users. - `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. - `repo_deployment`| Grants access to [deployment statuses](/rest/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% ifversion not ghae %} + `repo:status`| Grants read/write access to commit statuses in {% ifversion fpt %}public and private{% elsif ghec or ghes %}public, private, and internal{% elsif ghae %}private and internal{% endif %} repositories. This scope is only necessary to grant other users or services access to private repository commit statuses _without_ granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/repos#deployments) for {% ifversion not ghae %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, _without_ granting access to the code.{% ifversion not ghae %}  `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %} - `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% ifversion fpt or ghes or ghec %} - `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/code-scanning) {%- ifversion ghec %}
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/secret-scanning){%- endif %}
This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} + `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites _without_ granting access to the code.{% ifversion fpt or ghes or ghec %} + `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/code-scanning) {%- ifversion ghec %}
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/secret-scanning){%- endif %}
This scope is only necessary to grant other users or services access to security events _without_ granting access to the code.{% endif %} **`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. The `repo` {% ifversion fpt or ghec or ghes %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks.  `write:repo_hook` | Grants read, write, and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories.  `read:repo_hook`| Grants read and ping access to hooks in {% ifversion fpt %}public or private{% elsif ghec or ghes %}public, private, or internal{% elsif ghae %}private or internal{% endif %} repositories. diff --git a/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md b/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md index f54c2d3d1a..b41757d7ea 100644 --- a/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md +++ b/content/apps/oauth-apps/using-oauth-apps/authorizing-oauth-apps.md @@ -29,10 +29,10 @@ When an {% data variables.product.prodname_oauth_app %} wants to identify you by ## {% data variables.product.prodname_oauth_app %} access -{% data variables.product.prodname_oauth_apps %} can have *read* or *write* access to your {% data variables.product.product_name %} data. +{% data variables.product.prodname_oauth_apps %} can have _read_ or _write_ access to your {% data variables.product.product_name %} data. -- **Read access** only allows an app to *look at* your data. -- **Write access** allows an app to *change* your data. +- **Read access** only allows an app to _look at_ your data. +- **Write access** allows an app to _change_ your data. {% tip %} @@ -42,7 +42,7 @@ When an {% data variables.product.prodname_oauth_app %} wants to identify you by ### About OAuth scopes -*Scopes* are named groups of permissions that an {% data variables.product.prodname_oauth_app %} can request to access both public and non-public data. +_Scopes_ are named groups of permissions that an {% data variables.product.prodname_oauth_app %} can request to access both public and non-public data. When you want to use an {% data variables.product.prodname_oauth_app %} that integrates with {% data variables.product.product_name %}, that app lets you know what type of access to your data will be required. If you grant access to the app, then the app will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." @@ -81,9 +81,9 @@ When {% data variables.product.prodname_oauth_apps %} request new access permiss When you authorize an {% data variables.product.prodname_oauth_app %} for your personal account, you'll also see how the authorization will affect each organization you're a member of. -- **For organizations *with* {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) yourself. +- **For organizations _with_ {% data variables.product.prodname_oauth_app %} access restrictions, you can request that organization admins approve the application for use in that organization.** If the organization does not approve the application, then the application will only be able to access the organization's public resources. If you're an organization admin, you can [approve the application](/organizations/managing-oauth-access-to-your-organizations-data/approving-oauth-apps-for-your-organization) yourself. -- **For organizations *without* {% data variables.product.prodname_oauth_app %} access restrictions, the application will automatically be authorized for access to that organization's resources.** For this reason, you should be careful about which {% data variables.product.prodname_oauth_apps %} you approve for access to your personal account resources as well as any organization resources. +- **For organizations _without_ {% data variables.product.prodname_oauth_app %} access restrictions, the application will automatically be authorized for access to that organization's resources.** For this reason, you should be careful about which {% data variables.product.prodname_oauth_apps %} you approve for access to your personal account resources as well as any organization resources. If you belong to any organizations with SAML single sign-on (SSO) enabled, and you have created a linked identity for that organization by authenticating via SAML in the past, you must have an active SAML session for each organization each time you authorize an {% data variables.product.prodname_oauth_app %}. diff --git a/content/apps/oauth-apps/using-oauth-apps/connecting-with-third-party-applications.md b/content/apps/oauth-apps/using-oauth-apps/connecting-with-third-party-applications.md index a845a20f65..198f80a64e 100644 --- a/content/apps/oauth-apps/using-oauth-apps/connecting-with-third-party-applications.md +++ b/content/apps/oauth-apps/using-oauth-apps/connecting-with-third-party-applications.md @@ -27,14 +27,14 @@ If the developer has chosen to supply further information, the right-hand side o ## Types of application access and data -Applications can have *read* or *write* access to your {% data variables.product.product_name %} data. +Applications can have _read_ or _write_ access to your {% data variables.product.product_name %} data. -- **Read access** only allows an application to *look at* your data. -- **Write access** allows an application to *change* your data. +- **Read access** only allows an application to _look at_ your data. +- **Write access** allows an application to _change_ your data. ### About OAuth scopes -*Scopes* are named groups of permissions that an application can request to access both public and non-public data. +_Scopes_ are named groups of permissions that an application can request to access both public and non-public data. When you want to use a third-party application that integrates with {% data variables.product.product_name %}, that application lets you know what type of access to your data will be required. If you grant access to the application, then the application will be able to perform actions on your behalf, such as reading or modifying data. For example, if you want to use an app that requests `user:email` scope, the app will have read-only access to your private email addresses. For more information, see "[AUTOTITLE](/apps/oauth-apps/building-oauth-apps/scopes-for-oauth-apps)." diff --git a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md index 24745295c2..0728b87c13 100644 --- a/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys.md @@ -35,19 +35,19 @@ Before you generate a new SSH key, you should check your local machine for exist # Lists the files in your .ssh directory, if they exist ``` -3. Check the directory listing to see if you already have a public SSH key. By default, the {% ifversion ghae %}filename of a supported public key for {% data variables.product.product_name %} is *id_rsa.pub*.{% else %}filenames of supported public keys for {% data variables.product.product_name %} are one of the following. - - *id_rsa.pub* - - *id_ecdsa.pub* - - *id_ed25519.pub*{% endif %} +3. Check the directory listing to see if you already have a public SSH key. By default, the {% ifversion ghae %}filename of a supported public key for {% data variables.product.product_name %} is _id_rsa.pub_.{% else %}filenames of supported public keys for {% data variables.product.product_name %} are one of the following. + - _id_rsa.pub_ + - _id_ecdsa.pub_ + - _id_ed25519.pub_{% endif %} {% tip %} - **Tip**: If you receive an error that *~/.ssh* doesn't exist, you do not have an existing SSH key pair in the default location. You can create a new SSH key pair in the next step. + **Tip**: If you receive an error that _~/.ssh_ doesn't exist, you do not have an existing SSH key pair in the default location. You can create a new SSH key pair in the next step. {% endtip %} 4. Either generate a new SSH key or upload an existing key. - If you don't have a supported public and private key pair, or don't wish to use any that are available, generate a new SSH key. - - If you see an existing public and private key pair listed (for example, *id_rsa.pub* and *id_rsa*) that you would like to use to connect to {% data variables.product.product_name %}, you can add the key to the ssh-agent. + - If you see an existing public and private key pair listed (for example, _id_rsa.pub_ and _id_rsa_) that you would like to use to connect to {% data variables.product.product_name %}, you can add the key to the ssh-agent. For more information about generation of a new SSH key or addition of an existing key to the ssh-agent, see "[AUTOTITLE](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent)." diff --git a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md index 87f87886fe..9b5824828d 100644 --- a/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md +++ b/content/authentication/connecting-to-github-with-ssh/managing-deploy-keys.md @@ -161,7 +161,7 @@ If your server needs to access multiple repositories, you can create a new accou **Tip:** Our [terms of service][tos] state: -> *Accounts registered by "bots" or other automated methods are not permitted.* +> _Accounts registered by "bots" or other automated methods are not permitted._ 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. diff --git a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md index ca84dec2cb..af556c9444 100644 --- a/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md +++ b/content/authentication/connecting-to-github-with-ssh/using-ssh-agent-forwarding.md @@ -48,7 +48,7 @@ We're off to a great start. Let's set up SSH to allow agent forwarding to your s {% warning %} -**Warning:** You may be tempted to use a wildcard like `Host *` to just apply this setting to all SSH connections. That's not really a good idea, as you'd be sharing your local SSH keys with *every* server you SSH into. They won't have direct access to the keys, but they will be able to use them *as you* while the connection is established. **You should only add servers you trust and that you intend to use with agent forwarding.** +**Warning:** You may be tempted to use a wildcard like `Host *` to just apply this setting to all SSH connections. That's not really a good idea, as you'd be sharing your local SSH keys with _every_ server you SSH into. They won't have direct access to the keys, but they will be able to use them _as you_ while the connection is established. **You should only add servers you trust and that you intend to use with agent forwarding.** {% endwarning %} 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 5121fc3a3f..fa7851831d 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 @@ -97,8 +97,8 @@ The `ssh-agent` process will continue to run until you log out, shut down your c On Mac OS X Leopard through OS X El Capitan, these default private key files are handled automatically: -- *.ssh/id_rsa* -- *.ssh/identity* +- _.ssh/id_rsa_ +- _.ssh/identity_ The first time you use your key, you will be prompted to enter your passphrase. If you choose to save the passphrase with your keychain, you won't have to enter it again. diff --git a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md index 8bd79f574d..48f7e8f369 100644 --- a/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md +++ b/content/authentication/keeping-your-account-and-data-secure/about-anonymized-urls.md @@ -76,7 +76,7 @@ Check the value of `Cache-Control`. In this example, there's no `Cache-Control`. - If you own the server that's hosting the image, modify it so that it returns a `Cache-Control` of `no-cache` for images. - If you're using an external service for hosting images, contact support for that service. - If `Cache-Control` *is* set to `no-cache`, contact {% data variables.contact.contact_support %} or search the {% data variables.contact.community_support_forum %}. + If `Cache-Control` _is_ set to `no-cache`, contact {% data variables.contact.contact_support %} or search the {% data variables.contact.community_support_forum %}. ### Removing an image from Camo's cache 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 b60d9781af..ffe213f065 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 @@ -82,7 +82,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil ``` brew install git-filter-repo ``` - For more information, see [*INSTALL.md*](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. + For more information, see [_INSTALL.md_](https://github.com/newren/git-filter-repo/blob/main/INSTALL.md) in the `newren/git-filter-repo` repository. 2. If you don't already have a local copy of your repository with sensitive data in its history, [clone the repository](/repositories/creating-and-managing-repositories/cloning-a-repository) to your local computer. ```shell @@ -101,7 +101,7 @@ To illustrate how `git filter-repo` works, we'll show you how to remove your fil 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 - Remove the specified file, as well as any empty commits generated as a result - - Remove some configurations, such as the remote URL, stored in the *.git/config* file. You may want to back up this file in advance for restoration later. + - Remove some configurations, such as the remote URL, stored in the _.git/config_ file. You may want to back up this file in advance for restoration later. - **Overwrite your existing tags** ```shell $ git filter-repo --invert-paths --path PATH-TO-YOUR-FILE-WITH-SENSITIVE-DATA @@ -163,7 +163,7 @@ After using either the BFG tool or `git filter-repo` to remove the sensitive dat 1. Contact {% data variables.contact.contact_support %}, asking them to remove cached views and references to the sensitive data in pull requests on {% data variables.product.product_name %}. Please provide the name of the repository and/or a link to the commit you need removed.{% ifversion ghes %} For more information about how site administrators can remove unreachable Git objects, see "[AUTOTITLE](/admin/configuration/configuring-your-enterprise/command-line-utilities#ghe-repo-gc)."{% endif %} -2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), *not* merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. +2. Tell your collaborators to [rebase](https://git-scm.com/book/en/Git-Branching-Rebasing), _not_ merge, any branches they created off of your old (tainted) repository history. One merge commit could reintroduce some or all of the tainted history that you just went to the trouble of purging. 3. After some time has passed and you're confident that the BFG tool / `git filter-repo` had no unintended side effects, you can force all objects in your local repository to be dereferenced and garbage collected with the following commands (using Git 1.8.5 or newer): ```shell 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 62a9798a48..030a1fbaf8 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 @@ -40,7 +40,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an > 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. +7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endmac %} @@ -68,7 +68,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an > 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. +7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endwindows %} @@ -94,7 +94,7 @@ You can delete unauthorized (or possibly compromised) SSH keys to ensure that an > 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. +7. The SSH keys on {% data variables.product.product_name %} _should_ match the same keys on your computer. {% endlinux %} 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 baf57833dd..afdc7a556c 100644 --- a/content/authentication/troubleshooting-ssh/error-key-already-in-use.md +++ b/content/authentication/troubleshooting-ssh/error-key-already-in-use.md @@ -24,7 +24,7 @@ $ ssh -T -ai ~/.ssh/id_rsa git@{% data variables.command_line.codeblock %} > provide shell access. ``` -The *username* in the response is the account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} that the key is currently attached to. If the response looks something like "username/repo", the key has been attached to a repository as a [*deploy key*](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). +The _username_ in the response is the account on {% ifversion ghae %}{% data variables.product.product_name %}{% else %}{% data variables.location.product_location %}{% endif %} that the key is currently attached to. If the response looks something like "username/repo", the key has been attached to a repository as a [_deploy key_](/authentication/connecting-to-github-with-ssh/managing-deploy-keys#deploy-keys). To force SSH to use only the key provided on the command line, use `-o` to add the `IdentitiesOnly=yes` option: diff --git a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md index abaca801aa..dedbc662b4 100644 --- a/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md +++ b/content/authentication/troubleshooting-ssh/error-permission-denied-publickey.md @@ -16,7 +16,7 @@ shortTitle: Permission denied (publickey) --- ## Should the `sudo` command or elevated privileges be used with Git? -You should not be using the `sudo` command or elevated privileges, such as administrator permissions, with Git. If you have a *very good reason* you must use `sudo`, then ensure you are using it with every command (it's probably just better to use `su` to get a shell as root at that point). If you [generate SSH keys](/authentication/connecting-to-github-with-ssh) without `sudo` and then try to use a command like `sudo git push`, you won't be using the same keys that you generated. +You should not be using the `sudo` command or elevated privileges, such as administrator permissions, with Git. If you have a _very good reason_ you must use `sudo`, then ensure you are using it with every command (it's probably just better to use `su` to get a shell as root at that point). If you [generate SSH keys](/authentication/connecting-to-github-with-ssh) without `sudo` and then try to use a command like `sudo git push`, you won't be using the same keys that you generated. ## Check that you are connecting to the correct server @@ -95,7 +95,7 @@ $ ssh -T git@{% data variables.command_line.codeblock %} {% endlinux %} -The `ssh-add` command *should* print out a long string of numbers and letters. If it does not print anything, you will need to [generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and associate it with {% data variables.product.product_name %}. +The `ssh-add` command _should_ print out a long string of numbers and letters. If it does not print anything, you will need to [generate a new SSH key](/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) and associate it with {% data variables.product.product_name %}. {% tip %} diff --git a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md index 2d8d61da23..afceb5e83c 100644 --- a/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md +++ b/content/billing/managing-your-github-billing-settings/redeeming-a-coupon.md @@ -27,7 +27,7 @@ You cannot apply coupons to paid plans for {% data variables.product.prodname_ma ## Redeeming a coupon for your personal account {% data reusables.dotcom_billing.enter_coupon_code_on_redeem_page %} -4. Under "Redeem your coupon", click **Choose** next to your *personal* account's username. +4. Under "Redeem your coupon", click **Choose** next to your _personal_ account's username. {% data reusables.dotcom_billing.redeem_coupon %} ## Redeeming a coupon for your organization @@ -35,5 +35,5 @@ You cannot apply coupons to paid plans for {% data variables.product.prodname_ma {% data reusables.dotcom_billing.org-billing-perms %} {% data reusables.dotcom_billing.enter_coupon_code_on_redeem_page %} -4. Under "Redeem your coupon", click **Choose** next to the *organization* you want to apply the coupon to. If you'd like to apply your coupon to a new organization that doesn't exist yet, click **Create a new organization**. +4. Under "Redeem your coupon", click **Choose** next to the _organization_ you want to apply the coupon to. If you'd like to apply your coupon to a new organization that doesn't exist yet, click **Create a new organization**. {% data reusables.dotcom_billing.redeem_coupon %} diff --git a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md index 03a50b01e3..84d32dc962 100644 --- a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md +++ b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/about-organizations-for-procurement-companies.md @@ -20,7 +20,7 @@ shortTitle: About organizations To access an organization, each member must sign into their own personal account. -Organization members can have different roles, such as *owner* or *billing manager*: +Organization members can have different roles, such as _owner_ or _billing manager_: - **Owners** have complete administrative access to an organization and its contents. - **Billing managers** can manage billing settings, and cannot access organization contents. Billing managers are not shown in the list of organization members. diff --git a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md index 1830b5c2d5..ae81494560 100644 --- a/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md +++ b/content/billing/setting-up-paid-accounts-for-procurement-companies/setting-up-paid-organizations-for-procurement-companies/upgrading-or-downgrading-your-clients-paid-organization.md @@ -22,7 +22,7 @@ shortTitle: Upgrade or downgrade **Tips**: - Before you upgrade your client's organization, you can [view or update the payment method on file for the organization](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method). -- These instructions are for upgrading and downgrading organizations on the *per-seat subscription*. If your client pays for {% data variables.product.product_name %} using a *legacy per-repository* plan, you can upgrade or [downgrade](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription) their legacy plan, or [switch their organization to per-seat pricing](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription). +- These instructions are for upgrading and downgrading organizations on the _per-seat subscription_. If your client pays for {% data variables.product.product_name %} using a _legacy per-repository_ plan, you can upgrade or [downgrade](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription) their legacy plan, or [switch their organization to per-seat pricing](/billing/managing-billing-for-your-github-account/upgrading-your-github-subscription). {% endtip %} diff --git a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md index 690642eeed..fbd5e0fece 100644 --- a/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md +++ b/content/code-security/code-scanning/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system.md @@ -225,7 +225,7 @@ codeql github upload-results \ | Option | Required | Usage | |--------|:--------:|-----| -| `--repository` | {% octicon "check" aria-label="Required" %} | Specify the *OWNER/NAME* of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." +| `--repository` | {% octicon "check" aria-label="Required" %} | Specify the _OWNER/NAME_ of the repository to upload data to. The owner must be an organization within an enterprise that has a license for {% data variables.product.prodname_GH_advanced_security %} and {% data variables.product.prodname_GH_advanced_security %} must be enabled for the repository{% ifversion fpt or ghec %}, unless the repository is public{% endif %}. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository)." | `--ref` | {% octicon "check" aria-label="Required" %} | Specify the name of the `ref` you checked out and analyzed so that the results can be matched to the correct code. For a branch use: `refs/heads/BRANCH-NAME`, for the head commit of a pull request use `refs/pull/NUMBER/head`, or for the {% data variables.product.prodname_dotcom %}-generated merge commit of a pull request use `refs/pull/NUMBER/merge`. | `--commit` | {% octicon "check" aria-label="Required" %} | Specify the full SHA of the commit you analyzed. | `--sarif` | {% octicon "check" aria-label="Required" %} | Specify the SARIF file to load.{% ifversion ghes or ghae %} @@ -314,7 +314,7 @@ For more information about pack compatibility, see "[AUTOTITLE](/code-security/c This example runs the `codeql database analyze` command with the `--download` option to: 1. Download the latest version of the `octo-org/security-queries` pack. -2. Download a version of the `octo-org/optional-security-queries` pack that is *compatible* with version 1.0.1 (in this case, it is version 1.0.2). For more information on semver compatibility, see [npm's semantic version range documentation](https://github.com/npm/node-semver#ranges). +2. Download a version of the `octo-org/optional-security-queries` pack that is _compatible_ with version 1.0.1 (in this case, it is version 1.0.2). For more information on semver compatibility, see [npm's semantic version range documentation](https://github.com/npm/node-semver#ranges). 3. Run all the default queries in `octo-org/security-queries`. 4. Run only the query `queries/csrf.ql` from `octo-org/optional-security-queries` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md index cff195d6b1..7e0d1cd9b8 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-decode.md @@ -71,7 +71,7 @@ for all columns. Select output format. Choices include: -`text` *(default)*: A human-readable plain text table. +`text` _(default)_: A human-readable plain text table. `csv`: Comma-separated values. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md index 782178963f..8dce04567e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-info.md @@ -48,7 +48,7 @@ options of [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. ### Supporting pagination in codeql bqrs decode diff --git a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md index 3dac7c4172..7d9852766b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/bqrs-interpret.md @@ -138,9 +138,9 @@ languages or different parts of the code. If you analyze the same version of a code base in several different ways (e.g., for different languages) and upload the results to GitHub for presentation in Code Scanning, this value should differ between each of -the analyses, which tells Code Scanning that the analyses *supplement* -rather than *supersede* each other. (The values should be consistent -between runs of the same analysis for *different* versions of the code +the analyses, which tells Code Scanning that the analyses _supplement_ +rather than _supersede_ each other. (The values should be consistent +between runs of the same analysis for _different_ versions of the code base.) This value will appear (with a trailing slash appended if not already @@ -153,7 +153,7 @@ present) as the `.automationId` property in SARIF v1, the The number of threads used for computing paths. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--sarif-run-property=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md b/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md index e99108ff45..c7cea662dd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-analyze.md @@ -39,7 +39,7 @@ Run a query suite (or some individual queries) against a CodeQL database, producing results, styled as alerts or paths, in SARIF or another interpreted format. -This command combines the effect of the [codeql database run-queries](/code-security/codeql-cli/codeql-cli-manual/database-run-queries) and [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results) commands. If you want to run queries whose results *don't* meet the requirements for +This command combines the effect of the [codeql database run-queries](/code-security/codeql-cli/codeql-cli-manual/database-run-queries) and [codeql database interpret-results](/code-security/codeql-cli/codeql-cli-manual/database-interpret-results) commands. If you want to run queries whose results _don't_ meet the requirements for being interpreted as source-code alerts, use [codeql database run-queries](/code-security/codeql-cli/codeql-cli-manual/database-run-queries) or [codeql query run](/code-security/codeql-cli/codeql-cli-manual/query-run) instead, and then [codeql bqrs decode](/code-security/codeql-cli/codeql-cli-manual/bqrs-decode) to convert the raw results to a readable notation. @@ -184,9 +184,9 @@ languages or different parts of the code. If you analyze the same version of a code base in several different ways (e.g., for different languages) and upload the results to GitHub for presentation in Code Scanning, this value should differ between each of -the analyses, which tells Code Scanning that the analyses *supplement* -rather than *supersede* each other. (The values should be consistent -between runs of the same analysis for *different* versions of the code +the analyses, which tells Code Scanning that the analyses _supplement_ +rather than _supersede_ each other. (The values should be consistent +between runs of the same analysis for _different_ versions of the code base.) This value will appear (with a trailing slash appended if not already @@ -228,7 +228,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -287,17 +287,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs @@ -332,7 +332,7 @@ How to handle warnings from the QL compiler. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with compilation. +`show` _(default)_: Print warnings but continue with compilation. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md index e47d5af44b..d923f6a11a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-bundle.md @@ -103,7 +103,7 @@ Select how aggressively to trim the cache. Choices include: `brutal`: Remove the entire cache, trimming down to the state of a freshly extracted dataset -`normal` *(default)*: Trim everything except explicitly "cached" +`normal` _(default)_: Trim everything except explicitly "cached" predicates. `light`: Simply make sure the defined size limits for the disk cache are diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md b/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md index b3dd2f256d..70522ae25b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-cleanup.md @@ -77,7 +77,7 @@ Select how aggressively to trim the cache. Choices include: `brutal`: Remove the entire cache, trimming down to the state of a freshly extracted dataset -`normal` *(default)*: Trim everything except explicitly "cached" +`normal` _(default)_: Trim everything except explicitly "cached" predicates. `light`: Simply make sure the defined size limits for the disk cache are diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md index 6b3f339293..53b20cc2aa 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-create.md @@ -40,10 +40,10 @@ one of the CodeQL products. #### `` \[Mandatory] Path to the CodeQL database to create. This directory will -be created, and *must not* already exist (but its parent must). +be created, and _must not_ already exist (but its parent must). If the `--db-cluster` option is given, this will not be a database -itself, but a directory that will *contain* databases for several +itself, but a directory that will _contain_ databases for several languages built from the same source root. It is important that this directory is not in a location that the build @@ -107,7 +107,7 @@ Use this many threads for the import operation, and pass it as a hint to any invoked build commands. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` @@ -126,7 +126,7 @@ If no build command is specified, the command attempts to figure out automatically how to build the source tree, based on heuristics from the selected language pack. -Beware that some combinations of multiple languages *require* an +Beware that some combinations of multiple languages _require_ an explicit build command to be specified. #### `--no-cleanup` @@ -230,7 +230,7 @@ Select how aggressively to trim the cache. Choices include: `brutal`: Remove the entire cache, trimming down to the state of a freshly extracted dataset -`normal` *(default)*: Trim everything except explicitly "cached" +`normal` _(default)_: Trim everything except explicitly "cached" predicates. `light`: Simply make sure the defined size limits for the disk cache are diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md b/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md index 76b34ed9de..d6faa32732 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-export-diagnostics.md @@ -45,7 +45,7 @@ Available since `v2.12.6`. have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). If the `--db-cluster` option is given, this is not a database itself, -but a directory that *contains* databases, and all of those databases +but a directory that _contains_ databases, and all of those databases will be processed together. #### `--format=` @@ -67,7 +67,7 @@ of SARIF between different CodeQL versions. #### `--[no-]db-cluster` Indicates that the directory given on the command line is not a database -itself, but a directory that *contains* one or more databases under +itself, but a directory that _contains_ one or more databases under construction. Those databases will be processed together. #### `-o, --output=` @@ -92,9 +92,9 @@ languages or different parts of the code. If you analyze the same version of a code base in several different ways (e.g., for different languages) and upload the results to GitHub for presentation in Code Scanning, this value should differ between each of -the analyses, which tells Code Scanning that the analyses *supplement* -rather than *supersede* each other. (The values should be consistent -between runs of the same analysis for *different* versions of the code +the analyses, which tells Code Scanning that the analyses _supplement_ +rather than _supersede_ each other. (The values should be consistent +between runs of the same analysis for _different_ versions of the code base.) This value will appear (with a trailing slash appended if not already diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md b/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md index 2089ef5609..be61b923af 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-finalize.md @@ -42,13 +42,13 @@ Finalize a database that was created with [codeql database init](/code-security/ have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). If the `--db-cluster` option is given, this is not a database itself, -but a directory that *contains* databases, and all of those databases +but a directory that _contains_ databases, and all of those databases will be processed together. #### `--[no-]db-cluster` Indicates that the directory given on the command line is not a database -itself, but a directory that *contains* one or more databases under +itself, but a directory that _contains_ one or more databases under construction. Those databases will be processed together. #### `--additional-dbs=[:...]` @@ -93,7 +93,7 @@ database's extractor. Use this many threads for the import operation. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` @@ -136,7 +136,7 @@ Select how aggressively to trim the cache. Choices include: `brutal`: Remove the entire cache, trimming down to the state of a freshly extracted dataset -`normal` *(default)*: Trim everything except explicitly "cached" +`normal` _(default)_: Trim everything except explicitly "cached" predicates. `light`: Simply make sure the defined size limits for the disk cache are diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md b/content/code-security/codeql-cli/codeql-cli-manual/database-import.md index ec81875056..68980f60d5 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-import.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-import.md @@ -36,7 +36,7 @@ codeql database import [--dbscheme=] [--threads=] [--ram=] ...` @@ -70,7 +70,7 @@ database clusters rather than individual CodeQL databases. #### `--[no-]db-cluster` Indicates that the directory given on the command line is not a database -itself, but a directory that *contains* one or more databases under +itself, but a directory that _contains_ one or more databases under construction. Those databases will be processed together. ### Options for controlling the TRAP import operation @@ -86,7 +86,7 @@ database's extractor. Use this many threads for the import operation. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md index 745a70005d..3103a13c14 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-index-files.md @@ -64,8 +64,8 @@ Ask the extractor to use this many threads. This option is passed to the extractor as a suggestion. If the CODEQL\_THREADS environment variable is set, the environment variable value takes precedence over this option. -You can pass 0 to use one thread per core on the machine, or -*N* to -leave *N* cores unused (except still use at least one thread). +You can pass 0 to use one thread per core on the machine, or -_N_ to +leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md index 48ea465e50..2cee076e09 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-init.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-init.md @@ -46,10 +46,10 @@ extractors in the middle of an extraction operation anyway.) #### `` \[Mandatory] Path to the CodeQL database to create. This directory will -be created, and *must not* already exist (but its parent must). +be created, and _must not_ already exist (but its parent must). If the `--db-cluster` option is given, this will not be a database -itself, but a directory that will *contain* databases for several +itself, but a directory that will _contain_ databases for several languages built from the same source root. It is important that this directory is not in a location that the build diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md b/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md index 79ff9ed901..f54a10e545 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-interpret-results.md @@ -146,9 +146,9 @@ languages or different parts of the code. If you analyze the same version of a code base in several different ways (e.g., for different languages) and upload the results to GitHub for presentation in Code Scanning, this value should differ between each of -the analyses, which tells Code Scanning that the analyses *supplement* -rather than *supersede* each other. (The values should be consistent -between runs of the same analysis for *different* versions of the code +the analyses, which tells Code Scanning that the analyses _supplement_ +rather than _supersede_ each other. (The values should be consistent +between runs of the same analysis for _different_ versions of the code base.) This value will appear (with a trailing slash appended if not already @@ -161,7 +161,7 @@ present) as the `.automationId` property in SARIF v1, the The number of threads used for computing paths. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]print-diagnostics-summary` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md b/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md index 006fc4af6e..55bb53d3d6 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-print-baseline.md @@ -51,13 +51,13 @@ source root. have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). If the `--db-cluster` option is given, this is not a database itself, -but a directory that *contains* databases, and all of those databases +but a directory that _contains_ databases, and all of those databases will be processed together. #### `--[no-]db-cluster` Indicates that the directory given on the command line is not a database -itself, but a directory that *contains* one or more databases under +itself, but a directory that _contains_ one or more databases under construction. Those databases will be processed together. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md index 5fdccef214..218f128ff1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-run-queries.md @@ -115,7 +115,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -174,17 +174,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs @@ -219,7 +219,7 @@ How to handle warnings from the QL compiler. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with compilation. +`show` _(default)_: Print warnings but continue with compilation. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md index 2e091480b6..19a3522405 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-trace-command.md @@ -44,7 +44,7 @@ database. have been prepared for extraction with [codeql database init](/code-security/codeql-cli/codeql-cli-manual/database-init). If the `--db-cluster` option is given, this is not a database itself, -but a directory that *contains* databases, and all of those databases +but a directory that _contains_ databases, and all of those databases will be processed together. #### `...` @@ -65,8 +65,8 @@ Ask the extractor to use this many threads. This option is passed to the extractor as a suggestion. If the CODEQL\_THREADS environment variable is set, the environment variable value takes precedence over this option. -You can pass 0 to use one thread per core on the machine, or -*N* to -leave *N* cores unused (except still use at least one thread). +You can pass 0 to use one thread per core on the machine, or -_N_ to +leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` @@ -77,7 +77,7 @@ set, the environment variable value takes precedence over this option. #### `--[no-]db-cluster` Indicates that the directory given on the command line is not a database -itself, but a directory that *contains* one or more databases under +itself, but a directory that _contains_ one or more databases under construction. Those databases will be processed together. #### `--no-tracing` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md b/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md index ca79362d94..31b53dbc97 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/database-upgrade.md @@ -78,7 +78,7 @@ value. #### `--target-dbscheme=` -The *target* dbscheme we want to upgrade to. If this is not given, a +The _target_ dbscheme we want to upgrade to. If this is not given, a maximal upgrade path will be constructed #### `--target-sha=` @@ -120,7 +120,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -179,17 +179,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md index 18a358a8e9..65008efda4 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-check.md @@ -53,7 +53,7 @@ useful to set it to 0. Select output format. Possible choices: -`text` *(default)*: A human-readable textual rendering. +`text` _(default)_: A human-readable textual rendering. `json`: A streamed JSON array of objects. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md index 70167314f5..f46a0507b9 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-cleanup.md @@ -75,7 +75,7 @@ Select how aggressively to trim the cache. Choices include: `brutal`: Remove the entire cache, trimming down to the state of a freshly extracted dataset -`normal` *(default)*: Trim everything except explicitly "cached" +`normal` _(default)_: Trim everything except explicitly "cached" predicates. `light`: Simply make sure the defined size limits for the disk cache are diff --git a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md b/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md index 5d7819db9a..0b73a97bde 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/dataset-import.md @@ -34,7 +34,7 @@ codeql dataset import --dbscheme= [--threads=] ... -- ` -The *target* dbscheme we want to upgrade to. If this is not given, a +The _target_ dbscheme we want to upgrade to. If this is not given, a maximal upgrade path will be constructed #### `--target-sha=` @@ -116,7 +116,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -175,17 +175,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs diff --git a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md index 18b9340f23..00071d95b8 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/diagnostic-export.md @@ -74,9 +74,9 @@ languages or different parts of the code. If you analyze the same version of a code base in several different ways (e.g., for different languages) and upload the results to GitHub for presentation in Code Scanning, this value should differ between each of -the analyses, which tells Code Scanning that the analyses *supplement* -rather than *supersede* each other. (The values should be consistent -between runs of the same analysis for *different* versions of the code +the analyses, which tells Code Scanning that the analyses _supplement_ +rather than _supersede_ each other. (The values should be consistent +between runs of the same analysis for _different_ versions of the code base.) This value will appear (with a trailing slash appended if not already diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md index a0d950a5fc..de6306b603 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-queries.md @@ -68,7 +68,7 @@ absolute. It is considered relative to the root of the CodeQL pack. #### `-o, --output=` Usually this is an existing directory into which the BQRS output from -the queries will be written. Filenames *within* this directory will be +the queries will be written. Filenames _within_ this directory will be derived from the QL file names. Alternatively, if there is exactly one query to run, it may be the name @@ -110,7 +110,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -169,17 +169,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs @@ -208,7 +208,7 @@ How to handle warnings from the QL compiler. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with compilation. +`show` _(default)_: Print warnings but continue with compilation. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md index 2761ea6694..60414d7732 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server.md @@ -70,7 +70,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -129,17 +129,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md index b27a30b2d1..ac108edf14 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-query-server2.md @@ -69,7 +69,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -128,17 +128,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. #### `--search-path=[:...]` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md b/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md index e808c3dd08..42cf2521ce 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/execute-upgrades.md @@ -119,7 +119,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -178,17 +178,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md index 3907fc0ac3..37c6498050 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-log-summary.md @@ -66,7 +66,7 @@ Enabling this flag forces all timestamps to be UTC. Control the format of the output produced. -`predicates` *(default)*: Produce a summary of the computation performed +`predicates` _(default)_: Produce a summary of the computation performed for each predicate. This will be a stream of JSON objects separated either by two newline characters (by default) or one if the `--minify-output` option is passed. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md b/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md index e55d46974b..a9252af37d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/generate-query-help.md @@ -72,7 +72,7 @@ path. If no output path is provided, only a single .qhelp or .ql file will be accepted, and the output will be written to stdout. -If an output directory is used, filenames *within* the output directory +If an output directory is used, filenames _within_ the output directory will be derived from the .qhelp file names. #### `--warnings=` @@ -81,7 +81,7 @@ How to handle warnings from the query help renderer. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with rendering. +`show` _(default)_: Print warnings but continue with rendering. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md b/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md index 6b591afbf1..76330926cb 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/github-upload-results.md @@ -54,17 +54,17 @@ your release). #### `-r, --repository=` -GitHub repository owner and name (e.g., *github/octocat*) to use as an +GitHub repository owner and name (e.g., _github/octocat_) to use as an endpoint for uploading. The CLI will attempt to autodetect this from the checkout path if it is omitted. #### `-f, --ref=` Name of the ref that was analyzed. If this ref is a pull request merge -commit, then use *refs/pulls/1234/merge* or *refs/pulls/1234/head* +commit, then use _refs/pulls/1234/merge_ or _refs/pulls/1234/head_ (depending on whether or not this commit corresponds to the HEAD or MERGE commit of the PR). Otherwise, this should be a branch: -*refs/heads/branch-name*. If omitted, the CLI will attempt to +_refs/heads/branch-name_. If omitted, the CLI will attempt to automatically populate this from the current branch of the checkout path, if this exists. @@ -90,7 +90,7 @@ version 2.1.0 (this is the default version of SARIF used by CodeQL). Select output format. Choices include: -`text` *(default)*: Print the URL for tracking the status of the SARIF +`text` _(default)_: Print the URL for tracking the status of the SARIF upload. `json`: Print the response body of the SARIF upload API request. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md index 1175deb2a5..3a8bf3aa0e 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-bundle.md @@ -45,7 +45,7 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `--pack-path=` @@ -60,7 +60,7 @@ The path of the query pack file to create. This file must not yet exist. Use this many threads to compile queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md index bdd4f20633..c8c157a01a 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-ci.md @@ -56,7 +56,7 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-f, --[no-]force` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md index 14b6b8e6e9..8f232d1670 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-create.md @@ -55,14 +55,14 @@ Defaults to `./.codeql/pack`. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-j, --threads=` Use this many threads to compile queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md index 6e5a655dba..119add18c0 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-download.md @@ -53,7 +53,7 @@ version for a CodeQL pack, then the latest version will be downloaded. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-d, --dir=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md index eb20842d7f..1797cd365b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-install.md @@ -52,7 +52,7 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-f, --[no-]force` @@ -85,7 +85,7 @@ and will not be added to the package lock. \[Deprecated] Specifies how to resolve dependencies: -`minimal-update` *(default)*: Update or create the codeql-pack.lock.yml +`minimal-update` _(default)_: Update or create the codeql-pack.lock.yml based on the existing contents of the qlpack.yml file. If any existing codeql-pack.lock.yml does not satisfy the current dependencies in the qlpack.yml, the lock file will be updated as necessary. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md index b7f15611e8..97a9797ef3 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-ls.md @@ -53,7 +53,7 @@ then this operation will run on all CodeQL packages in the workspace. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `--groups=[-][,[-]...]` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md index 9b3c4d0a74..ccfc2339a4 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-packlist.md @@ -49,7 +49,7 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md index dee4b3eea0..a24f7f2190 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-publish.md @@ -61,7 +61,7 @@ Delete the pack bundle after publishing. Use this many threads to compile queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` @@ -112,7 +112,7 @@ Available since `v2.11.3`. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `--groups=[-][,[-]...]` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md index c302548566..8d7695441b 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-resolve-dependencies.md @@ -48,13 +48,13 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `--mode=` Specifies how to resolve dependencies: -`minimal-update` *(default)*: Update or create the codeql-pack.lock.yml +`minimal-update` _(default)_: Update or create the codeql-pack.lock.yml based on the existing contents of the qlpack.yml file. If any existing codeql-pack.lock.yml does not satisfy the current dependencies in the qlpack.yml, the lock file will be updated as necessary. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md b/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md index 58324d90cf..773bd13006 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/pack-upgrade.md @@ -49,7 +49,7 @@ The root directory of the package. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-f, --[no-]force` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md b/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md index 0f363a5d55..f62c582cae 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-compile.md @@ -93,14 +93,14 @@ compiled. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `-j, --threads=` Use this many threads to compile queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `-M, --ram=` @@ -115,7 +115,7 @@ How to handle warnings from the QL compiler. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with compilation. +`show` _(default)_: Print warnings but continue with compilation. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md b/content/code-security/codeql-cli/codeql-cli-manual/query-format.md index 5cd687a8c7..0bc13f37c1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-format.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-format.md @@ -51,7 +51,7 @@ Overwrite each input file with a formatted version of its content. #### `--[no-]check-only` Instead of writing output, exit with status 1 if any input files -*differ* from their correct formatting. A message telling which files +_differ_ from their correct formatting. A message telling which files differed will be printed to standard error unless you also give `-qq`. #### `-b, --backup=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md b/content/code-security/codeql-cli/codeql-cli-manual/query-run.md index 1aa8f6be01..ec80fd2c21 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/query-run.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/query-run.md @@ -99,7 +99,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). #### `--[no-]save-cache` @@ -158,17 +158,17 @@ evaluation using xterm control sequences. Possible values are: `no`: Never produce fancy progress; assume a dumb terminal. -`auto` *(default)*: Autodetect whether the command is running in an +`auto` _(default)_: Autodetect whether the command is running in an appropriate terminal. `yes`: Assume the terminal can understand xterm control sequences. The -feature still depends on being able to autodetect the *size* of the +feature still depends on being able to autodetect the _size_ of the terminal, and will also be disabled if `-q` is given. `25x80` (or similar): Like `yes`, and also explicitly give the size of the terminal. -`25x80:/dev/pts/17` (or similar): show fancy progress on a *different* +`25x80:/dev/pts/17` (or similar): show fancy progress on a _different_ terminal than stderr. Mostly useful for internal testing. ### Options for controlling outputting of structured evaluator logs @@ -203,7 +203,7 @@ How to handle warnings from the QL compiler. One of: `hide`: Suppress warnings. -`show` *(default)*: Print warnings but continue with compilation. +`show` _(default)_: Print warnings but continue with compilation. `error`: Treat warnings as errors. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md index 047b554a9b..406f80e6b2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-extractor.md @@ -67,7 +67,7 @@ and code 1 otherwise. Select output format. Choices include: -`text` *(default)*: Print the path to the found extractor pack to +`text` _(default)_: Print the path to the found extractor pack to standard output. `json`: Print the path to the found extractor pack as a JSON string. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md index 39e030699d..54771cc082 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-files.md @@ -56,7 +56,7 @@ The directory to be searched. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. ### Options for limiting the set of collected files diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md index 69c313ee0d..4ca91673f2 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-languages.md @@ -61,7 +61,7 @@ per-user configuration file). Select output format. Choices include: -`text` *(default)*: Print the paths to extractor packs to standard +`text` _(default)_: Print the paths to extractor packs to standard output. `json`: Print the paths to extractor packs as a JSON string. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md index 62a6224ef8..dfb349a0f7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-library-path.md @@ -59,7 +59,7 @@ on by default. Select output format. Choices include: -`lines` *(default)*: Print command line arguments on one line each. +`lines` _(default)_: Print command line arguments on one line each. `json`: Print a JSON object with all the data. @@ -185,7 +185,7 @@ The root directory of the pack containing queries to compile. resolution. This is used when the pack can be found by name somewhere in the search -path. If you know the *disk location* of your desired root package, +path. If you know the _disk location_ of your desired root package, pretend it contains a .ql file and use `--query` instead. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md index 77bb5f189e..7b22161630 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-qlpacks.md @@ -92,7 +92,7 @@ when the kind is `library`. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. #### `--no-recursive` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md index 893e6f4b8f..f6d54b27a1 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-queries.md @@ -71,7 +71,7 @@ absolute. It is considered relative to the root of the CodeQL pack. Select output format. Choices include: -`text` *(default)*: A line-oriented list of pathnames. +`text` _(default)_: A line-oriented list of pathnames. `json`: A plain list of pathnames as strings. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md index 5311ad5dc3..75abda4226 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-ram.md @@ -39,7 +39,7 @@ configured memory outside the Java heap. In particular, this should be used to find appropriate `-J-Xmx` and `--off-heap-ram` options before staring a query server based on a -desired *total* RAM amount. +desired _total_ RAM amount. ## Primary options @@ -47,7 +47,7 @@ desired *total* RAM amount. Select output format. Choices include: -`lines` *(default)*: Print command-line arguments on one line each. +`lines` _(default)_: Print command-line arguments on one line each. `json`: Print them as a JSON array. diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md index a93313b278..16595597b7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-tests.md @@ -47,8 +47,8 @@ Each argument is one of: #### `--slice=` -\[Advanced] Divide the test cases into *M* roughly equal-sized slices -and process only the *N*th of them. This can be used for manual +\[Advanced] Divide the test cases into _M_ roughly equal-sized slices +and process only the _N_th of them. This can be used for manual parallelization of the testing process. #### `--[no-]strict-test-discovery` @@ -71,7 +71,7 @@ files even though a `.qlref` file cannot really be a non-test. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md b/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md index af7bfce7ef..43ab6432e7 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/resolve-upgrades.md @@ -43,13 +43,13 @@ in extraordinary cases where exact control is needed. #### `--dbscheme=` -\[Mandatory] The *current* dbscheme of the dataset we want to upgrade. +\[Mandatory] The _current_ dbscheme of the dataset we want to upgrade. #### `--format=` Select output format. Choices include: -`lines` *(default)*: Print upgrade scripts on one line each. +`lines` _(default)_: Print upgrade scripts on one line each. `json`: Print a JSON array of upgrade script paths. @@ -93,7 +93,7 @@ value. #### `--target-dbscheme=` -The *target* dbscheme we want to upgrade to. If this is not given, a +The _target_ dbscheme we want to upgrade to. If this is not given, a maximal upgrade path will be constructed #### `--target-sha=` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md b/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md index f277409185..3b38198bad 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-accept.md @@ -38,11 +38,11 @@ same output will be considered to pass. What it does can also be achieved by ordinary file manipulation, but you may find its syntax more useful for this special case. -The command-line arguments specify one or more *tests* -- that is, +The command-line arguments specify one or more _tests_ -- that is, `.ql(ref)` files -- and the command automatically derives the names of the `.actual` files from them. Any test that doesn't have an `.actual` file will be silently ignored, which makes it easy to accept just the -results of *failing* tests from a previous run. +results of _failing_ tests from a previous run. ## Primary options @@ -55,8 +55,8 @@ Each argument is one of: #### `--slice=` -\[Advanced] Divide the test cases into *M* roughly equal-sized slices -and process only the *N*th of them. This can be used for manual +\[Advanced] Divide the test cases into _M_ roughly equal-sized slices +and process only the _N_th of them. This can be used for manual parallelization of the testing process. #### `--[no-]strict-test-discovery` diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md b/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md index 47cd90bba5..70bf9ff82d 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-extract.md @@ -108,7 +108,7 @@ takes up a lot of space in the dataset. #### `--format=` -Select output format, either `text` *(default)* or `json`. +Select output format, either `text` _(default)_ or `json`. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md index cda965d280..f024722619 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/test-run.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/test-run.md @@ -51,7 +51,7 @@ useful to set it to 0. Select output format. Possible choices: -`text` *(default)*: A human-readable textual rendering. +`text` _(default)_: A human-readable textual rendering. `json`: A streamed JSON array of test result objects. @@ -70,7 +70,7 @@ in the future, so consumers should ignore any event with an unrecognized \[Advanced] Preserve the databases extracted to run the test queries, even where all tests in a directory pass. (The database will always be -left present when there are tests that *fail*). +left present when there are tests that _fail_). #### `--[no-]fast-compilation` @@ -110,8 +110,8 @@ Set total amount of RAM the test runner should be allowed to use. #### `--slice=` -\[Advanced] Divide the test cases into *M* roughly equal-sized slices -and process only the *N*th of them. This can be used for manual +\[Advanced] Divide the test cases into _M_ roughly equal-sized slices +and process only the _N_th of them. This can be used for manual parallelization of the testing process. #### `--[no-]strict-test-discovery` @@ -281,7 +281,7 @@ If no timeout is specified, or is given as 0, no timeout will be set Use this many threads to evaluate queries. Defaults to 1. You can pass 0 to use one thread per core on the machine, -or -*N* to leave *N* cores unused (except still use at least one +or -_N_ to leave _N_ cores unused (except still use at least one thread). ### Options for controlling outputting of structured evaluator logs diff --git a/content/code-security/codeql-cli/codeql-cli-manual/version.md b/content/code-security/codeql-cli/codeql-cli-manual/version.md index 767c80a432..9dbdce86dd 100644 --- a/content/code-security/codeql-cli/codeql-cli-manual/version.md +++ b/content/code-security/codeql-cli/codeql-cli-manual/version.md @@ -36,7 +36,7 @@ Show the version of the CodeQL toolchain. #### `--format=` -Select output format. Choices include `text` *(default)* ,`terse`, and +Select output format. Choices include `text` _(default)_ ,`terse`, and `json`. ### Common options diff --git a/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces.md b/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces.md index d78c945135..e85d5b8a74 100644 --- a/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces.md +++ b/content/code-security/codeql-cli/codeql-cli-reference/about-codeql-workspaces.md @@ -20,7 +20,7 @@ redirect_from: You use a {% data variables.product.prodname_codeql %} workspace when you want to group multiple {% data variables.product.prodname_codeql %} packs together. A typical use case for a {% data variables.product.prodname_codeql %} workspace is to develop a set of {% data variables.product.prodname_codeql %} library and query packs that are mutually dependent. For more information on {% data variables.product.prodname_codeql %} packs, see "[About {% data variables.product.prodname_codeql %} packs](/code-security/codeql-cli/codeql-cli-reference/about-codeql-packs)." -The main benefit of a {% data variables.product.prodname_codeql %} workspace is that it makes it easier for you to develop and maintain multiple {% data variables.product.prodname_codeql %} packs. When you use a {% data variables.product.prodname_codeql %} workspace, all the {% data variables.product.prodname_codeql %} packs in the workspace are available as *source dependencies* for each other when you run a {% data variables.product.prodname_codeql %} command that resolves queries. This makes it easier to develop, maintain, and publish multiple, related {% data variables.product.prodname_codeql %} packs. +The main benefit of a {% data variables.product.prodname_codeql %} workspace is that it makes it easier for you to develop and maintain multiple {% data variables.product.prodname_codeql %} packs. When you use a {% data variables.product.prodname_codeql %} workspace, all the {% data variables.product.prodname_codeql %} packs in the workspace are available as _source dependencies_ for each other when you run a {% data variables.product.prodname_codeql %} command that resolves queries. This makes it easier to develop, maintain, and publish multiple, related {% data variables.product.prodname_codeql %} packs. In most cases, you should store the {% data variables.product.prodname_codeql %} workspace and the {% data variables.product.prodname_codeql %} packs contained in it in one git repository. This makes it easier to share your {% data variables.product.prodname_codeql %} development environment. diff --git a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.md b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.md index c170aca0f4..70c3527641 100644 --- a/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.md +++ b/content/code-security/codeql-cli/using-the-codeql-cli/creating-codeql-query-suites.md @@ -210,7 +210,7 @@ and `@precision high` from the `my-custom-queries` directory, use: precision: very-high ``` -Note that the following query suite definition behaves differently from the definition above. This definition selects queries that are `@kind problem` *or* +Note that the following query suite definition behaves differently from the definition above. This definition selects queries that are `@kind problem` _or_ are `@precision very-high`: ``` diff --git a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md index d8841df126..f0cb8e6e86 100644 --- a/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md +++ b/content/code-security/dependabot/dependabot-alerts/viewing-and-updating-dependabot-alerts.md @@ -90,7 +90,7 @@ For supported languages, {% data variables.product.prodname_dependabot %} automa {% note %} -**Note:** During the beta release, this feature is available only for new Python advisories created *after* April 14, 2022, and for a subset of historical Python advisories. {% data variables.product.prodname_dotcom %} is working to backfill data across additional historical Python advisories, which are added on a rolling basis. Vulnerable calls are highlighted only on the {% data variables.product.prodname_dependabot_alerts %} pages. +**Note:** During the beta release, this feature is available only for new Python advisories created _after_ April 14, 2022, and for a subset of historical Python advisories. {% data variables.product.prodname_dotcom %} is working to backfill data across additional historical Python advisories, which are added on a rolling basis. Vulnerable calls are highlighted only on the {% data variables.product.prodname_dependabot_alerts %} pages. {% endnote %} diff --git a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md index 7b3b969e64..da2110338f 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file.md @@ -24,23 +24,23 @@ shortTitle: Configure dependabot.yml {% data reusables.dependabot.beta-security-and-version-updates %} {% data reusables.dependabot.enterprise-enable-dependabot %} -## About the *dependabot.yml* file +## About the _dependabot.yml_ file -The {% data variables.product.prodname_dependabot %} configuration file, *dependabot.yml*, uses YAML syntax. If you're new to YAML and want to learn more, see "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)." +The {% data variables.product.prodname_dependabot %} configuration file, _dependabot.yml_, uses YAML syntax. If you're new to YAML and want to learn more, see "[Learn YAML in five minutes](https://www.codeproject.com/Articles/1214409/Learn-YAML-in-five-minutes)." -You must store this file in the `.github` directory of your repository. When you add or update the *dependabot.yml* file, this triggers an immediate check for version updates. For more information and an example, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." +You must store this file in the `.github` directory of your repository. When you add or update the _dependabot.yml_ file, this triggers an immediate check for version updates. For more information and an example, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." 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 "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)." {% note %} -**Note:** You cannot configure {% data variables.product.prodname_dependabot_alerts %} using the *dependabot.yml* file. +**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`. +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 +## Configuration options for the _dependabot.yml_ file The top-level `updates` key is mandatory. You use it to configure how {% data variables.product.prodname_dependabot %} updates the versions or your project's dependencies. Each entry configures the update settings for a particular package manager. You can use the following options. @@ -108,7 +108,7 @@ updates: ### `directory` -**Required**. You must define the location of the package manifests for each package manager (for example, the *package.json* or *Gemfile*). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. +**Required**. You must define the location of the package manifests for each package manager (for example, the _package.json_ or _Gemfile_). You define the directory relative to the root of the repository for all ecosystems except GitHub Actions. For GitHub Actions, set the directory to `/` to check for workflow files in `.github/workflows`. ```yaml # Specify location of manifest files for each package manager @@ -844,7 +844,7 @@ The top-level `registries` key is optional. It allows you to specify authenticat {% endif %} -The value of the `registries` key is an associative array, each element of which consists of a key that identifies a particular registry and a value which is an associative array that specifies the settings required to access that registry. The following *dependabot.yml* file configures a registry identified as `dockerhub` in the `registries` section of the file and then references this in the `updates` section of the file. +The value of the `registries` key is an associative array, each element of which consists of a key that identifies a particular registry and a value which is an associative array that specifies the settings required to access that registry. The following _dependabot.yml_ file configures a registry identified as `dockerhub` in the `registries` section of the file and then references this in the `updates` section of the file. {% raw %} ```yaml diff --git a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md index e7c2f5dd1f..a7b16b834a 100644 --- a/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates.md @@ -26,7 +26,7 @@ shortTitle: Configure version updates ## About version updates for dependencies -You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a *dependabot.yml* configuration file in to your repository's `.github` directory. {% data variables.product.prodname_dependabot %} then raises pull requests to keep the dependencies you configure up-to-date. For each package manager's dependencies that you want to update, you must specify the location of the package manifest files and how often to check for updates to the dependencies listed in those files. For information about enabling security updates, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)." +You enable {% data variables.product.prodname_dependabot_version_updates %} by checking a _dependabot.yml_ configuration file in to your repository's `.github` directory. {% data variables.product.prodname_dependabot %} then raises pull requests to keep the dependencies you configure up-to-date. For each package manager's dependencies that you want to update, you must specify the location of the package manifest files and how often to check for updates to the dependencies listed in those files. For information about enabling security updates, see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/configuring-dependabot-security-updates)." {% data reusables.dependabot.initial-updates %} For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates)." @@ -40,15 +40,15 @@ By default only direct dependencies that are explicitly defined in a manifest ar ## Enabling {% data variables.product.prodname_dependabot_version_updates %} -You enable {% data variables.product.prodname_dependabot_version_updates %} by committing a *dependabot.yml* configuration file to your repository. +You enable {% data variables.product.prodname_dependabot_version_updates %} by committing a _dependabot.yml_ configuration file to your repository. {% ifversion dependabot-settings-update-37 %}If you enable the feature in your settings page, GitHub creates a basic file which you can edit, otherwise you can create the file using any file editor. {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-code-security-and-analysis %} -1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot_version_updates %}", click **Enable** to open a basic *dependabot.yml* configuration file in the `.github` directory of your repository. +1. Under "Code security and analysis", to the right of "{% data variables.product.prodname_dependabot_version_updates %}", click **Enable** to open a basic _dependabot.yml_ configuration file in the `.github` directory of your repository. {% else %} -1. Create a *dependabot.yml* configuration file in the `.github` directory of your repository. +1. Create a _dependabot.yml_ configuration file in the `.github` directory of your repository. {% endif %} 1. Add a `version`. 1. Optionally, if you have dependencies in a private registry, add a `registries` section containing authentication details. @@ -61,9 +61,9 @@ You enable {% data variables.product.prodname_dependabot_version_updates %} by c For information about all the configuration options, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." -### Example *dependabot.yml* file +### Example _dependabot.yml_ file -The example *dependabot.yml* file below configures version updates for two package managers: npm and Docker. When this file is checked in, {% data variables.product.prodname_dependabot %} checks the manifest files on the default branch for outdated dependencies. If it finds outdated dependencies, it will raise pull requests against the default branch to update the dependencies. +The example _dependabot.yml_ file below configures version updates for two package managers: npm and Docker. When this file is checked in, {% data variables.product.prodname_dependabot %} checks the manifest files on the default branch for outdated dependencies. If it finds outdated dependencies, it will raise pull requests against the default branch to update the dependencies. ```yaml # Basic dependabot.yml file with @@ -92,7 +92,7 @@ In the example above, if the Docker dependencies were very outdated, you might w ### Enabling version updates on forks -If you want to enable version updates on forks, there's an extra step. Version updates are not automatically enabled on forks when a *dependabot.yml* configuration file is present. This ensures that fork owners don't unintentionally enable version updates when they pull changes including a *dependabot.yml* configuration file from the original repository. +If you want to enable version updates on forks, there's an extra step. Version updates are not automatically enabled on forks when a _dependabot.yml_ configuration file is present. This ensures that fork owners don't unintentionally enable version updates when they pull changes including a _dependabot.yml_ configuration file from the original repository. On a fork, you also need to explicitly enable {% data variables.product.prodname_dependabot %}. @@ -123,7 +123,7 @@ For information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-u ## Disabling {% data variables.product.prodname_dependabot_version_updates %} -You can disable version updates entirely by deleting the *dependabot.yml* file from your repository. More usually, you want to disable updates temporarily for one or more dependencies, or package managers. +You can disable version updates entirely by deleting the _dependabot.yml_ file from your repository. More usually, you want to disable updates temporarily for one or more dependencies, or package managers. - Package managers: disable by setting `open-pull-requests-limit: 0` or by commenting out the relevant `package-ecosystem` in the configuration file. - Specific dependencies: disable by adding `ignore` attributes for packages or applications that you want to exclude from updates. @@ -132,7 +132,7 @@ When you disable dependencies, you can use wild cards to match a set of related ### Example disabling version updates for some dependencies -The example *dependabot.yml* file below includes examples of the different ways to disable updates to some dependencies, while allowing other updates to continue. +The example _dependabot.yml_ file below includes examples of the different ways to disable updates to some dependencies, while allowing other updates to continue. ```yaml # dependabot.yml file with updates diff --git a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md index da7d0b7eb3..d312d039c1 100644 --- a/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/customizing-dependency-updates.md @@ -27,7 +27,7 @@ shortTitle: Customize updates ## About customizing dependency updates -After you've enabled version updates, you can customize how {% data variables.product.prodname_dependabot %} maintains your dependencies by adding further options to the *dependabot.yml* file. For example, you could: +After you've enabled version updates, you can customize how {% data variables.product.prodname_dependabot %} maintains your dependencies by adding further options to the _dependabot.yml_ file. For example, you could: - Specify which day of the week to open pull requests for version updates: `schedule.day` - Set reviewers, assignees, and labels for each package manager: `reviewers`, `assignees`, and `labels` @@ -37,11 +37,11 @@ After you've enabled version updates, you can customize how {% data variables.pr For more information about the configuration options, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file)." -When you update the *dependabot.yml* file in your repository, {% data variables.product.prodname_dependabot %} runs an immediate check with the new configuration. Within minutes you will see an updated list of dependencies on the **{% data variables.product.prodname_dependabot %}** tab, this may take longer if the repository has many dependencies. You may also see new pull requests for version updates. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates)." +When you update the _dependabot.yml_ file in your repository, {% data variables.product.prodname_dependabot %} runs an immediate check with the new configuration. Within minutes you will see an updated list of dependencies on the **{% data variables.product.prodname_dependabot %}** tab, this may take longer if the repository has many dependencies. You may also see new pull requests for version updates. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates)." ## Impact of configuration changes on security updates -If you customize the *dependabot.yml* file, you may notice some changes to the pull requests raised for security updates. These pull requests are always triggered by a security advisory for a dependency, rather than by the {% data variables.product.prodname_dependabot %} schedule. However, they inherit relevant configuration settings from the *dependabot.yml* file unless you specify a different target branch for version updates. +If you customize the _dependabot.yml_ file, you may notice some changes to the pull requests raised for security updates. These pull requests are always triggered by a security advisory for a dependency, rather than by the {% data variables.product.prodname_dependabot %} schedule. However, they inherit relevant configuration settings from the _dependabot.yml_ file unless you specify a different target branch for version updates. For an example, see "[Setting custom labels](#setting-custom-labels)" below. @@ -49,7 +49,7 @@ For an example, see "[Setting custom labels](#setting-custom-labels)" below. When you set a `daily` update schedule, by default, {% data variables.product.prodname_dependabot %} checks for new versions at 05:00 UTC. You can use `schedule.time` to specify an alternative time of day to check for updates (format: `hh:mm`). -The example *dependabot.yml* file below expands the npm configuration to specify when {% data variables.product.prodname_dependabot %} should check for version updates to dependencies. +The example _dependabot.yml_ file below expands the npm configuration to specify when {% data variables.product.prodname_dependabot %} should check for version updates to dependencies. ```yaml # dependabot.yml file with @@ -72,7 +72,7 @@ By default, {% data variables.product.prodname_dependabot %} raises pull request You can use `reviewers` and `assignees` to specify reviewers and assignees for all pull requests raised for a package manager. When you specify a team, you must use the full team name, as if you were @mentioning the team (including the organization). -The example *dependabot.yml* file below changes the npm configuration so that all pull requests opened with version and security updates for npm will have two reviewers and one assignee. +The example _dependabot.yml_ file below changes the npm configuration so that all pull requests opened with version and security updates for npm will have two reviewers and one assignee. ```yaml # dependabot.yml file with @@ -98,9 +98,9 @@ updates: {% data reusables.dependabot.default-labels %} -You can use `labels` to override the default labels and specify alternative labels for all pull requests raised for a package manager. You can't create new labels in the *dependabot.yml* file, so the alternative labels must already exist in the repository. +You can use `labels` to override the default labels and specify alternative labels for all pull requests raised for a package manager. You can't create new labels in the _dependabot.yml_ file, so the alternative labels must already exist in the repository. -The example *dependabot.yml* file below changes the npm configuration so that all pull requests opened with version and security updates for npm will have custom labels. It also changes the Docker configuration to check for version updates against a custom branch and to raise pull requests with custom labels against that custom branch. The changes to Docker will not affect security update pull requests because security updates are always made against the default branch. +The example _dependabot.yml_ file below changes the npm configuration so that all pull requests opened with version and security updates for npm will have custom labels. It also changes the Docker configuration to check for version updates against a custom branch and to raise pull requests with custom labels against that custom branch. The changes to Docker will not affect security update pull requests because security updates are always made against the default branch. {% note %} diff --git a/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md b/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md index 5f3b1b19b3..c0e6321ce7 100644 --- a/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md +++ b/content/code-security/dependabot/dependabot-version-updates/listing-dependencies-configured-for-version-updates.md @@ -37,5 +37,5 @@ If any dependencies are missing, check the log files for errors. If any package ## Viewing {% data variables.product.prodname_dependabot %} log files -1. On the **{% data variables.product.prodname_dependabot %}** tab, click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. +1. On the **{% data variables.product.prodname_dependabot %}** tab, click **Last checked _TIME_ ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. 2. Optionally, to rerun the version check, click **Check for updates**. diff --git a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md b/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md index 3dc1c3e920..61ce2e9308 100644 --- a/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md +++ b/content/code-security/dependabot/working-with-dependabot/keeping-your-actions-up-to-date-with-dependabot.md @@ -25,7 +25,7 @@ shortTitle: Auto-update actions ## About {% data variables.product.prodname_dependabot_version_updates %} for actions -Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's *workflow.yml* file{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows used inside workflows{% endif %} are kept up to date. +Actions are often updated with bug fixes and new features to make automated processes more reliable, faster, and safer. When you enable {% data variables.product.prodname_dependabot_version_updates %} for {% data variables.product.prodname_actions %}, {% data variables.product.prodname_dependabot %} will help ensure that references to actions in a repository's _workflow.yml_ file{% ifversion dependabot-updates-actions-reusable-workflows %} and reusable workflows used inside workflows{% endif %} are kept up to date. For each action in the file, {% data variables.product.prodname_dependabot %} checks the action's reference (typically a version number or commit identifier associated with the action) against the latest version. If a more recent version of the action is available, {% data variables.product.prodname_dependabot %} will send you a pull request that updates the reference in the workflow file to the latest version. For more information about {% data variables.product.prodname_dependabot_version_updates %}, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)." For more information about configuring workflows for {% data variables.product.prodname_actions %}, see "[AUTOTITLE](/actions/learn-github-actions)." @@ -40,7 +40,7 @@ For each action in the file, {% data variables.product.prodname_dependabot %} ch You can configure {% data variables.product.prodname_dependabot_version_updates %} to maintain your actions as well as the libraries and packages you depend on. -1. If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing *dependabot.yml* file. Otherwise, create a *dependabot.yml* configuration file in the `.github` directory of your repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." +1. If you have already enabled {% data variables.product.prodname_dependabot_version_updates %} for other ecosystems or package managers, simply open the existing _dependabot.yml_ file. Otherwise, create a _dependabot.yml_ configuration file in the `.github` directory of your repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." 1. Specify `"github-actions"` as a `package-ecosystem` to monitor. 1. Set the `directory` to `"/"` to check for workflow files in `.github/workflows`. 1. Set a `schedule.interval` to specify how often to check for new versions. @@ -48,9 +48,9 @@ You can configure {% data variables.product.prodname_dependabot_version_updates You can also enable {% data variables.product.prodname_dependabot_version_updates %} on forks. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-version-updates-on-forks)." -### Example *dependabot.yml* file for {% data variables.product.prodname_actions %} +### Example _dependabot.yml_ file for {% data variables.product.prodname_actions %} -The example *dependabot.yml* file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"weekly"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot %} will continue to check for outdated versions of actions once a week. +The example _dependabot.yml_ file below configures version updates for {% data variables.product.prodname_actions %}. The `directory` must be set to `"/"` to check for workflow files in `.github/workflows`. The `schedule.interval` is set to `"weekly"`. After this file has been checked in or updated, {% data variables.product.prodname_dependabot %} checks for new versions of your actions. {% data variables.product.prodname_dependabot %} will raise pull requests for version updates for any outdated actions that it finds. After the initial version updates, {% data variables.product.prodname_dependabot %} will continue to check for outdated versions of actions once a week. ```yaml # Set update schedule for GitHub Actions diff --git a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md index 1eeb98df92..f41ce013a5 100644 --- a/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md +++ b/content/code-security/dependabot/working-with-dependabot/troubleshooting-dependabot-errors.md @@ -110,7 +110,7 @@ There are two options: you can review the open pull request and merge it as soon ### {% data variables.product.prodname_dependabot %} timed out during its update -{% data variables.product.prodname_dependabot %} took longer than the maximum time allowed to assess the update required and prepare a pull request. This error is usually seen only for large repositories with many manifest files, for example, npm or yarn monorepo projects with hundreds of *package.json* files. Updates to the Composer ecosystem also take longer to assess and may time out. +{% data variables.product.prodname_dependabot %} took longer than the maximum time allowed to assess the update required and prepare a pull request. This error is usually seen only for large repositories with many manifest files, for example, npm or yarn monorepo projects with hundreds of _package.json_ files. Updates to the Composer ecosystem also take longer to assess and may time out. This error is difficult to address. If a version update times out, you could specify the most important dependencies to update using the `allow` parameter or, alternatively, use the `ignore` parameter to exclude some dependencies from updates. Updating your configuration might allow {% data variables.product.prodname_dependabot %} to review the version update and generate the pull request in the time available. @@ -148,7 +148,7 @@ To allow {% data variables.product.prodname_dependabot %} to update the dependen If you unblock {% data variables.product.prodname_dependabot %}, you can manually trigger a fresh attempt to create a pull request. - **Security updates**—display the {% data variables.product.prodname_dependabot %} alert that shows the error you have fixed and click **Create {% data variables.product.prodname_dependabot %} security update**. -- **Version updates**—on the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked *TIME* ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**. +- **Version updates**—on the **Insights** tab for the repository click **Dependency graph**, and then click the **Dependabot** tab. Click **Last checked _TIME_ ago** to see the log file that {% data variables.product.prodname_dependabot %} generated during the last check for version updates. Click **Check for updates**. ## Further reading diff --git a/content/code-security/getting-started/securing-your-organization.md b/content/code-security/getting-started/securing-your-organization.md index 74d200b9a1..eff027958d 100644 --- a/content/code-security/getting-started/securing-your-organization.md +++ b/content/code-security/getting-started/securing-your-organization.md @@ -80,7 +80,7 @@ For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-secu You can enable {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/about-dependabot-version-updates)." -To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a _dependabot.yml_ configuration file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." {% endif %} diff --git a/content/code-security/getting-started/securing-your-repository.md b/content/code-security/getting-started/securing-your-repository.md index a5d4f70cc3..219402b1ff 100644 --- a/content/code-security/getting-started/securing-your-repository.md +++ b/content/code-security/getting-started/securing-your-repository.md @@ -103,11 +103,11 @@ You can enable {% data variables.product.prodname_dependabot %} to automatically {% ifversion dependabot-settings-update-37 %} 1. From the main page of your repository, click **{% octicon "gear" aria-label="The Settings gear" %} Settings**. 1. Click **Security & analysis**. -1. Next to {% data variables.product.prodname_dependabot_version_updates %}, click **Enable** to create a basic *dependabot.yml* configuration file. +1. Next to {% data variables.product.prodname_dependabot_version_updates %}, click **Enable** to create a basic _dependabot.yml_ configuration file. 1. Specify the dependencies to update and commit the file to the repository. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates#enabling-dependabot-version-updates)." {% else %} -To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a *dependabot.yml* configuration file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." +To enable {% data variables.product.prodname_dependabot_version_updates %}, you must create a _dependabot.yml_ configuration file. For more information, see "[AUTOTITLE](/code-security/dependabot/dependabot-version-updates/configuring-dependabot-version-updates)." {% endif %} {% endif %} diff --git a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md index 9f669baf38..2a9288c205 100644 --- a/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md +++ b/content/code-security/secret-scanning/configuring-secret-scanning-for-your-repositories.md @@ -94,11 +94,11 @@ You can enable {% data variables.secret-scanning.user_alerts %} for all of your ## Excluding directories from {% data variables.secret-scanning.user_alerts %} -You can configure a *secret_scanning.yml* file to exclude directories from {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %}, including when you use push protection{% endif %}. For example, you can exclude directories that contain tests or randomly generated content. +You can configure a _secret_scanning.yml_ file to exclude directories from {% data variables.product.prodname_secret_scanning %}{% ifversion secret-scanning-push-protection %}, including when you use push protection{% endif %}. For example, you can exclude directories that contain tests or randomly generated content. {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type *.github/secret_scanning.yml*. +3. In the file name field, type _.github/secret_scanning.yml_. 4. Under **Edit new file**, type `paths-ignore:` followed by the paths you want to exclude from {% data variables.product.prodname_secret_scanning %}. ``` yaml paths-ignore: 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 a1e6079c63..d09d6b24c7 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 @@ -61,6 +61,6 @@ Once you have cloned the wiki, you can add new files, edit existing ones, and co The filename determines the title of your wiki page, and the file extension determines how your wiki content is rendered. -Wikis use [our open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file *foo.md* or *foo.markdown*, wiki will use the Markdown converter, while a file named *foo.textile* will use the Textile converter. +Wikis use [our open-source Markup library](https://github.com/github/markup) to convert the markup, and it determines which converter to use by a file's extension. For example, if you name a file _foo.md_ or _foo.markdown_, wiki will use the Markdown converter, while a file named _foo.textile_ will use the Textile converter. Don't use the following characters in your wiki page's titles: `\ / : * ? " < > |`. Users on certain operating systems won't be able to work with filenames containing these characters. Be sure to write your content using a markup language that matches the extension, or your content won't render properly. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md index 7ceb4f5270..51036de8a5 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project.md @@ -12,7 +12,7 @@ topics: shortTitle: Add a code of conduct --- -A *code of conduct* defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for how to engage in a community, see the [Open Source Guide](https://opensource.guide/code-of-conduct/). +A _code of conduct_ defines standards for how to engage in a community. It signals an inclusive environment that respects all contributions. It also outlines procedures for addressing problems between members of your project's community. For more information on why a code of conduct defines standards and expectations for how to engage in a community, see the [Open Source Guide](https://opensource.guide/code-of-conduct/). Before adopting a code of conduct for your project: @@ -29,7 +29,7 @@ You can create a default code of conduct for your organization or personal accou {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type *CODE_OF_CONDUCT.md*. +3. In the file name field, type _CODE_OF_CONDUCT.md_. 4. Select **Choose a code of conduct template**. ![Screenshot of a {% data variables.product.prodname_dotcom %} repository showing a new markdown file being created. A button at right, labeled "Choose a code of conduct template," is outlined in dark orange.](/assets/images/help/repository/code-of-conduct-tool.png) 5. On the left side of the page, select a code of conduct to preview and add to your project. @@ -47,9 +47,9 @@ If the code of conduct you want to use isn't available in the provided templates {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} 3. In the file name field, type the name and extension for the file. - - To make your code of conduct visible in the repository's root directory, type *CODE_OF_CONDUCT* in the file name field. - - To make your code of conduct visible in the repository's `docs` directory, type *docs/CODE_OF_CONDUCT*. - - To make your code of conduct visible in the repository's `.github` directory, type *.github/CODE_OF_CONDUCT*. + - To make your code of conduct visible in the repository's root directory, type _CODE_OF_CONDUCT_ in the file name field. + - To make your code of conduct visible in the repository's `docs` directory, type _docs/CODE_OF_CONDUCT_. + - To make your code of conduct visible in the repository's `.github` directory, type _.github/CODE_OF_CONDUCT_. 4. In the new file, add your custom code of conduct. {% data reusables.files.write_commit_message %} {% data reusables.files.choose_commit_branch %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md index d0ca22a0c8..0a8dd90ce6 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository.md @@ -24,7 +24,7 @@ Open source licenses enable others to freely use, change, and distribute the pro {% ifversion fpt or ghec %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -1. In the file name field, type *LICENSE* or *LICENSE.md* (with all caps). +1. In the file name field, type _LICENSE_ or _LICENSE.md_ (with all caps). 1. Under the file name, click **Choose a license template**. ![Screenshot of the new file form, with "LICENSE" entered in the file name field. A button, labeled "Choose a license template," is outlined in dark orange.](/assets/images/help/repository/license-tool.png) @@ -42,7 +42,7 @@ Open source licenses enable others to freely use, change, and distribute the pro {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type *LICENSE* or *LICENSE.md* (with all caps). +3. In the file name field, type _LICENSE_ or _LICENSE.md_ (with all caps). 4. On the **Edit new file** tab, paste the full text of the license you want to use. {% data reusables.files.write_commit_message %} {% data reusables.files.choose-commit-email %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md index c5821ddd71..fdd3577140 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project.md @@ -34,7 +34,7 @@ You can create default support resources for your organization or personal accou {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} -3. In the file name field, type *SUPPORT.md* (with all caps). +3. In the file name field, type _SUPPORT.md_ (with all caps). 4. On the **Edit new file** tab, add information about how people can get support for your project. 5. To review your SUPPORT file, click **Preview**. {% data reusables.files.write_commit_message %} diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md index 5c14e40f1d..28433a500e 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/creating-a-default-community-health-file.md @@ -23,7 +23,7 @@ You can add default community health files to a public repository called `.githu - the `.github` folder - the `docs` folder -For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% ifversion fpt or ghes or ghec %}, including issue templates or a *config.yml* file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. +For example, anyone who creates an issue or pull request in a repository that does not have its own CONTRIBUTING file will see a link to the default CONTRIBUTING file. If a repository has any files in its own `.github/ISSUE_TEMPLATE` folder{% ifversion fpt or ghes or ghec %}, including issue templates or a _config.yml_ file,{% endif %} none of the contents of the default `.github/ISSUE_TEMPLATE` folder will be used. Default files are not included in clones, packages, or downloads of individual repositories because they are stored only in the `.github` repository. @@ -33,14 +33,14 @@ You can create defaults in your organization{% ifversion fpt or ghes or ghec %} Community health file | Description --- | ---{% ifversion fpt or ghec %} -*CODE_OF_CONDUCT.md* | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)."{% endif %} -*CONTRIBUTING.md* | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."{% ifversion discussion-category-forms %} +_CODE_OF_CONDUCT.md_ | A CODE_OF_CONDUCT file defines standards for how to engage in a community. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-a-code-of-conduct-to-your-project)."{% endif %} +_CONTRIBUTING.md_ | A CONTRIBUTING file communicates how people should contribute to your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors)."{% ifversion discussion-category-forms %} Discussion category forms | Discussion category forms customize the templates that are available for community members to use when they open new discussions in your repository. For more information, see "[AUTOTITLE](/discussions/managing-discussions-for-your-community/creating-discussion-category-forms)."{% endif %}{% ifversion fpt or ghec %} -*FUNDING.yml* | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)."{% endif %} -*GOVERNANCE.md* | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. -Issue and pull request templates{% ifversion fpt or ghes or ghec %} and *config.yml*{% endif %} | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."{% ifversion fpt or ghes or ghec %} -*SECURITY.md* | A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)."{% endif %} -*SUPPORT.md* | A SUPPORT file lets people know about ways to get help with your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project)." +_FUNDING.yml_ | A FUNDING file displays a sponsor button in your repository to increase the visibility of funding options for your open source project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/displaying-a-sponsor-button-in-your-repository)."{% endif %} +_GOVERNANCE.md_ | A GOVERNANCE file lets people know about how your project is governed. For example, it might discuss project roles and how decisions are made. +Issue and pull request templates{% ifversion fpt or ghes or ghec %} and _config.yml_{% endif %} | Issue and pull request templates customize and standardize the information you'd like contributors to include when they open issues and pull requests in your repository. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)."{% ifversion fpt or ghes or ghec %} +_SECURITY.md_ | A SECURITY file gives instructions for how to report a security vulnerability in your project. For more information, see "[AUTOTITLE](/code-security/getting-started/adding-a-security-policy-to-your-repository)."{% endif %} +_SUPPORT.md_ | A SUPPORT file lets people know about ways to get help with your project. For more information, see "[AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/adding-support-resources-to-your-project)." You cannot create a default license file. License files must be added to individual repositories so the file will be included when a project is cloned, packaged, or downloaded. diff --git a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md index bd90e4521c..9e4c986368 100644 --- a/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md +++ b/content/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors.md @@ -35,14 +35,14 @@ You can create default contribution guidelines for your organization{% ifversion {% endtip %} -## Adding a *CONTRIBUTING* file +## 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 "[AUTOTITLE](/repositories/working-with-files/using-files/working-with-non-code-files#rendering-differences-in-prose-documents)." - - 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. + - 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. diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md index 3becacbc52..c0e0840b8e 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates.md @@ -38,7 +38,7 @@ With issue forms, you can create templates that have web form fields using the { {% data reusables.repositories.issue-template-config %} For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser)." -Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a *.md* extension.{% ifversion issue-forms %} Issue templates created with issue forms need a *.yml* extension.{% endif %} {% data reusables.repositories.valid-community-issues %} +Issue templates are stored on the repository's default branch, in a hidden `.github/ISSUE_TEMPLATE` directory. If you create a template in another branch, it will not be available for collaborators to use. Issue template filenames are not case sensitive, and need a _.md_ extension.{% ifversion issue-forms %} Issue templates created with issue forms need a _.yml_ extension.{% endif %} {% data reusables.repositories.valid-community-issues %} It is possible to manually create a single issue template in Markdown using the legacy issue template workflow, and project contributors will automatically see the template's contents in the issue body. However, we recommend using the upgraded multiple issue template builder{% ifversion issue-forms %} or issue forms{% endif %} to create issue templates. For more information about the legacy workflow, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository)." @@ -48,6 +48,6 @@ It is possible to manually create a single issue template in Markdown using the When you add a pull request template to your repository, project contributors will automatically see the template's contents in the pull request body. -You must create templates on the repository's default branch. Templates created in other branches are not available for collaborators to use. You can store your pull request template in the repository's visible root directory, the `docs` folder, or the hidden `.github` directory. Pull request template filenames are not case sensitive, and can have an extension such as *.md* or *.txt*. +You must create templates on the repository's default branch. Templates created in other branches are not available for collaborators to use. You can store your pull request template in the repository's visible root directory, the `docs` folder, or the hidden `.github` directory. Pull request template filenames are not case sensitive, and can have an extension such as _.md_ or _.txt_. For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository)." diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md index a4e2fa6e57..c9f08dcdd0 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository.md @@ -72,13 +72,13 @@ You can encourage contributors to use issue templates by setting `blank_issues_e {% note %} -**Note:** If you used the legacy workflow to manually create an `issue_template.md` file in the `.github` folder and enable blank issues in your *config.yml* file, the template in `issue_template.md` will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used. +**Note:** If you used the legacy workflow to manually create an `issue_template.md` file in the `.github` folder and enable blank issues in your _config.yml_ file, the template in `issue_template.md` will be used when people chose to open a blank issue. If you disable blank issues, the template will never be used. {% endnote %} If you prefer to receive certain reports outside of {% data variables.product.product_name %}, you can direct people to external sites with `contact_links`. -Here is an example *config.yml* file. +Here is an example _config.yml_ file. ```yaml copy blank_issues_enabled: false diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md index 622dbba00c..28b58ef1d1 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/creating-a-pull-request-template-for-your-repository.md @@ -16,7 +16,7 @@ shortTitle: Create a PR template For more information, see "[AUTOTITLE](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/about-issue-and-pull-request-templates)." -You can create a *PULL_REQUEST_TEMPLATE/* subdirectory in any of the supported folders to contain multiple pull request templates, and use the `template` query parameter to specify the template that will fill the pull request body. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)." +You can create a _PULL_REQUEST_TEMPLATE/_ subdirectory in any of the supported folders to contain multiple pull request templates, and use the `template` query parameter to specify the template that will fill the pull request body. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)." {% ifversion fpt or ghes or ghec %} @@ -32,7 +32,7 @@ You can create default pull request templates for your organization{% ifversion - To make your pull request template visible in the repository's root directory, name the pull request template `pull_request_template.md`. - To make your pull request template visible in the repository's `docs` directory, name the pull request template `docs/pull_request_template.md`. - To store your file in a hidden directory, name the pull request template `.github/pull_request_template.md`. - - To create multiple pull request templates and use the `template` query parameter to specify a template to fill the pull request body, type *.github/PULL_REQUEST_TEMPLATE/*, then the name of your pull request template. For example, `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md`. You can also store multiple pull request templates in a `PULL_REQUEST_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)." + - To create multiple pull request templates and use the `template` query parameter to specify a template to fill the pull request body, type _.github/PULL_REQUEST_TEMPLATE/_, then the name of your pull request template. For example, `.github/PULL_REQUEST_TEMPLATE/pull_request_template.md`. You can also store multiple pull request templates in a `PULL_REQUEST_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/using-query-parameters-to-create-a-pull-request)." 1. In the body of the new file, add your pull request template. This could include: - A [reference to a related issue](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests) in your repository. - A description of the changes proposed in the pull request. diff --git a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md index c0da21c930..b9b0175882 100644 --- a/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md +++ b/content/communities/using-templates-to-encourage-useful-issues-and-pull-requests/manually-creating-a-single-issue-template-for-your-repository.md @@ -17,7 +17,7 @@ shortTitle: Create an issue template {% data reusables.repositories.legacy-issue-template-tip %} -You can create an *ISSUE_TEMPLATE/* subdirectory in any of the supported folders to contain multiple issue templates, and use the `template` query parameter to specify the template that will fill the issue body. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." +You can create an _ISSUE_TEMPLATE/_ subdirectory in any of the supported folders to contain multiple issue templates, and use the `template` query parameter to specify the template that will fill the issue body. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." You can add YAML frontmatter to each issue template to pre-fill the issue title, automatically add labels and assignees, and give the template a name and description that will be shown in the template chooser that people see when creating a new issue in your repository. @@ -55,10 +55,10 @@ assignees: octocat {% data reusables.repositories.navigate-to-repo %} {% data reusables.files.add-file %} 3. In the file name field: - - To make your issue template visible in the repository's root directory, type the name of your *issue_template*. For example, `issue_template.md`. - - To make your issue template visible in the repository's `docs` directory, type *docs/* followed by the name of your *issue_template*. For example, `docs/issue_template.md`, - - To store your file in a hidden directory, type *.github/* followed by the name of your *issue_template*. For example, `.github/issue_template.md`. - - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type *.github/ISSUE_TEMPLATE/*, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." + - To make your issue template visible in the repository's root directory, type the name of your _issue_template_. For example, `issue_template.md`. + - To make your issue template visible in the repository's `docs` directory, type _docs/_ followed by the name of your _issue_template_. For example, `docs/issue_template.md`, + - To store your file in a hidden directory, type _.github/_ followed by the name of your _issue_template_. For example, `.github/issue_template.md`. + - To create multiple issue templates and use the `template` query parameter to specify a template to fill the issue body, type _.github/ISSUE_TEMPLATE/_, then the name of your issue template. For example, `.github/ISSUE_TEMPLATE/issue_template.md`. You can also store multiple issue templates in an `ISSUE_TEMPLATE` subdirectory within the root or `docs/` directories. For more information, see "[AUTOTITLE](/issues/tracking-your-work-with-issues/creating-an-issue)." 4. In the body of the new file, add your issue template. This could include: - YAML frontmatter - Expected behavior and actual behavior diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md index 9d813e319e..876cf1819a 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/viewing-and-re-running-checks-in-github-desktop.md @@ -7,7 +7,7 @@ versions: --- ## About checks in {% data variables.product.prodname_desktop %} -{% data variables.product.prodname_desktop %} displays the status of checks that have run in your pull request branches. The checks badge next to the branch name will display the *pending, passing,* or *failing* state of the checks. You can also re-run all, failed, or individual checks when viewing the status of the checks in {% data variables.product.prodname_desktop %}. For more information on setting up checks in your repository, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." +{% data variables.product.prodname_desktop %} displays the status of checks that have run in your pull request branches. The checks badge next to the branch name will display the _pending, passing,_ or _failing_ state of the checks. You can also re-run all, failed, or individual checks when viewing the status of the checks in {% data variables.product.prodname_desktop %}. For more information on setting up checks in your repository, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." {% data variables.product.prodname_desktop %} will also show a system notification when checks fail. For more information on enabling notifications, see "[AUTOTITLE](/desktop/contributing-and-collaborating-using-github-desktop/working-with-your-remote-repository-on-github-or-github-enterprise/configuring-notifications-in-github-desktop)." 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 fe99c89a53..8406ba51a2 100644 --- a/content/get-started/getting-started-with-git/ignoring-files.md +++ b/content/get-started/getting-started-with-git/ignoring-files.md @@ -16,21 +16,21 @@ versions: --- ## Configuring ignored files for a single repository -You can create a *.gitignore* file in your repository's root directory to tell Git which files and directories to ignore when you make a commit. -To share the ignore rules with other users who clone the repository, commit the *.gitignore* file in to your repository. +You can create a _.gitignore_ file in your repository's root directory to tell Git which files and directories to ignore when you make a commit. +To share the ignore rules with other users who clone the repository, commit the _.gitignore_ file in to your repository. -GitHub maintains an official list of recommended *.gitignore* files for many popular operating systems, environments, and languages in the `github/gitignore` public repository. You can also use gitignore.io to create a *.gitignore* file for your operating system, programming language, or IDE. For more information, see "[github/gitignore](https://github.com/github/gitignore)" and the "[gitignore.io](https://www.gitignore.io/)" site. +GitHub maintains an official list of recommended _.gitignore_ files for many popular operating systems, environments, and languages in the `github/gitignore` public repository. You can also use gitignore.io to create a _.gitignore_ file for your operating system, programming language, or IDE. For more information, see "[github/gitignore](https://github.com/github/gitignore)" and the "[gitignore.io](https://www.gitignore.io/)" site. {% data reusables.command_line.open_the_multi_os_terminal %} 2. Navigate to the location of your Git repository. -3. Create a *.gitignore* file for your repository. +3. Create a _.gitignore_ file for your repository. ```shell $ touch .gitignore ``` If the command succeeds, there will be no output. -For an example *.gitignore* file, see "[Some common .gitignore configurations](https://gist.github.com/octocat/9257657)" in the Octocat repository. +For an example _.gitignore_ file, see "[Some common .gitignore configurations](https://gist.github.com/octocat/9257657)" in the Octocat repository. 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. @@ -40,27 +40,27 @@ $ git rm --cached FILENAME ## Configuring ignored files for all repositories on your computer -You can also create a global *.gitignore* file to define a list of rules for ignoring files in every Git repository on your computer. For example, you might create the file at *~/.gitignore_global* and add some rules to it. +You can also create a global _.gitignore_ file to define a list of rules for ignoring files in every Git repository on your computer. For example, you might create the file at _~/.gitignore_global_ and add some rules to it. {% data reusables.command_line.open_the_multi_os_terminal %} -2. Configure Git to use the exclude file *~/.gitignore_global* for all Git repositories. +2. Configure Git to use the exclude file _~/.gitignore_global_ for all Git repositories. ```shell $ git config --global core.excludesfile ~/.gitignore_global ``` -## Excluding local files without creating a *.gitignore* file +## Excluding local files without creating a _.gitignore_ file -If you don't want to create a *.gitignore* file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor. +If you don't want to create a _.gitignore_ file to share with others, you can create rules that are not committed with the repository. You can use this technique for locally-generated files that you don't expect other users to generate, such as files created by your editor. -Use your favorite text editor to open the file called *.git/info/exclude* within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository. +Use your favorite text editor to open the file called _.git/info/exclude_ within the root of your Git repository. Any rule you add here will not be checked in, and will only ignore files for your local repository. {% data reusables.command_line.open_the_multi_os_terminal %} 2. Navigate to the location of your Git repository. -3. Using your favorite text editor, open the file *.git/info/exclude*. +3. Using your favorite text editor, open the file _.git/info/exclude_. ## Further Reading - [Ignoring files](https://git-scm.com/book/en/v2/Git-Basics-Recording-Changes-to-the-Repository#_ignoring) in the Git documentation - [.gitignore](https://git-scm.com/docs/gitignore) in the Git documentation -- [A collection of useful *.gitignore* templates](https://github.com/github/gitignore) in the github/gitignore repository +- [A collection of useful _.gitignore_ templates](https://github.com/github/gitignore) in the github/gitignore repository - [gitignore.io](https://www.gitignore.io/) site 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 7f155ca0b5..57d71b660e 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 @@ -18,7 +18,7 @@ You can change the name that is associated with your Git commits using the `git Changing the name associated with your Git commits using `git config` will only affect future commits and will not change the name used for past commits. -## Setting your Git username for *every* repository on your computer +## Setting your Git username for _every_ repository on your computer {% data reusables.command_line.open_the_multi_os_terminal %} diff --git a/content/get-started/learning-about-github/access-permissions-on-github.md b/content/get-started/learning-about-github/access-permissions-on-github.md index 311f87c849..0d06d8d132 100644 --- a/content/get-started/learning-about-github/access-permissions-on-github.md +++ b/content/get-started/learning-about-github/access-permissions-on-github.md @@ -27,11 +27,11 @@ Roles work differently for different types of accounts. For more information abo ## Personal accounts -A repository owned by a personal account has two permission levels: the *repository owner* and *collaborators*. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)." +A repository owned by a personal account has two permission levels: the _repository owner_ and _collaborators_. For more information, see "[AUTOTITLE](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/permission-levels-for-a-personal-account-repository)." ## Organization accounts -Organization members can have *owner*{% ifversion fpt or ghec %}, *billing manager*,{% endif %} or *member* roles. Owners have complete administrative access to your organization{% ifversion fpt or ghec %}, while billing managers can manage billing settings{% endif %}. Member is the default role for everyone else. You can manage access permissions for multiple members at a time with teams. For more information, see: +Organization members can have _owner_{% ifversion fpt or ghec %}, _billing manager_,{% endif %} or _member_ roles. Owners have complete administrative access to your organization{% ifversion fpt or ghec %}, while billing managers can manage billing settings{% endif %}. Member is the default role for everyone else. You can manage access permissions for multiple members at a time with teams. For more information, see: - "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization)" - "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)" - "[AUTOTITLE](/organizations/managing-user-access-to-your-organizations-repositories/repository-roles-for-an-organization)" @@ -44,7 +44,7 @@ Organization members can have *owner*{% ifversion fpt or ghec %}, *billing manag For more information about permissions for enterprise accounts, see [the {% data variables.product.prodname_ghe_cloud %} documentation](/enterprise-cloud@latest/get-started/learning-about-github/access-permissions-on-github). {% else %} -*Enterprise owners* have ultimate power over the enterprise account and can take every action in the enterprise account.{% ifversion ghec or ghes %} *Billing managers* can manage your enterprise account's billing settings.{% endif %} Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." +_Enterprise owners_ have ultimate power over the enterprise account and can take every action in the enterprise account.{% ifversion ghec or ghes %} _Billing managers_ can manage your enterprise account's billing settings.{% endif %} Members and outside collaborators of organizations owned by your enterprise account are automatically members of the enterprise account, although they have no access to the enterprise account itself or its settings. For more information, see "[AUTOTITLE](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)." {% ifversion ghec %} If an enterprise uses {% data variables.product.prodname_emus %}, members are provisioned as new personal accounts on {% data variables.product.prodname_dotcom %} and are fully managed by the identity provider. The {% data variables.enterprise.prodname_managed_users %} have read-only access to repositories that are not a part of their enterprise and cannot interact with users that are not also members of the enterprise. Within the organizations owned by the enterprise, the {% data variables.enterprise.prodname_managed_users %} can be granted the same granular access levels available for regular organizations. For more information, see "[AUTOTITLE](/admin/identity-and-access-management/using-enterprise-managed-users-for-iam/about-enterprise-managed-users)." diff --git a/content/get-started/onboarding/getting-started-with-github-team.md b/content/get-started/onboarding/getting-started-with-github-team.md index 918b5fbeee..8b7672bdfe 100644 --- a/content/get-started/onboarding/getting-started-with-github-team.md +++ b/content/get-started/onboarding/getting-started-with-github-team.md @@ -23,7 +23,7 @@ You must manage billing settings, payment method, and paid features and products Your organization's billing settings page allows you to manage settings like your payment method, billing cycle and billing email, or view information such as your subscription, billing date and payment history. You can also view and upgrade your storage and GitHub Actions minutes. For more information on managing your billing settings, see "[AUTOTITLE](/billing/managing-your-github-billing-settings)." -Only organization members with the *owner* or *billing manager* role can access or change billing settings for your organization. A billing manager is someone who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." +Only organization members with the _owner_ or _billing manager_ role can access or change billing settings for your organization. A billing manager is someone who manages the billing settings for your organization and does not use a paid license in your organization's subscription. For more information on adding a billing manager to your organization, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization)." ## Part 2: Adding members and setting up teams diff --git a/content/get-started/quickstart/create-a-repo.md b/content/get-started/quickstart/create-a-repo.md index ca98ffe761..e1c1dc4c87 100644 --- a/content/get-started/quickstart/create-a-repo.md +++ b/content/get-started/quickstart/create-a-repo.md @@ -53,7 +53,7 @@ You can store a variety of projects in {% data variables.product.product_name %} {% data reusables.repositories.initialize-with-readme %} {% data reusables.repositories.create-repo %} -Congratulations! You've successfully created your first repository, and initialized it with a *README* file. +Congratulations! You've successfully created your first repository, and initialized it with a _README_ file. {% endwebui %} @@ -74,7 +74,7 @@ Congratulations! You've successfully created your first repository, and initiali A [commit](/get-started/quickstart/github-glossary#commit) is like a snapshot of all the files in your project at a particular point in time. -When you created your new repository, you initialized it with a *README* file. *README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. +When you created your new repository, you initialized it with a _README_ file. _README_ files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your _README_ file are automatically shown on the front page of your repository. Let's commit a change to the README file. @@ -97,10 +97,10 @@ Let's commit a change to the README file. Now that you have created a project, you can start committing changes. -*README* files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your *README* file are automatically shown on the front page of your repository. Follow these steps to add a *README* file. +_README_ files are a great place to describe your project in more detail, or add some documentation such as how to install or use your project. The contents of your _README_ file are automatically shown on the front page of your repository. Follow these steps to add a _README_ file. 1. In the command line, navigate to the root directory of your new project. (This directory was created when you ran the `gh repo create` command.) -1. Create a *README* file with some information about the project. +1. Create a _README_ file with some information about the project. ```shell echo "info about this project" >> README.md @@ -134,7 +134,7 @@ Now that you have created a project, you can start committing changes. ## Next steps -You have now created a repository, including a *README* file, and created your first commit on {% data variables.location.product_location %}. +You have now created a repository, including a _README_ file, and created your first commit on {% data variables.location.product_location %}. {% webui %} diff --git a/content/get-started/quickstart/fork-a-repo.md b/content/get-started/quickstart/fork-a-repo.md index e0ba120f1f..ae4397c7c2 100644 --- a/content/get-started/quickstart/fork-a-repo.md +++ b/content/get-started/quickstart/fork-a-repo.md @@ -213,7 +213,7 @@ gh repo fork REPOSITORY --remote-name "main-remote-repo" You can make any changes to a fork, including: -- **Creating branches:** [*Branches*](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk. +- **Creating branches:** [_Branches_](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-and-deleting-branches-within-your-repository) allow you to build new features or test out ideas without putting your main project at risk. - **Opening pull requests:** If you want to contribute back to the upstream repository, you can send a request to the original author to pull your fork into their repository by submitting a [pull request](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). ## Find another repository to fork diff --git a/content/get-started/using-git/about-git-rebase.md b/content/get-started/using-git/about-git-rebase.md index 66b13b052f..0507761ec1 100644 --- a/content/get-started/using-git/about-git-rebase.md +++ b/content/get-started/using-git/about-git-rebase.md @@ -98,7 +98,7 @@ Breaking this information, from top to bottom, we see that: - Seven commits are listed, which indicates that there were seven changes between our starting point and our current branch state. - The commits you chose to rebase are sorted in the order of the oldest changes (at the top) to the newest changes (at the bottom). -- Each line lists a command (by default, `pick`), the commit SHA, and the commit message. The entire `git rebase` procedure centers around your manipulation of these three columns. The changes you make are *rebased* onto your repository. +- Each line lists a command (by default, `pick`), the commit SHA, and the commit message. The entire `git rebase` procedure centers around your manipulation of these three columns. The changes you make are _rebased_ onto your repository. - After the commits, Git tells you the range of commits we're working with (`41a72e6..7b36971`). - Finally, Git gives some help by telling you the commands that are available to you when rebasing commits. 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 cec115534c..17e8ff7d15 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 @@ -44,7 +44,7 @@ such remote-tracking branch names to `origin/foo`. ## Fetching changes from a remote repository -Use `git fetch` to retrieve new work done by other people. Fetching from a repository grabs all the new remote-tracking branches and tags *without* merging those changes into your own branches. +Use `git fetch` to retrieve new work done by other people. Fetching from a repository grabs all the new remote-tracking branches and tags _without_ merging those changes into your own branches. 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: 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 31140d7b80..968a8ad546 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 @@ -92,7 +92,7 @@ your local Git clone: git remote add upstream THEIR_REMOTE_URL ``` -Now, you can fetch updates and branches from *their* fork: +Now, you can fetch updates and branches from _their_ fork: ```shell git fetch upstream diff --git a/content/get-started/using-git/using-git-rebase-on-the-command-line.md b/content/get-started/using-git/using-git-rebase-on-the-command-line.md index 51d4578049..99868e3e11 100644 --- a/content/get-started/using-git/using-git-rebase-on-the-command-line.md +++ b/content/get-started/using-git/using-git-rebase-on-the-command-line.md @@ -92,7 +92,7 @@ edit dd1475d something I want to split reword 4ca2acc i cant' typ goods ``` -Git processes the two `pick` commands (for `pick 7b36971` and `pick 6b2481b`). It *also* processes the `fixup` command (`fixup c619268`), since it doesn't require any interaction. `fixup` merges the changes from `c619268` into the commit before it, `6b2481b`. Both changes will have the same commit message: `"Patch B"`. +Git processes the two `pick` commands (for `pick 7b36971` and `pick 6b2481b`). It _also_ processes the `fixup` command (`fixup c619268`), since it doesn't require any interaction. `fixup` merges the changes from `c619268` into the commit before it, `6b2481b`. Both changes will have the same commit message: `"Patch B"`. Git gets to the `edit dd1475d` operation, stops, and prints the following message to the terminal: diff --git a/content/get-started/working-with-subversion-on-github/subversion-properties-supported-by-github.md b/content/get-started/working-with-subversion-on-github/subversion-properties-supported-by-github.md index 52fc88aa92..af0b19cc6a 100644 --- a/content/get-started/working-with-subversion-on-github/subversion-properties-supported-by-github.md +++ b/content/get-started/working-with-subversion-on-github/subversion-properties-supported-by-github.md @@ -24,7 +24,7 @@ We convert `svn:executable` properties by updating the file mode directly before ## Ignoring unversioned items (`svn:ignore`) -If you've set files and directories to be ignored in Subversion, {% data variables.product.product_name %} will track them internally. Files ignored by subversion clients are completely distinct from entries in a *.gitignore* file. +If you've set files and directories to be ignored in Subversion, {% data variables.product.product_name %} will track them internally. Files ignored by subversion clients are completely distinct from entries in a _.gitignore_ file. ## Currently unsupported properties diff --git a/content/get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md b/content/get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md index 42812f970d..32b9dc2d26 100644 --- a/content/get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md +++ b/content/get-started/working-with-subversion-on-github/what-are-the-differences-between-subversion-and-git.md @@ -15,7 +15,7 @@ shortTitle: Subversion & Git differences --- ## Directory structure -Each *reference*, or labeled snapshot of a commit, in a project is organized within specific subdirectories, such as `trunk`, `branches`, and `tags`. For example, an SVN project with two features under development might look like this: +Each _reference_, or labeled snapshot of a commit, in a project is organized within specific subdirectories, such as `trunk`, `branches`, and `tags`. For example, an SVN project with two features under development might look like this: sample_project/trunk/README.md sample_project/trunk/lib/widget.rb @@ -30,7 +30,7 @@ An SVN workflow looks like this: - Active feature work is developed within subdirectories under `branches`. - When a feature is finished, the feature directory is merged into `trunk` and removed. -Git projects are also stored within a single directory. However, Git obscures the details of its references by storing them in a special *.git* directory. For example, a Git project with two features under development might look like this: +Git projects are also stored within a single directory. However, Git obscures the details of its references by storing them in a special _.git_ directory. For example, a Git project with two features under development might look like this: sample_project/.git sample_project/README.md @@ -38,7 +38,7 @@ Git projects are also stored within a single directory. However, Git obscures th A Git workflow looks like this: -- A Git repository stores the full history of all of its branches and tags within the *.git* directory. +- A Git repository stores the full history of all of its branches and tags within the _.git_ directory. - The latest stable release is contained within the default branch. - Active feature work is developed in separate branches. - When a feature is finished, the feature branch is merged into the default branch and deleted. @@ -47,9 +47,9 @@ Unlike SVN, with Git the directory structure remains the same, but the contents ## Including subprojects -A *subproject* is a project that's developed and managed somewhere outside of your main project. You typically import a subproject to add some functionality to your project without needing to maintain the code yourself. Whenever the subproject is updated, you can synchronize it with your project to ensure that everything is up-to-date. +A _subproject_ is a project that's developed and managed somewhere outside of your main project. You typically import a subproject to add some functionality to your project without needing to maintain the code yourself. Whenever the subproject is updated, you can synchronize it with your project to ensure that everything is up-to-date. -In SVN, a subproject is called an *SVN external*. In Git, it's called a *Git submodule*. Although conceptually similar, Git submodules are not kept up-to-date automatically; you must explicitly ask for a new version to be brought into your project. +In SVN, a subproject is called an _SVN external_. In Git, it's called a _Git submodule_. Although conceptually similar, Git submodules are not kept up-to-date automatically; you must explicitly ask for a new version to be brought into your project. For more information, see "[Git Tools Submodules](https://git-scm.com/book/en/Git-Tools-Submodules)" in the Git documentation. diff --git a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md index 6abb947fc8..6ad1069b1f 100644 --- a/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md +++ b/content/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md @@ -35,7 +35,7 @@ You can indicate emphasis with bold, italic, strikethrough, subscript, or supers | Style | Syntax | Keyboard shortcut | Example | Output | | --- | --- | --- | --- | --- | | Bold | `** **` or `__ __`| Command+B (Mac) or Ctrl+B (Windows/Linux) | `**This is bold text**` | **This is bold text** | -| Italic | `* *` or `_ _`     | Command+I (Mac) or Ctrl+I (Windows/Linux) | `*This text is italicized*` | *This text is italicized* | +| Italic | `* *` or `_ _`     | Command+I (Mac) or Ctrl+I (Windows/Linux) | `_This text is italicized_` | *This text is italicized* | | Strikethrough | `~~ ~~` | None | `~~This was mistaken text~~` | ~~This was mistaken text~~ | | Bold and nested italic | `** **` and `_ _` | None | `**This text is _extremely_ important**` | **This text is _extremely_ important** | | All bold and italic | `*** ***` | None | `***All this text is important***` | ***All this text is important*** | diff --git a/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md b/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md index 4204242a98..54c818bca4 100644 --- a/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md +++ b/content/get-started/writing-on-github/working-with-advanced-formatting/attaching-files.md @@ -62,18 +62,18 @@ The maximum file size is: We support these files: -- PNG (*.png*) -- GIF (*.gif*) -- JPEG (*.jpg*, *.jpeg*) +- PNG (_.png_) +- GIF (_.gif_) +- JPEG (_.jpg_, _.jpeg_) {%- ifversion svg-support %} -- SVG (*.svg*) +- SVG (_.svg_) {%- endif %} -- Log files (*.log*) -- Microsoft Word (*.docx*), Powerpoint (*.pptx*), and Excel (*.xlsx*) documents -- Text files (*.txt*) -- PDFs (*.pdf*) -- ZIP (*.zip*, *.gz*, *.tgz*){% ifversion fpt or ghec or ghes %} -- Video (*.mp4*, *.mov*, *.webm*){% endif %} +- Log files (_.log_) +- Microsoft Word (_.docx_), Powerpoint (_.pptx_), and Excel (_.xlsx_) documents +- Text files (_.txt_) +- PDFs (_.pdf_) +- ZIP (_.zip_, _.gz_, _.tgz_){% ifversion fpt or ghec or ghes %} +- Video (_.mp4_, _.mov_, _.webm_){% endif %} {% ifversion fpt or ghec or ghes %}{% note %} diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md index 3432c8ae3b..65b23155b4 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board.md @@ -16,7 +16,7 @@ allowTitleToDifferFromFilename: true When you close a {% data variables.projects.projects_v1_board %}, any configured workflow automation will pause by default. -If you reopen a {% data variables.projects.projects_v1_board %}, you have the option to *sync* automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board)" or "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." +If you reopen a {% data variables.projects.projects_v1_board %}, you have the option to _sync_ automation, which updates the position of the cards on the board according to the automation settings configured for the board. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board)" or "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/about-automation-for-project-boards)." 1. Navigate to the list of {% data variables.projects.projects_v1_boards %} in your repository or organization, or owned by your personal account. 2. In the projects list, next to the {% data variables.projects.projects_v1_board %} you want to close, click {% octicon "kebab-horizontal" aria-label="Project menu" %}. diff --git a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md index 6f45e8e268..917442c596 100644 --- a/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md +++ b/content/issues/organizing-your-work-with-project-boards/managing-project-boards/reopening-a-closed-project-board.md @@ -16,7 +16,7 @@ allowTitleToDifferFromFilename: true When you close a {% data variables.projects.projects_v1_board %}, any workflow automation that was configured for the {% data variables.projects.projects_v1_board %} will pause by default. For more information, see "[AUTOTITLE](/issues/organizing-your-work-with-project-boards/managing-project-boards/closing-a-project-board)." -When you reopen a {% data variables.projects.projects_v1_board %}, you have the option to *sync* automation, which updates the position of the cards on the board according to the automation settings configured for the board. +When you reopen a {% data variables.projects.projects_v1_board %}, you have the option to _sync_ automation, which updates the position of the cards on the board according to the automation settings configured for the board. 1. Navigate to the {% data variables.projects.projects_v1_board %} you want to reopen. {% data reusables.project-management.click-menu %} diff --git a/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md b/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md index 96904a47f0..4c771baa1d 100644 --- a/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md +++ b/content/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue.md @@ -20,7 +20,7 @@ shortTitle: Link PR to issue --- {% note %} -**Note:** The special keywords in a pull request description are interpreted when the pull request targets the repository's *default* branch. However, if the PR's base is *any other branch*, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** +**Note:** The special keywords in a pull request description are interpreted when the pull request targets the repository's _default_ branch. However, if the PR's base is _any other branch_, then these keywords are ignored, no links are created and merging the PR has no effect on the issues. **If you want to link a pull request to an issue using a keyword, the PR must be on the default branch.** {% endnote %} @@ -52,8 +52,8 @@ The syntax for closing keywords depends on whether the issue is in the same repo Linked issue | Syntax | Example --------------- | ------ | ------ -Issue in the same repository | *KEYWORD* #*ISSUE-NUMBER* | `Closes #10` -Issue in a different repository | *KEYWORD* *OWNER*/*REPOSITORY*#*ISSUE-NUMBER* | `Fixes octo-org/octo-repo#100` +Issue in the same repository | KEYWORD #ISSUE-NUMBER | `Closes #10` +Issue in a different repository | KEYWORD OWNER/REPOSITORY#ISSUE-NUMBER | `Fixes octo-org/octo-repo#100` Multiple issues | Use full syntax for each issue | `Resolves #10, resolves #123, resolves octo-org/octo-repo#100` Only manually linked pull requests can be manually unlinked. To unlink an issue that you linked using a keyword, you must edit the pull request description to remove the keyword. diff --git a/content/migrations/using-ghe-migrator/about-ghe-migrator.md b/content/migrations/using-ghe-migrator/about-ghe-migrator.md index f6a43ecf17..ae7f7df48e 100644 --- a/content/migrations/using-ghe-migrator/about-ghe-migrator.md +++ b/content/migrations/using-ghe-migrator/about-ghe-migrator.md @@ -22,7 +22,7 @@ There are three types of migrations you can perform: - A migration from a {% data variables.product.prodname_ghe_server %} instance to another existing {% data variables.product.prodname_ghe_server %} instance. You can migrate any number of repositories owned by any user or organization on the instance. Before performing a migration, you must have site administrator access to both instances. - A migration from a {% data variables.product.prodname_dotcom_the_website %} organization to a {% data variables.product.prodname_ghe_server %} instance. You can migrate any number of repositories owned by the organization. Before performing a migration, you must have [administrative access](/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization) to the {% data variables.product.prodname_dotcom_the_website %} organization as well as site administrator access to the target instance. -- *Trial runs* are migrations that import data to a [staging instance]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). These can be useful to see what *would* happen if a migration were applied to {% data variables.location.product_location %}. **We strongly recommend that you perform a trial run on a staging instance before importing data to your production instance.** +- _Trial runs_ are migrations that import data to a [staging instance]({% ifversion not ghes %}/enterprise-server@latest{% endif %}/admin/installation/setting-up-a-github-enterprise-server-instance/setting-up-a-staging-instance). These can be useful to see what _would_ happen if a migration were applied to {% data variables.location.product_location %}. **We strongly recommend that you perform a trial run on a staging instance before importing data to your production instance.** {% note %} @@ -32,7 +32,7 @@ There are three types of migrations you can perform: ## Migrated data -With ghe-migrator, everything revolves around a repository. Most data associated with a repository can be migrated. For example, a repository within an organization will migrate the repository *and* the organization, as well as any users, teams, issues, and pull requests associated with the repository. +With ghe-migrator, everything revolves around a repository. Most data associated with a repository can be migrated. For example, a repository within an organization will migrate the repository _and_ the organization, as well as any users, teams, issues, and pull requests associated with the repository. The items in the table below can be migrated with a repository. Any items not shown in the list of migrated data can not be migrated, including {% data variables.large_files.product_name_short %} assets. diff --git a/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md b/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md index 5521e6c852..cfe0750cfe 100644 --- a/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md +++ b/content/migrations/using-ghe-migrator/preparing-to-migrate-data-to-github-enterprise-server.md @@ -42,12 +42,12 @@ shortTitle: Prepare to migrate data ## Generating a list of migration conflicts -1. Using the `ghe-migrator conflicts` command with the Migration GUID, generate a *conflicts.csv* file: +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 ``` - If no conflicts are reported, you can safely import the data by following the steps in "[AUTOTITLE](/migrations/using-ghe-migrator/migrating-data-to-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: +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 ``` @@ -55,10 +55,10 @@ shortTitle: Prepare to migrate data ## Reviewing migration conflicts -1. Using a text editor or [CSV-compatible spreadsheet software](https://en.wikipedia.org/wiki/Comma-separated_values#Application_support), open *conflicts.csv*. -2. With guidance from the examples and reference tables below, review the *conflicts.csv* file to ensure that the proper actions will be taken upon import. +1. Using a text editor or [CSV-compatible spreadsheet software](https://en.wikipedia.org/wiki/Comma-separated_values#Application_support), open _conflicts.csv_. +2. With guidance from the examples and reference tables below, review the _conflicts.csv_ file to ensure that the proper actions will be taken upon import. -The *conflicts.csv* file contains a *migration map* of conflicts and recommended actions. A migration map lists out both what data is being migrated from the source, and how the data will be applied to the target. +The _conflicts.csv_ file contains a _migration map_ of conflicts and recommended actions. A migration map lists out both what data is being migrated from the source, and how the data will be applied to the target. | `model_name` | `source_url` | `target_url` | `recommended_action` | |--------------|--------------|------------|--------------------| @@ -67,7 +67,7 @@ The *conflicts.csv* file contains a *migration map* of conflicts and recommended | `repository` | `https://example-gh.source/octo-org/widgets` | `https://example-gh.target/octo-org/widgets` | `rename` | | `team` | `https://example-gh.source/orgs/octo-org/teams/admins` | `https://example-gh.target/orgs/octo-org/teams/admins` | `merge` | -Each row in *conflicts.csv* provides the following information: +Each row in _conflicts.csv_ provides the following information: | Name | Description | |--------------|---------------| @@ -88,12 +88,12 @@ There are several different mapping actions that `ghe-migrator` can take when tr | `map_or_rename` | If the target exists, map to that target. Otherwise, rename the imported model. | Users | `merge` | Data from the source is combined with existing data on the target. | Teams -**We strongly suggest you review the *conflicts.csv* file and use [`ghe-migrator audit`](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server) to ensure that the proper actions are being taken.** If everything looks good, you can continue to "[AUTOTITLE](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)". +**We strongly suggest you review the _conflicts.csv_ file and use [`ghe-migrator audit`](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server) to ensure that the proper actions are being taken.** If everything looks good, you can continue to "[AUTOTITLE](/migrations/using-ghe-migrator/migrating-data-to-github-enterprise-server)". ## Resolving migration conflicts or setting up custom mappings -If you believe that `ghe-migrator` will perform an incorrect change, you can make corrections by changing the data in *conflicts.csv*. You can make changes to any of the rows in *conflicts.csv*. +If you believe that `ghe-migrator` will perform an incorrect change, you can make corrections by changing the data in _conflicts.csv_. You can make changes to any of the rows in _conflicts.csv_. For example, let's say you notice that the `octocat` user from the source is being mapped to `octocat` on the target. @@ -101,7 +101,7 @@ For example, let's say you notice that the `octocat` user from the source is bei |--------------|--------------|------------|--------------------| | `user` | `https://example-gh.source/octocat` | `https://example-gh.target/octocat` | `map` -You can choose to map the user to a different user on the target. Suppose you know that `octocat` should actually be `monalisa` on the target. You can change the `target_url` column in *conflicts.csv* to refer to `monalisa`. +You can choose to map the user to a different user on the target. Suppose you know that `octocat` should actually be `monalisa` on the target. You can change the `target_url` column in _conflicts.csv_ to refer to `monalisa`. | `model_name` | `source_url` | `target_url` | `recommended_action` | |--------------|--------------|------------|--------------------| @@ -137,13 +137,13 @@ The same process can be used to create mappings for each record that supports cu ### Applying modified migration data -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: +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/ ``` -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: +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 diff --git a/content/organizations/managing-organization-settings/transferring-organization-ownership.md b/content/organizations/managing-organization-settings/transferring-organization-ownership.md index 553ae959fd..cfacc5dee8 100644 --- a/content/organizations/managing-organization-settings/transferring-organization-ownership.md +++ b/content/organizations/managing-organization-settings/transferring-organization-ownership.md @@ -22,7 +22,7 @@ shortTitle: Transfer ownership {% endnote %}{% endif %} -1. If you're the only member with *owner* privileges, give another organization member the owner role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." +1. If you're the only member with _owner_ privileges, give another organization member the owner role. For more information, see "[AUTOTITLE](/organizations/managing-peoples-access-to-your-organization-with-roles/maintaining-ownership-continuity-for-your-organization#appointing-an-organization-owner)." 2. Contact the new owner and make sure they are able to [access the organization's settings](/organizations/collaborating-with-groups-in-organizations/accessing-your-organizations-settings). {% ifversion fpt or ghec %} 3. If you are currently responsible for paying for GitHub in your organization, you'll also need to have the new owner or a [billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization) update the organization's payment information. For more information, see "[AUTOTITLE](/billing/managing-your-github-billing-settings/adding-or-editing-a-payment-method)." diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md index e7dac4575f..c4b612810b 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization.md @@ -14,7 +14,7 @@ topics: shortTitle: Add a billing manager --- -Members of your organization's Owners team can give *billing manager* permissions to people. Once a person accepts their invitation to become a billing manager for your organization, they can invite additional people to be billing managers. +Members of your organization's Owners team can give _billing manager_ permissions to people. Once a person accepts their invitation to become a billing manager for your organization, they can invite additional people to be billing managers. {% note %} diff --git a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md index 251544894c..c3e366f5ca 100644 --- a/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md +++ b/content/organizations/managing-peoples-access-to-your-organization-with-roles/roles-in-an-organization.md @@ -63,7 +63,7 @@ By default, only organization owners can manage the settings of {% data variable When you designate a user as a {% data variables.product.prodname_github_app %} manager in your organization, you can grant them access to manage the settings of some or all {% data variables.product.prodname_github_app %} registrations owned by the organization. The {% data variables.product.prodname_github_app %} manager role does not grant users access to install and uninstall {% data variables.product.prodname_github_apps %} on an organization. For more information, see "[AUTOTITLE](/organizations/managing-programmatic-access-to-your-organization/adding-and-removing-github-app-managers-in-your-organization)." ### Outside collaborators -To keep your organization's data secure while allowing access to repositories, you can add *outside collaborators*. {% data reusables.organizations.outside_collaborators_description %} +To keep your organization's data secure while allowing access to repositories, you can add _outside collaborators_. {% data reusables.organizations.outside_collaborators_description %} ## Permissions for organization roles @@ -85,7 +85,7 @@ Some of the features listed below are limited to organizations using {% data var | Remove members from the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Reinstate former members to the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Add and remove people from **all teams** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Promote organization members to *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | +| Promote organization members to _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Configure code review assignments (see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Set scheduled reminders (see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-scheduled-reminders-for-your-team)") | {% octicon "check" aria-label="Yes" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Add collaborators to **all repositories** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | @@ -100,7 +100,7 @@ Some of the features listed below are limited to organizations using {% data var | Create project boards (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | See all organization members and teams | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | @mention any visible team | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | -| Can be made a *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghec %} +| Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghec %} | View organization insights (see "[AUTOTITLE](/organizations/collaborating-with-groups-in-organizations/viewing-insights-for-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion team-discussions %} | View and post public team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | View and post private team discussions to **all teams** (see "[AUTOTITLE](/organizations/collaborating-with-your-team/about-team-discussions)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | @@ -128,8 +128,8 @@ Some of the features listed below are limited to organizations using {% data var | Manage {% data variables.product.prodname_dependabot_security_updates %} (see "[AUTOTITLE](/code-security/dependabot/dependabot-security-updates/about-dependabot-security-updates)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | | [Manage the forking policy](/organizations/managing-organization-settings/managing-the-forking-policy-for-your-organization) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | [Limit activity in public repositories in an organization](/communities/moderating-comments-and-conversations/limiting-interactions-in-your-organization) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Pull (read) *all repositories* in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | -| Push (write) and clone (copy) *all repositories* in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | +| Pull (read) _all repositories_ in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | +| Push (write) and clone (copy) _all repositories_ in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Convert organization members to [outside collaborators](#outside-collaborators) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | [View people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% ifversion ghec %} | [Export a list of people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository#exporting-a-list-of-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% endif %} @@ -152,7 +152,7 @@ Some of the features listed below are limited to organizations using {% data var | Remove members from the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Reinstate former members to the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Add and remove people from **all teams** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Promote organization members to *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | +| Promote organization members to _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Configure code review assignments (see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Add collaborators to **all repositories** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Access the organization audit log | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | @@ -164,7 +164,7 @@ Some of the features listed below are limited to organizations using {% data var | Create teams (see "[AUTOTITLE](/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | See all organization members and teams | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | @mention any visible team | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | -| Can be made a *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | +| Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Transfer repositories | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Manage security and analysis settings (see "[AUTOTITLE](/organizations/keeping-your-organization-secure/managing-security-settings-for-your-organization/managing-security-and-analysis-settings-for-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% ifversion ghes %} | View the security overview for the organization (see "[AUTOTITLE](/code-security/security-overview/about-the-security-overview)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} |{% endif %}{% ifversion ghes %} @@ -179,8 +179,8 @@ Some of the features listed below are limited to organizations using {% data var | Set a team profile picture in **all teams** (see "[AUTOTITLE](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% ifversion ghes %} | Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} |{% endif %} | [Move teams in an organization's hierarchy](/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | -| Pull (read) *all repositories* in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | -| Push (write) and clone (copy) *all repositories* in the organization | {% octicon "check" aria-label="Yes" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | +| Pull (read) _all repositories_ in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "check" aria-label="Yes" %} | +| Push (write) and clone (copy) _all repositories_ in the organization | {% octicon "check" aria-label="Yes" %} |{% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | Convert organization members to [outside collaborators](#outside-collaborators) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | [View people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | | [Export a list of people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository#exporting-a-list-of-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | {% octicon "x" aria-label="No" %} | @@ -202,7 +202,7 @@ Some of the features listed below are limited to organizations using {% data var | Remove members from the organization | {% octicon "check" aria-label="Yes" %} |{% octicon "x" aria-label="No" %} | | Reinstate former members to the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Add and remove people from **all teams** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | -| Promote organization members to *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | +| Promote organization members to _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Configure code review assignments (see "[AUTOTITLE](/organizations/organizing-members-into-teams/managing-code-review-settings-for-your-team)")) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Add collaborators to **all repositories** | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Access the organization audit log | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | @@ -214,7 +214,7 @@ Some of the features listed below are limited to organizations using {% data var | Create teams (see "[AUTOTITLE](/organizations/managing-organization-settings/setting-team-creation-permissions-in-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | See all organization members and teams | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | @mention any visible team | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | -| Can be made a *team maintainer* | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | +| Can be made a _team maintainer_ | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | | Transfer repositories | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Manage an organization's SSH certificate authorities (see "[AUTOTITLE](/organizations/managing-git-access-to-your-organizations-repositories/managing-your-organizations-ssh-certificate-authorities)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Create project boards (see "[AUTOTITLE](/organizations/managing-access-to-your-organizations-project-boards/project-board-permissions-for-an-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% ifversion team-discussions %} @@ -226,7 +226,7 @@ Some of the features listed below are limited to organizations using {% data var | Set a team profile picture in **all teams** (see "[AUTOTITLE](/organizations/organizing-members-into-teams/setting-your-teams-profile-picture)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% ifversion ghes %} | Manage the publication of {% data variables.product.prodname_pages %} sites from repositories in the organization (see "[AUTOTITLE](/organizations/managing-organization-settings/managing-the-publication-of-github-pages-sites-for-your-organization)") | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} |{% endif %} | [Move teams in an organization's hierarchy](/organizations/organizing-members-into-teams/moving-a-team-in-your-organizations-hierarchy) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | -| Pull (read), push (write), and clone (copy) *all repositories* in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | +| Pull (read), push (write), and clone (copy) _all repositories_ in the organization | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | Convert organization members to [outside collaborators](#outside-collaborators) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | [View people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | | [Export a list of people with access to an organization repository](/organizations/managing-user-access-to-your-organizations-repositories/viewing-people-with-access-to-your-repository#exporting-a-list-of-people-with-access-to-your-repository) | {% octicon "check" aria-label="Yes" %} | {% octicon "x" aria-label="No" %} | diff --git a/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md b/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md index 15216561d3..37500d8e5e 100644 --- a/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md +++ b/content/organizations/managing-user-access-to-your-organizations-repositories/reinstating-a-former-outside-collaborators-access-to-your-organization.md @@ -50,7 +50,7 @@ When you reinstate a former outside collaborator, you can restore: {% warning %} - **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Invite and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization *and* keep their private forks, choose **Invite and reinstate** instead. Once this person accepts the invitation, you can convert them to an organization member by [inviting them to join the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member). + **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Invite and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Invite and reinstate** instead. Once this person accepts the invitation, you can convert them to an organization member by [inviting them to join the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member). {% endwarning %} {% else %} @@ -58,7 +58,7 @@ When you reinstate a former outside collaborator, you can restore: {% warning %} - **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Add and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization *and* keep their private forks, choose **Add and reinstate** instead. Then, you can convert them to an organization member by [adding them to the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member). + **Warning:** If you want to upgrade the outside collaborator to a member of your organization, then choose **Add and start fresh** and choose a new role for this person. Note, however, that this person's private forks of your organization's repositories will be lost if you choose to start fresh. To make the former outside collaborator a member of your organization _and_ keep their private forks, choose **Add and reinstate** instead. Then, you can convert them to an organization member by [adding them to the organization as a member](/organizations/managing-user-access-to-your-organizations-repositories/converting-an-outside-collaborator-to-an-organization-member). {% endwarning %} {% endif %} diff --git a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md index 196bc8f561..9607c56b8d 100644 --- a/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md +++ b/content/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry.md @@ -31,11 +31,11 @@ shortTitle: Apache Maven registry {% data reusables.package_registry.required-scopes %} -You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your *~/.m2/settings.xml* file to include your {% data variables.product.pat_v1 %}. Create a new *~/.m2/settings.xml* file if one doesn't exist. +You can authenticate to {% data variables.product.prodname_registry %} with Apache Maven by editing your _~/.m2/settings.xml_ file to include your {% data variables.product.pat_v1 %}. Create a new _~/.m2/settings.xml_ file if one doesn't exist. -In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your {% data variables.product.pat_generic %}. +In the `servers` tag, add a child `server` tag with an `id`, replacing USERNAME with your {% data variables.product.prodname_dotcom %} username, and TOKEN with your {% data variables.product.pat_generic %}. -In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.location.product_location %}, and{% endif %} *OWNER* with the name of the personal account or organization that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %}, and{% endif %} OWNER with the name of the personal account or organization that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. @@ -131,11 +131,11 @@ If your instance has subdomain isolation disabled: {% data reusables.package_registry.default-name %} For example, {% data variables.product.prodname_dotcom %} will publish a package named `com.example:test` in a repository called `OWNER/test`. -If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the *pom.xml* file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. +If you would like to publish multiple packages to the same repository, you can include the URL of the repository in the `` element of the _pom.xml_ file. {% data variables.product.prodname_dotcom %} will match the repository based on that field. Since the repository name is also part of the `distributionManagement` element, there are no additional steps to publish multiple packages to the same repository. For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.location.product_location %}, {% endif %}`OWNER` with the name of the personal account or organization that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} +1. Edit the `distributionManagement` element of the _pom.xml_ file located in your package directory, replacing {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %}, {% endif %}`OWNER` with the name of the personal account or organization that owns the repository and `REPOSITORY` with the name of the repository containing your project.{% ifversion ghes %} If your instance has subdomain isolation enabled:{% endif %} ```xml @@ -167,10 +167,10 @@ For more information on creating a package, see the [maven.apache.org documentat ## Installing a package -To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the *pom.xml* file to include the package as a dependency. If you want to install packages from any repository for a specified repository owner, use a repository URL like `https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/*`. For more information on using a *pom.xml* file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. +To install an Apache Maven package from {% data variables.product.prodname_registry %}, edit the _pom.xml_ file to include the package as a dependency. If you want to install packages from any repository for a specified repository owner, use a repository URL like `https://{% ifversion fpt or ghec %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/*`. For more information on using a _pom.xml_ file in your project, see "[Introduction to the POM](https://maven.apache.org/guides/introduction/introduction-to-the-pom.html)" in the Apache Maven documentation. {% data reusables.package_registry.authenticate-step %} -2. Add the package dependencies to the `dependencies` element of your project *pom.xml* file, replacing `com.example:test` with your package. +2. Add the package dependencies to the `dependencies` element of your project _pom.xml_ file, replacing `com.example:test` with your package. ```xml 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 1384b2e0a2..dd4da69fcb 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 @@ -104,7 +104,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen > REPOSITORY TAG IMAGE ID CREATED SIZE > 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 personal account or organization 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.location.product_location %},{% endif %} and *VERSION* with package version at build time. +2. Using the Docker image ID, tag the docker image, replacing OWNER with the name of the personal account or organization 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.location.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 @@ -123,7 +123,7 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen ``` {% 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 personal account or organization 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.location.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. +3. If you haven't already built a docker image for the package, build the image, replacing OWNER with the name of the personal account or organization 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.location.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 @@ -233,7 +233,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% data reusables.package_registry.docker_registry_deprecation_status %} -You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the personal account or organization 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 host name of {% data variables.location.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing OWNER with the name of the personal account or organization 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 host name of {% data variables.location.product_location %}, {% endif %} and TAG_NAME with tag for the image you want to install. {% ifversion fpt or ghec %} ```shell 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 995e04e7de..3ce3cc6966 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 @@ -31,15 +31,15 @@ shortTitle: Gradle registry {% data reusables.package_registry.required-scopes %} -You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file to include your {% data variables.product.pat_v1 %}. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. +You can authenticate to {% data variables.product.prodname_registry %} with Gradle using either Gradle Groovy or Kotlin DSL by editing your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file to include your {% data variables.product.pat_v1 %}. You can also configure Gradle Groovy and Kotlin DSL to recognize a single package or multiple packages in a repository. {% ifversion ghes %} -Replace *REGISTRY_URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. +Replace REGISTRY_URL with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace HOSTNAME with the host name of your {% data variables.product.prodname_ghe_server %} instance. {% elsif ghae %} -Replace *REGISTRY_URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.location.product_location %}. +Replace REGISTRY_URL with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace HOSTNAME with the host name of {% data variables.location.product_location %}. {% endif %} -Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your {% data variables.product.pat_v1 %}, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the personal account or organization on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. +Replace USERNAME with your {% data variables.product.prodname_dotcom %} username, TOKEN with your {% data variables.product.pat_v1 %}, REPOSITORY with the name of the repository containing the package you want to publish, and OWNER with the name of the personal account or organization on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. {% note %} @@ -171,7 +171,7 @@ subprojects { To use a published package from {% data variables.product.prodname_registry %}, add the package as a dependency and add the repository to your project. For more information, see "[Declaring dependencies](https://docs.gradle.org/current/userguide/declaring_dependencies.html)" in the Gradle documentation. {% data reusables.package_registry.authenticate-step %} -2. Add the package dependencies to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. +2. Add the package dependencies to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. Example using Gradle Groovy: ```shell @@ -186,7 +186,7 @@ To use a published package from {% data variables.product.prodname_registry %}, } ``` -3. Add the repository to your *build.gradle* file (Gradle Groovy) or *build.gradle.kts* file (Kotlin DSL) file. +3. Add the repository to your _build.gradle_ file (Gradle Groovy) or _build.gradle.kts_ file (Kotlin DSL) file. Example using Gradle Groovy: ```shell 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 521582d15a..c6bc555dab 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 @@ -48,9 +48,9 @@ This registry supports granular permissions. {% data reusables.package_registry. {% data reusables.package_registry.required-scopes %} -You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. +You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user _~/.npmrc_ file to include your {% data variables.product.pat_v1 %} or by logging in to npm on the command line using your username and {% data variables.product.pat_generic %}. -To authenticate by adding your {% data variables.product.pat_v1 %} to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% ifversion ghes or ghae %}*HOSTNAME* with the host name of {% data variables.location.product_location %} and {% endif %}*TOKEN* with your {% data variables.product.pat_generic %}. Create a new *~/.npmrc* file if one doesn't exist. +To authenticate by adding your {% data variables.product.pat_v1 %} to your _~/.npmrc_ file, edit the _~/.npmrc_ file for your project to include the following line, replacing {% ifversion ghes or ghae %}HOSTNAME with the host name of {% data variables.location.product_location %} and {% endif %}TOKEN with your {% data variables.product.pat_generic %}. Create a new _~/.npmrc_ file if one doesn't exist. {% ifversion ghes %} If your instance has subdomain isolation enabled: @@ -68,7 +68,7 @@ If your instance has subdomain isolation disabled: ``` {% endif %} -To authenticate by logging in to npm, use the `npm login` command, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your {% data variables.product.pat_v1 %}, and *PUBLIC-EMAIL-ADDRESS* with your email address. +To authenticate by logging in to npm, use the `npm login` command, replacing USERNAME with your {% data variables.product.prodname_dotcom %} username, TOKEN with your {% data variables.product.pat_v1 %}, and PUBLIC-EMAIL-ADDRESS with your email address. If you are using npm CLI version 9 or greater and are logging in or out of a private registry using the command line, you should use the `--auth-type=legacy` option to read in your authentication details from prompts instead of using the default login flow through a browser. For more information, see [`npm-login`](https://docs.npmjs.com/cli/v9/commands/npm-login). @@ -121,32 +121,32 @@ The {% data variables.product.prodname_registry %} registry stores npm packages {% data reusables.package_registry.publishing-user-scoped-packages %} For more information on linking a published package with a repository, see "[AUTOTITLE](/packages/learn-github-packages/connecting-a-repository-to-a-package)." {% endif %} -By default, your package is published in the {% data variables.product.prodname_dotcom %} repository that you specify in the name field of the *package.json* file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a *README.md* file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. +By default, your package is published in the {% data variables.product.prodname_dotcom %} repository that you specify in the name field of the _package.json_ file. For example, you would publish a package named `@my-org/test` to the `my-org/test` {% data variables.product.prodname_dotcom %} repository. If you're running [npm v8.5.3](https://github.com/npm/cli/releases/tag/v8.5.3) or later, you can add a summary for the package listing page by including a _README.md_ file in your package directory. For more information, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" and "[How to create Node.js Modules](https://docs.npmjs.com/getting-started/creating-node-modules)" in the npm documentation. {% data reusables.package_registry.auto-inherit-permissions-note %} -You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the *package.json* file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." +You can publish multiple packages to the same {% data variables.product.prodname_dotcom %} repository by including a `URL` field in the _package.json_ file. For more information, see "[Publishing multiple packages to the same repository](#publishing-multiple-packages-to-the-same-repository)." -You can set up the scope mapping for your project using either a local *.npmrc* file in the project or using the `publishConfig` option in the *package.json*. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@NAMESPACE/PACKAGE-NAME`. Scoped packages always begin with an `@` symbol. You may need to update the name in your *package.json* to use the scoped name. For example, if you're the user `octocat` and your package is named `test`, you would assign the scoped package name as follows: `"name": "@octocat/test"`. +You can set up the scope mapping for your project using either a local _.npmrc_ file in the project or using the `publishConfig` option in the _package.json_. {% data variables.product.prodname_registry %} only supports scoped npm packages. Scoped packages have names with the format of `@NAMESPACE/PACKAGE-NAME`. Scoped packages always begin with an `@` symbol. You may need to update the name in your _package.json_ to use the scoped name. For example, if you're the user `octocat` and your package is named `test`, you would assign the scoped package name as follows: `"name": "@octocat/test"`. {% data reusables.package_registry.viewing-packages %} -### Publishing a package using a local *.npmrc* file +### Publishing a package using a local _.npmrc_ file -You can use an *.npmrc* file to configure the scope mapping for your project. In the *.npmrc* file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an *.npmrc* file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. +You can use an _.npmrc_ file to configure the scope mapping for your project. In the _.npmrc_ file, use the {% data variables.product.prodname_registry %} URL and account owner so {% data variables.product.prodname_registry %} knows where to route package requests. Using an _.npmrc_ file prevents other developers from accidentally publishing the package to npmjs.org instead of {% data variables.product.prodname_registry %}. {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. Verify the name of your package in your project's *package.json*. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your *package.json* should be `@my-org/test`. +1. Verify the name of your package in your project's _package.json_. The `name` field must contain the scope and the name of the package. For example, if your package is called "test", and you are publishing to the "My-org" {% data variables.product.prodname_dotcom %} organization, the `name` field in your _package.json_ should be `@my-org/test`. {% data reusables.package_registry.verify_repository_field %} {% data reusables.package_registry.publish_package %} -### Publishing a package using `publishConfig` in the *package.json* file +### Publishing a package using `publishConfig` in the _package.json_ file -You can use `publishConfig` element in the *package.json* file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. +You can use `publishConfig` element in the _package.json_ file to specify the registry where you want the package published. For more information, see "[publishConfig](https://docs.npmjs.com/files/package.json#publishconfig)" in the npm documentation. -1. Edit the *package.json* file for your package and include a `publishConfig` entry. +1. Edit the _package.json_ file for your package and include a `publishConfig` entry. {% ifversion ghes %} If your instance has subdomain isolation enabled: {% endif %} @@ -168,7 +168,7 @@ You can use `publishConfig` element in the *package.json* file to specify the re ## Publishing multiple packages to the same repository -To publish multiple packages {% ifversion packages-npm-v2 %}and link them {% endif %}to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the *package.json* file for each package. +To publish multiple packages {% ifversion packages-npm-v2 %}and link them {% endif %}to the same repository, you can include the URL of the {% data variables.product.prodname_dotcom %} repository in the `repository` field of the _package.json_ file for each package. To ensure the repository's URL is correct, replace `REPOSITORY` with the name of the repository containing the package you want to publish, and `OWNER` with the name of the personal account or organization on {% data variables.product.prodname_dotcom %} that owns the repository. @@ -180,11 +180,11 @@ To ensure the repository's URL is correct, replace `REPOSITORY` with the name of ## Installing a package -You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the *package.json* file for your project. For more information on using a *package.json* in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. +You can install packages from {% data variables.product.prodname_registry %} by adding the packages as dependencies in the _package.json_ file for your project. For more information on using a _package.json_ in your project, see "[Working with package.json](https://docs.npmjs.com/getting-started/using-a-package.json)" in the npm documentation. By default, you can add packages from one organization. For more information, see "[Installing packages from other organizations](#installing-packages-from-other-organizations)." -You also need to add the *.npmrc* file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from *npmjs.org*. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} +You also need to add the _.npmrc_ file to your project so that all requests to install packages will {% ifversion ghae %}be routed to{% else %}go through{% endif %} {% data variables.product.prodname_registry %}. {% ifversion fpt or ghes or ghec %}When you route all package requests through {% data variables.product.prodname_registry %}, you can use both scoped and unscoped packages from _npmjs.org_. For more information, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation.{% endif %} {% ifversion ghae %} By default, you can only use npm packages hosted on your enterprise, and you will not be able to use unscoped packages. For more information on package scoping, see "[npm-scope](https://docs.npmjs.com/misc/scope)" in the npm documentation. If required, {% data variables.product.prodname_dotcom %} support can enable an upstream proxy to npmjs.org. Once an upstream proxy is enabled, if a requested package isn't found on your enterprise, {% data variables.product.prodname_registry %} makes a proxy request to npmjs.org. @@ -193,7 +193,7 @@ By default, you can only use npm packages hosted on your enterprise, and you wil {% data reusables.package_registry.authenticate-step %} {% data reusables.package_registry.create-npmrc-owner-step %} {% data reusables.package_registry.add-npmrc-to-repo-step %} -1. Configure *package.json* in your project to use the package you are installing. To add your package dependencies to the *package.json* file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from *npmjs.com*, specify the full name, such as `@babel/core` or `@lodash`. Replace `ORGANIZATION_NAME/PACKAGE_NAME` with your package dependency. +1. Configure _package.json_ in your project to use the package you are installing. To add your package dependencies to the _package.json_ file for {% data variables.product.prodname_registry %}, specify the full-scoped package name, such as `@my-org/server`. For packages from _npmjs.com_, specify the full name, such as `@babel/core` or `@lodash`. Replace `ORGANIZATION_NAME/PACKAGE_NAME` with your package dependency. ```json { @@ -216,7 +216,7 @@ By default, you can only use npm packages hosted on your enterprise, and you wil ### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% ifversion ghes or ghae %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your _.npmrc_ file, replacing {% ifversion ghes or ghae %}`HOSTNAME` with the host name of {% data variables.location.product_location %} and {% endif %}`NAMESPACE` with the name of the personal account or organization {% ifversion packages-npm-v2 %}to which the package is scoped{% else %}that owns the repository containing the project{% endif %}. {% ifversion ghes %} If your instance has subdomain isolation enabled: 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 cc3100a286..2700608fdb 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 @@ -53,7 +53,7 @@ Replace `NAMESPACE` with the name of the personal account or organization {% ifv {% data reusables.package_registry.required-scopes %} -To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a *nuget.config* file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. +To authenticate to {% data variables.product.prodname_registry %} with the `dotnet` command-line interface (CLI), create a _nuget.config_ file in your project directory specifying {% data variables.product.prodname_registry %} as a source under `packageSources` for the `dotnet` CLI client. You must replace: - `USERNAME` with the name of your personal account on {% data variables.product.prodname_dotcom %}. @@ -102,7 +102,7 @@ If your instance has subdomain isolation disabled: ## Publishing a package -You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} {% data variables.product.pat_v1 %}. +You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a _nuget.config_ file, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} {% data variables.product.pat_v1 %}. {% ifversion packages-nuget-v2 %} @@ -134,9 +134,9 @@ If you don't already have a {% data variables.product.pat_generic %} to use for {% data reusables.package_registry.viewing-packages %} -### Publishing a package using a *nuget.config* file +### Publishing a package using a _nuget.config_ file -When publishing, {% ifversion packages-nuget-v2 %}if you are linking your package to a repository, {% endif %}the `OWNER` of the repository specified in your *.csproj* file must match the `NAMESPACE` that you use in your *nuget.config* authentication file. Specify or increment the version number in your *.csproj* file, then use the `dotnet pack` command to create a *.nuspec* file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. +When publishing, {% ifversion packages-nuget-v2 %}if you are linking your package to a repository, {% endif %}the `OWNER` of the repository specified in your _.csproj_ file must match the `NAMESPACE` that you use in your _nuget.config_ authentication file. Specify or increment the version number in your _.csproj_ file, then use the `dotnet pack` command to create a _.nuspec_ file for that version. For more information on creating your package, see "[Create and publish a package](https://docs.microsoft.com/nuget/quickstart/create-and-publish-a-package-using-the-dotnet-cli)" in the Microsoft documentation. {% data reusables.package_registry.auto-inherit-permissions-note %} @@ -145,7 +145,7 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag ```shell dotnet new console --name PROJECT_NAME ``` -3. Add your project's specific information to your project's file, which ends in *.csproj*. Make sure to replace: +3. Add your project's specific information to your project's file, which ends in _.csproj_. Make sure to replace: - `1.0.0` with the version number of the package. - `OWNER` with the name of the personal account or organization that owns the repository to which you want to {% ifversion packages-nuget-v2 %}link your package{% else %}publish your package{% endif %}. - `REPOSITORY` with the name of the repository to which you want to connect your package.{% ifversion ghes or ghae %} @@ -171,7 +171,7 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag dotnet pack --configuration Release ``` -5. Publish the package using the `key` you specified in the *nuget.config* file. Replace `PROJECT_NAME` with the name of the project, and replace `1.0.0` with the version number of the package. +5. Publish the package using the `key` you specified in the _nuget.config_ file. Replace `PROJECT_NAME` with the name of the project, and replace `1.0.0` with the version number of the package. ```shell dotnet nuget push "bin/Release/PROJECT_NAME.1.0.0.nupkg" --source "github" ``` @@ -180,9 +180,9 @@ When publishing, {% ifversion packages-nuget-v2 %}if you are linking your packag ## Publishing multiple packages to the same repository -To connect multiple packages to the same repository, use the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all *.csproj* project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. +To connect multiple packages to the same repository, use the same {% data variables.product.prodname_dotcom %} repository URL in the `RepositoryURL` fields in all _.csproj_ project files. {% data variables.product.prodname_dotcom %} matches the repository based on that field. -The following example publishes the projects *MY_APP* and *MY_OTHER_APP* to the same repository: +The following example publishes the projects MY_APP and MY_OTHER_APP to the same repository: ``` xml @@ -220,11 +220,11 @@ The following example publishes the projects *MY_APP* and *MY_OTHER_APP* to the ## Installing a package -Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from *nuget.org*. Add your package dependencies to your *.csproj* file, specifying the package name and version. For more information on using a *.csproj* file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. +Using packages from {% data variables.product.prodname_dotcom %} in your project is similar to using packages from _nuget.org_. Add your package dependencies to your _.csproj_ file, specifying the package name and version. For more information on using a _.csproj_ file in your project, see "[Working with NuGet packages](https://docs.microsoft.com/nuget/consume-packages/overview-and-workflow)" in the Microsoft documentation. {% data reusables.package_registry.authenticate-step %} -2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the *.csproj* project file. Replace the `PACKAGE_NAME` value in `Include="PACKAGE_NAME"` with your package dependency, and replace the `X.X.X` value in `Version="X.X.X"` with the version of the package you want to use: +2. To use a package, add `ItemGroup` and configure the `PackageReference` field in the _.csproj_ project file. Replace the `PACKAGE_NAME` value in `Include="PACKAGE_NAME"` with your package dependency, and replace the `X.X.X` value in `Version="X.X.X"` with the version of the package you want to use: ``` xml @@ -253,7 +253,7 @@ Using packages from {% data variables.product.prodname_dotcom %} in your project ## Troubleshooting -{% ifversion packages-nuget-v2 %}{% else %}Your NuGet package may fail to push if the `RepositoryUrl` in *.csproj* is not set to the expected repository. +{% ifversion packages-nuget-v2 %}{% else %}Your NuGet package may fail to push if the `RepositoryUrl` in _.csproj_ is not set to the expected repository. If you're using a nuspec file, ensure that it has a `repository` element with the required `type` and `url` attributes.{% endif %} 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 73d75912bb..88095a9342 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 @@ -56,9 +56,9 @@ This registry supports granular permissions. {% data reusables.package_registry. To publish and install gems, you can configure RubyGems or Bundler to authenticate to {% data variables.product.prodname_registry %} using your {% data variables.product.pat_generic %}. -To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your *~/.gem/credentials* file to include your {% data variables.product.pat_v1 %}. Create a new *~/.gem/credentials* file if this file doesn't exist. +To publish new gems, you need to authenticate to {% data variables.product.prodname_registry %} with RubyGems by editing your _~/.gem/credentials_ file to include your {% data variables.product.pat_v1 %}. Create a new _~/.gem/credentials_ file if this file doesn't exist. -For example, you would create or edit a *~/.gem/credentials* to include the following, replacing *TOKEN* with your {% data variables.product.pat_generic %}. +For example, you would create or edit a _~/.gem/credentials_ to include the following, replacing TOKEN with your {% data variables.product.pat_generic %}. ```shell --- @@ -69,9 +69,9 @@ To install gems, you need to authenticate to {% data variables.product.prodname_ - `USERNAME` with your {% data variables.product.prodname_dotcom %} username. - `TOKEN` with your {% data variables.product.pat_v1 %}. - `NAMESPACE` with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem is scoped{% else %}that owns the repository containing the gem{% endif %}.{% ifversion ghes %} -- `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. +- `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 %} -- `REGISTRY_URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.location.product_location %}. +- `REGISTRY_URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace HOSTNAME with the hostname of {% data variables.location.product_location %}. {% endif %} If you would like your package to be available globally, you can run the following command to add your registry as a source. @@ -79,7 +79,7 @@ If you would like your package to be available globally, you can run the followi gem sources --add https://USERNAME:TOKEN@{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE/ ``` -To authenticate with Bundler, configure Bundler to use your {% data variables.product.pat_v1 %}, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your {% data variables.product.pat_generic %}, and *NAMESPACE* with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem is scoped{% else %}that owns the repository containing the gem{% endif %}.{% 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.location.product_location %}.{% endif %} +To authenticate with Bundler, configure Bundler to use your {% data variables.product.pat_v1 %}, replacing USERNAME with your {% data variables.product.prodname_dotcom %} username, TOKEN with your {% data variables.product.pat_generic %}, and NAMESPACE with the name of the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem is scoped{% else %}that owns the repository containing the gem{% endif %}.{% 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.location.product_location %}.{% endif %} ```shell $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% else %}REGISTRY_URL{% endif %}/NAMESPACE USERNAME:TOKEN @@ -92,7 +92,7 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els {% data reusables.package_registry.auto-inherit-permissions-note %} {% data reusables.package_registry.authenticate-step %} -1. Build the package from the *gemspec* to create the *.gem* package. Replace `GEM_NAME` with the name of your gem. +1. Build the package from the _gemspec_ to create the _.gem_ package. Replace `GEM_NAME` with the name of your gem. ``` gem build GEM_NAME.gemspec ``` @@ -116,7 +116,7 @@ $ bundle config https://{% ifversion fpt or ghec %}rubygems.pkg.github.com{% els The RubyGems registry stores packages within your organization or personal account, and allows you to associate packages with a repository. You can choose whether to inherit permissions from a repository, or set granular permissions independently of a repository. -You can ensure gems will be linked to a repository as soon as they are published by including the URL of the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. You can link multiple gems to the same repository. {% ifversion ghes %} In the following example, replace *HOSTNAME* with the host name of {% data variables.location.product_location %}.{% endif %} +You can ensure gems will be linked to a repository as soon as they are published by including the URL of the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. You can link multiple gems to the same repository. {% ifversion ghes %} In the following example, replace HOSTNAME with the host name of {% data variables.location.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } @@ -128,7 +128,7 @@ For information on linking a published package with a repository, see "[AUTOTITL ## Publishing multiple packages to the same repository -To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace *HOSTNAME* with the host name of {% data variables.location.product_location %}.{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% ifversion ghes or ghae %} Replace HOSTNAME with the host name of {% data variables.location.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } @@ -138,10 +138,10 @@ gem.metadata = { "github_repo" => "ssh://{% ifversion fpt or ghec %}github.com{% ## Installing a package -You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing your *Gemfile*. +You can use gems from {% data variables.product.prodname_registry %} much like you use gems from _rubygems.org_. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the _~/.gemrc_ file or by using Bundler and editing your _Gemfile_. {% data reusables.package_registry.authenticate-step %} -1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing `GEM_NAME` with the package you want to install from {% data variables.product.prodname_registry %} and `NAMESPACE` with the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem you want to install is scoped{% else %}that owns the repository containing the gem you want to install{% endif %}.{% 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 host name 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.location.product_location %}.{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your _Gemfile_ to fetch gems from this new source. For example, you can add a new `source` block to your _Gemfile_ that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing `GEM_NAME` with the package you want to install from {% data variables.product.prodname_registry %} and `NAMESPACE` with the personal account or organization {% ifversion packages-rubygems-v2 %}to which the gem you want to install is scoped{% else %}that owns the repository containing the gem you want to install{% endif %}.{% 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 host name 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.location.product_location %}.{% endif %} ```ruby source "https://rubygems.org" diff --git a/content/pages/getting-started-with-github-pages/about-github-pages.md b/content/pages/getting-started-with-github-pages/about-github-pages.md index 489ea63a07..cb778d2ba2 100644 --- a/content/pages/getting-started-with-github-pages/about-github-pages.md +++ b/content/pages/getting-started-with-github-pages/about-github-pages.md @@ -126,8 +126,8 @@ In addition, your use of {% data variables.product.prodname_pages %} is subject - Published {% data variables.product.prodname_pages %} sites may be no larger than 1 GB. - {% data variables.product.prodname_pages %} deployments will timeout if they take longer than 10 minutes. {% ifversion fpt or ghec %} -- {% data variables.product.prodname_pages %} sites have a *soft* bandwidth limit of 100 GB per month. -- {% data variables.product.prodname_pages %} sites have a *soft* limit of 10 builds per hour.{% ifversion pages-custom-workflow %} This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow {% endif %} +- {% data variables.product.prodname_pages %} sites have a _soft_ bandwidth limit of 100 GB per month. +- {% data variables.product.prodname_pages %} sites have a _soft_ limit of 10 builds per hour.{% ifversion pages-custom-workflow %} This limit does not apply if you build and publish your site with a custom {% data variables.product.prodname_actions %} workflow {% endif %} - In order to provide consistent quality of service for all {% data variables.product.prodname_pages %} sites, rate limits may apply. These rate limits are not intended to interfere with legitimate uses of {% data variables.product.prodname_pages %}. If your request triggers rate limiting, you will receive an appropriate response with an HTTP status code of `429`, along with an informative HTML body. If your site exceeds these usage quotas, we may not be able to serve your site, or you may receive a polite email from {% data variables.contact.contact_support %} suggesting strategies for reducing your site's impact on our servers, including putting a third-party content distribution network (CDN) in front of your site, making use of other {% data variables.product.prodname_dotcom %} features such as releases, or moving to a different hosting service that might better fit your needs. diff --git a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md index de8e4e6318..f5ca12ecce 100644 --- a/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md +++ b/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md @@ -44,12 +44,12 @@ The process may take some time. If the process has not completed several minutes ## Resolving problems with mixed content -If you enable HTTPS for your {% data variables.product.prodname_pages %} site but your site's HTML still references images, CSS, or JavaScript over HTTP, then your site is serving *mixed content*. Serving mixed content may make your site less secure and cause trouble loading assets. +If you enable HTTPS for your {% data variables.product.prodname_pages %} site but your site's HTML still references images, CSS, or JavaScript over HTTP, then your site is serving _mixed content_. Serving mixed content may make your site less secure and cause trouble loading assets. To remove your site's mixed content, make sure all your assets are served over HTTPS by changing `http://` to `https://` in your site's HTML. Assets are commonly found in the following locations: -- If your site uses Jekyll, your HTML files will probably be found in the *_layouts* folder. +- If your site uses Jekyll, your HTML files will probably be found in the __layouts_ folder. - CSS is usually found in the `` section of your HTML file. - JavaScript is usually found in the `` section or just before the closing `` tag. - Images are often found in the `` section. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md index 5866f7fdb6..9341a92002 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll.md @@ -39,7 +39,7 @@ We recommend using Jekyll with {% data variables.product.prodname_pages %}. If y ## Configuring Jekyll in your {% data variables.product.prodname_pages %} site -You can configure most Jekyll settings, such as your site's theme and plugins, by editing your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. +You can configure most Jekyll settings, such as your site's theme and plugins, by editing your __config.yml_ file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. Some configuration settings cannot be changed for {% data variables.product.prodname_pages %} sites. @@ -96,7 +96,7 @@ You can download or create Jekyll plugins to extend the functionality of Jekyll - [`jekyll-titles-from-headings`](https://github.com/benbalter/jekyll-titles-from-headings) - [`jekyll-relative-links`](https://github.com/benbalter/jekyll-relative-links) -You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your *_config.yml* file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. +You can enable additional plugins by adding the plugin's gem to the `plugins` setting in your __config.yml_ file. For more information, see "[Configuration](https://jekyllrb.com/docs/configuration/)" in the Jekyll documentation. For a list of supported plugins, see "[Dependency versions](https://pages.github.com/versions/)" on the {% data variables.product.prodname_pages %} site. For usage information for a specific plugin, see the plugin's documentation. @@ -112,9 +112,9 @@ For a list of supported plugins, see "[Dependency versions](https://pages.github To make your site easier to read, code snippets are highlighted on {% data variables.product.prodname_pages %} sites the same way they're highlighted on {% data variables.product.product_name %}. For more information about syntax highlighting on {% data variables.product.product_name %}, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/creating-and-highlighting-code-blocks)." -By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/jneen/rouge) highlighter, which is compatible with [Pygments](https://pygments.org/). Pygments has been deprecated and not supported in Jekyll 4. If you specify Pygments in your *_config.yml* file, Rouge will be used as the fallback instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your *_config.yml* file. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites)." +By default, code blocks on your site will be highlighted by Jekyll. Jekyll uses the [Rouge](https://github.com/jneen/rouge) highlighter, which is compatible with [Pygments](https://pygments.org/). Pygments has been deprecated and not supported in Jekyll 4. If you specify Pygments in your __config.yml_ file, Rouge will be used as the fallback instead. Jekyll cannot use any other syntax highlighter, and you'll get a page build warning if you specify another syntax highlighter in your __config.yml_ file. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-jekyll-build-errors-for-github-pages-sites)." -If you want to use another highlighter, such as `highlight.js`, you must disable Jekyll's syntax highlighting by updating your project's *_config.yml* file. +If you want to use another highlighter, such as `highlight.js`, you must disable Jekyll's syntax highlighting by updating your project's __config.yml_ file. ```yaml kramdown: diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md index d0e483c792..d0868c263a 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/adding-a-theme-to-your-github-pages-site-using-jekyll.md @@ -26,7 +26,7 @@ People with write permissions for a repository can add a theme to a {% data vari {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -2. Navigate to *_config.yml*. +2. Navigate to __config.yml_. {% data reusables.repositories.edit-file %} 4. Add a new line to the file for the theme name. - To use a supported theme, type `theme: THEME-NAME`, replacing _THEME-NAME_ with the name of the theme as shown in the README of the theme's repository. For a list of supported themes, see "[Supported themes](https://pages.github.com/themes/)" on the {% data variables.product.prodname_pages %} site. For example, to select the Minima theme, type `theme: minima`. @@ -61,11 +61,11 @@ People with write permissions for a repository can add a theme to a {% data vari {% data reusables.pages.theme-customization-help %} 1. On {% data variables.product.prodname_dotcom %}, navigate to your theme's source repository. For example, the source repository for Minima is https://github.com/jekyll/minima. -2. In the *_layouts* folder, navigate to your theme's _default.html_ file. +2. In the __layouts_ folder, navigate to your theme's _default.html_ file. 3. Copy the contents of the file. {% data reusables.pages.navigate-site-repo %} {% data reusables.pages.navigate-publishing-source %} -6. Create a file called *_layouts/default.html*. +6. Create a file called __layouts/default.html_. 7. Paste the default layout content you copied earlier. 8. Customize the layout as you'd like. diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md index a747fddc67..2548b5831b 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/setting-a-markdown-processor-for-your-github-pages-site-using-jekyll.md @@ -24,7 +24,7 @@ People with write permissions for a repository can set the Markdown processor fo You can use {% data variables.product.prodname_dotcom %} Flavored Markdown with either processor, but only our GFM processor will always match the results you see on {% data variables.product.product_name %}. {% data reusables.pages.navigate-site-repo %} -2. In your repository, browse to the *_config.yml* file. +2. In your repository, browse to the __config.yml_ file. {% data reusables.repositories.edit-file %} 4. Find the line that starts with `markdown:` and change the value to `kramdown` or `GFM`. The full line should read `markdown: kramdown` or `markdown: GFM`. {% data reusables.files.write_commit_message %} diff --git a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md index bb92d6ef2e..57b37a2e52 100644 --- a/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md +++ b/content/pages/setting-up-a-github-pages-site-with-jekyll/troubleshooting-jekyll-build-errors-for-github-pages-sites.md @@ -43,7 +43,7 @@ If Jekyll encounters an error building your {% data variables.product.prodname_p If you received a generic error message, check for common issues. - You're using unsupported plugins. For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#plugins)."{% ifversion fpt or ghec %} - Your repository has exceeded our repository size limits. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)"{% endif %} -- You changed the `source` setting in your *_config.yml* file. {% ifversion pages-custom-workflow %}If you publish your site from a branch, {% endif %}{% data variables.product.prodname_pages %} overrides this setting during the build process. +- You changed the `source` setting in your __config.yml_ file. {% ifversion pages-custom-workflow %}If you publish your site from a branch, {% endif %}{% data variables.product.prodname_pages %} overrides this setting during the build process. - A filename in your published files contains a colon (`:`) which is not supported. If you received a specific error message, review the troubleshooting information for the error message below. @@ -52,9 +52,9 @@ If you received a specific error message, review the troubleshooting information ## Config file error -This error means that your site failed to build because the *_config.yml* file contains syntax errors. +This error means that your site failed to build because the __config.yml_ file contains syntax errors. -To troubleshoot, make sure that your *_config.yml* file follows these rules: +To troubleshoot, make sure that your __config.yml_ file follows these rules: {% data reusables.pages.yaml-rules %} @@ -74,23 +74,23 @@ To troubleshoot, search the file in the error message and the file's layouts for ## File does not exist in includes directory -This error means that your code references a file that doesn't exist in your *_includes* directory. +This error means that your code references a file that doesn't exist in your __includes_ directory. -{% data reusables.pages.search-for-includes %} If any of the files you've referenced aren't in the *_includes* directory, copy or move the files into the *_includes* directory. +{% data reusables.pages.search-for-includes %} If any of the files you've referenced aren't in the __includes_ directory, copy or move the files into the __includes_ directory. {% ifversion ghes < 3.9 %} ## File is a symlink This error means that your code references a symlinked file that does not exist in the published files for your site. -{% data reusables.pages.search-for-includes %} If any of the files you've referenced are symlinked, copy or move the files into the *_includes* directory. +{% data reusables.pages.search-for-includes %} If any of the files you've referenced are symlinked, copy or move the files into the __includes_ directory. {% endif %} ## File is not properly UTF-8 encoded This error means that you used non-Latin characters, like `日本語`, without telling the computer to expect these symbols. -To troubleshoot, force UTF-8 encoding by adding the following line to your *_config.yml* file: +To troubleshoot, force UTF-8 encoding by adding the following line to your __config.yml_ file: ```yaml encoding: UTF-8 ``` @@ -99,7 +99,7 @@ encoding: UTF-8 This error means that you specified any syntax highlighter other than [Rouge](https://github.com/jneen/rouge) or [Pygments](https://pygments.org/) in your configuration file. -To troubleshoot, update your *_config.yml* file to specify [Rouge](https://github.com/jneen/rouge) or [Pygments](https://pygments.org/). For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting)." +To troubleshoot, update your __config.yml_ file to specify [Rouge](https://github.com/jneen/rouge) or [Pygments](https://pygments.org/). For more information, see "[AUTOTITLE](/pages/setting-up-a-github-pages-site-with-jekyll/about-github-pages-and-jekyll#syntax-highlighting)." ## Invalid post date @@ -107,7 +107,7 @@ This error means that a post on your site contains an invalid date in the filena To troubleshoot, make sure all dates are formatted as YYYY-MM-DD HH:MM:SS for UTC and are actual calendar dates. To specify a time zone with an offset from UTC, use the format YYYY-MM-DD HH:MM:SS +/-TTTT, like `2014-04-18 11:30:00 +0800`. -If you specify a date format in your *_config.yml* file, make sure the format is correct. +If you specify a date format in your __config.yml_ file, make sure the format is correct. ## Invalid Sass or SCSS @@ -125,9 +125,9 @@ If do you want to use the submodule, make sure you use `https://` when referenci ## Invalid YAML in data file -This error means that one of more files in the *_data* folder contains invalid YAML. +This error means that one of more files in the __data_ folder contains invalid YAML. -To troubleshoot, make sure the YAML files in your *_data* folder follow these rules: +To troubleshoot, make sure the YAML files in your __data_ folder follow these rules: {% data reusables.pages.yaml-rules %} @@ -162,11 +162,11 @@ If you do want to use a submodule, initialize the submodule. For more informatio ## Relative permalinks configured -This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your *_config.yml* file. +This errors means that you have relative permalinks, which are not supported by {% data variables.product.prodname_pages %}, in your __config.yml_ file. Permalinks are permanent URLs that reference a particular page on your site. Absolute permalinks begin with the root of the site, while relative permalinks begin with the folder containing the referenced page. {% data variables.product.prodname_pages %} and Jekyll no longer support relative permalinks. For more information about permalinks, see "[Permalinks](https://jekyllrb.com/docs/permalinks/)" in the Jekyll documentation. -To troubleshoot, remove the `relative_permalinks` line from your *_config.yml* file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)." +To troubleshoot, remove the `relative_permalinks` line from your __config.yml_ file and reformat any relative permalinks in your site with absolute permalinks. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/editing-files)." {% ifversion ghes < 3.9 %} ## Symlink does not exist within your site's repository 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 ab91ed33e1..05bb2bba84 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 @@ -35,7 +35,7 @@ For example, if you and another person both edited the file _styleguide.md_ on t ```shell 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. +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 @@ -80,14 +80,14 @@ You can now merge the branches on the command line or [push your changes to your 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. -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. +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. Navigate into the local Git repository that has the merge conflict. ```shell 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. +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 diff --git a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md index 1b3b79d5c5..c0713c6faf 100644 --- a/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md +++ b/content/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks.md @@ -15,7 +15,7 @@ versions: topics: - Pull requests --- -Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the *pending*, *passing*, or *failing* state of status checks next to individual commits in your pull request. +Status checks are based on external processes, such as continuous integration builds, which run for each push you make to a repository. You can see the _pending_, _passing_, or _failing_ state of status checks next to individual commits in your pull request. ![Screenshot of a list of commits and statuses.](/assets/images/help/pull_requests/commit-list-statuses.png) diff --git a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md index 03d2b83fc7..76f8341372 100644 --- a/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md +++ b/content/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges.md @@ -80,7 +80,7 @@ A pull request can be merged automatically if its head branch is directly or ind - Branch `feature` has been branched off of `main` and is currently at commit **D**. This branch has a pull request targeting `main`. - Branch `feature_2` is branched off of `feature` and is now at commit **E**. This branch also has a pull request targeting `main`. -If pull request **E** --> `main` is merged first, pull request **D** --> `main` will be marked as merged *automatically* because all of the commits from `feature` are now reachable from `main`. Merging `feature_2` into `main` and pushing `main` to the server from the command line will mark *both* pull requests as merged. +If pull request **E** --> `main` is merged first, pull request **D** --> `main` will be marked as merged _automatically_ because all of the commits from `feature` are now reachable from `main`. Merging `feature_2` into `main` and pushing `main` to the server from the command line will mark _both_ pull requests as merged. Pull requests in this situation will be marked as `merged` even if [branch protection rules](/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#about-branch-protection-rules) have not been satisfied. diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md index 50ab3ead1d..60d248fc8c 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches.md @@ -37,7 +37,7 @@ By default, {% data variables.product.product_name %} names the default branch ` ## Working with branches -Once you're satisfied with your work, you can open a pull request to merge the changes in the current branch (the *head* branch) into another branch (the *base* branch). For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." +Once you're satisfied with your work, you can open a pull request to merge the changes in the current branch (the _head_ branch) into another branch (the _base_ branch). For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." After a pull request has been merged, or closed, you can delete the head branch as this is no longer needed. You must have write access in the repository to delete branches. You can't delete branches that are directly associated with open pull requests. For more information, see "[AUTOTITLE](/repositories/configuring-branches-and-merges-in-your-repository/managing-branches-in-your-repository/deleting-and-restoring-branches-in-a-pull-request)" diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md index 04f76fea16..ed9faebd5b 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-comparing-branches-in-pull-requests.md @@ -50,7 +50,7 @@ To simplify reviewing changes in a large pull request, you can filter the diff t ## Reasons diffs will not display - You've exceeded the total limit of files or certain file types. For more information, see "[AUTOTITLE](/repositories/creating-and-managing-repositories/about-repositories#limits-for-viewing-content-and-diffs-in-a-repository)." -- Your file matches a rule in the repository's *.gitattributes* file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)." +- Your file matches a rule in the repository's _.gitattributes_ file to block that file from displaying by default. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github)." ## Three-dot and two-dot Git diff comparisons diff --git a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md index 753c70bfab..41a454b2c3 100644 --- a/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request.md @@ -31,7 +31,7 @@ If the default parent repository isn't correct, you can change both the parent r ![Screenshot of a pull request. The dropdown to edit the compare branch is expanded.](/assets/images/help/pull_requests/pull-request-review-edit-branch.png) -When thinking about branches, remember that the *base branch* is **where** changes should be applied, the *head branch* contains **what** you would like to be applied. +When thinking about branches, remember that the _base branch_ is **where** changes should be applied, the _head branch_ contains **what** you would like to be applied. When you change the base repository, you also change notifications for the pull request. Everyone that can push to the base repository will receive an email notification and see the new pull request in their dashboard the next time they sign in. diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md index 6a789812b4..038632fe00 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews.md @@ -17,7 +17,7 @@ shortTitle: About PR reviews --- ## About pull request reviews -After a pull request is opened, anyone with *read* access can review and comment on the changes it proposes. You can also suggest specific changes to lines of code, which the author can apply directly from the pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." +After a pull request is opened, anyone with _read_ access can review and comment on the changes it proposes. You can also suggest specific changes to lines of code, which the author can apply directly from the pull request. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)." {% ifversion pull-request-approval-limit %}{% data reusables.pull_requests.code-review-limits %}{% endif %} @@ -52,7 +52,7 @@ You can view all of the reviews a pull request has received in the Conversation {% tip %} -**Tip**: If necessary, people with *admin* or *write* access to a repository can dismiss a pull request review. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." +**Tip**: If necessary, people with _admin_ or _write_ access to a repository can dismiss a pull request review. For more information, see "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/dismissing-a-pull-request-review)." {% endtip %} 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 e6760ab033..42331c3ce5 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 @@ -94,7 +94,7 @@ Anyone can work with a previously opened pull request to continue working on it, ## Error: Failed to push some refs -The remote `refs/pull/` namespace is *read-only*. If you try to push any commits there, you'll see this error: +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' diff --git a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md index e695df29e4..335692bf14 100644 --- a/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md +++ b/content/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/finding-changed-methods-and-functions-in-a-pull-request.md @@ -35,7 +35,7 @@ The summary list of methods and functions is created from these supported file t {% note %} - **Note:** If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in *.go*, *.js*, *.ts*, *.py*, *.php*, and *.rb* files appear in the drop-down menu. + **Note:** If you don't see the functions or methods you expected, confirm that your code compiles and doesn't contain errors. Only functions and methods changed in this pull request and found in _.go_, _.js_, _.ts_, _.py_, _.php_, and _.rb_ files appear in the drop-down menu. {% endnote %} diff --git a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md index 1a79df32a2..17bed3c5f0 100644 --- a/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md +++ b/content/pull-requests/collaborating-with-pull-requests/working-with-forks/configuring-a-remote-repository-for-a-fork.md @@ -23,7 +23,7 @@ shortTitle: Configure a remote repository > 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. +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 ``` 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 3d1b376b27..cb65045637 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 @@ -75,7 +75,7 @@ $ git push upstream B:recover-B # Push local B to new upstream branch, creating new reference to commit ``` -Now, *you* can run: +Now, _you_ can run: ```shell $ git fetch upstream recover-B diff --git a/content/repositories/creating-and-managing-repositories/about-repositories.md b/content/repositories/creating-and-managing-repositories/about-repositories.md index 7398a6af91..31a6d6c574 100644 --- a/content/repositories/creating-and-managing-repositories/about-repositories.md +++ b/content/repositories/creating-and-managing-repositories/about-repositories.md @@ -119,7 +119,7 @@ Most of the limits below affect both {% data variables.product.product_name %} a ### Text limits -Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, *etc.*). +Text files over **512 KB** are always displayed as plain text. Code is not syntax highlighted, and prose files are not converted to HTML (such as Markdown, AsciiDoc, _etc._). Text files over **5 MB** are only available through their raw URLs, which are served through `{% data variables.product.raw_github_com %}`; for example, `https://{% data variables.product.raw_github_com %}/octocat/Spoon-Knife/master/index.html`. Click the **Raw** button to get the raw URL for a file. @@ -127,10 +127,10 @@ Text files over **5 MB** are only available through their raw URLs, which are se Because diffs can become very large, we impose these limits on diffs for commits, pull requests, and compare views: -- In a pull request, no total diff may exceed *20,000 lines that you can load* or *1 MB* of raw diff data. -- No single file's diff may exceed *20,000 lines that you can load* or *500 KB* of raw diff data. *Four hundred lines* and *20 KB* are automatically loaded for a single file. -- The maximum number of files in a single diff is limited to *300*. -- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to *25*. +- In a pull request, no total diff may exceed _20,000 lines that you can load_ or _1 MB_ of raw diff data. +- No single file's diff may exceed _20,000 lines that you can load_ or _500 KB_ of raw diff data. _Four hundred lines_ and _20 KB_ are automatically loaded for a single file. +- The maximum number of files in a single diff is limited to _300_. +- The maximum number of renderable files (such as images, PDFs, and GeoJSON files) in a single diff is limited to _25_. Some portions of a limited diff may be displayed, but anything exceeding the limit is not shown. diff --git a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md index 7595a5ccaa..64e078e43e 100644 --- a/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md +++ b/content/repositories/creating-and-managing-repositories/creating-a-new-repository.md @@ -45,7 +45,7 @@ topics: {% data reusables.repositories.choose-repo-visibility %} 1. If you're not using a template, there are a number of optional items you can pre-populate your repository with. If you're importing an existing repository to {% data variables.product.product_name %}, don't choose any of these options, as you may introduce a merge conflict. You can add or create new files using the user interface or choose to add new files using the command line later. For more information, see "[AUTOTITLE](/migrations/importing-source-code/using-the-command-line-to-import-source-code/importing-an-external-git-repository-using-the-command-line)," "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository#adding-a-file-to-a-repository-using-the-command-line)," and "[AUTOTITLE](/pull-requests/collaborating-with-pull-requests/addressing-merge-conflicts)." - You can create a README, which is a document describing your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes)." - - You can create a *.gitignore* file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %} + - You can create a _.gitignore_ file, which is a set of ignore rules. For more information, see "[AUTOTITLE](/get-started/getting-started-with-git/ignoring-files)."{% ifversion fpt or ghec %} - You can choose to add a software license for your project. For more information, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."{% endif %} {% data reusables.repositories.select-marketplace-apps %} {% data reusables.repositories.create-repo %} diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md index 650838e3a5..5a64bdd329 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners.md @@ -38,7 +38,7 @@ To use a CODEOWNERS file, create a new file called `CODEOWNERS` in the root, `do Each CODEOWNERS file assigns the code owners for a single branch in the repository. Thus, you can assign different code owners for different branches, such as `@octo-org/codeowners-team` for a code base on the default branch and `@octocat` for a {% data variables.product.prodname_pages %} site on the `gh-pages` branch. -For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for *.js* files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to *.js* files is opened between the head branch and `gh-pages`. +For code owners to receive review requests, the CODEOWNERS file must be on the base branch of the pull request. For example, if you assign `@octocat` as the code owner for _.js_ files on the `gh-pages` branch of your repository, `@octocat` will receive review requests when a pull request with changes to _.js_ files is opened between the head branch and `gh-pages`. ## CODEOWNERS file size @@ -50,7 +50,7 @@ To reduce the size of your CODEOWNERS file, consider using wildcard patterns to {% warning %} -**Warning:** There are some syntax rules for gitignore files that *do not work* in CODEOWNERS files: +**Warning:** There are some syntax rules for gitignore files that _do not work_ in CODEOWNERS files: - Escaping a pattern starting with `#` using `\` so it is treated as a pattern and not a comment - Using `!` to negate a pattern - Using `[ ]` to define a character range diff --git a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md index 6dec602a23..7bfb0d4648 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository.md @@ -79,9 +79,9 @@ When you search by a family license, your results will include all licenses in t ## Detecting a license -[The open source Ruby gem Licensee](https://github.com/licensee/licensee) compares the repository's *LICENSE* file to a short list of known licenses. Licensee also provides the [Licenses API](/rest/licenses) and [gives us insight into how repositories on {% data variables.product.product_name %} are licensed](https://github.com/blog/1964-open-source-license-usage-on-github-com). If your repository is using a license that isn't listed on the [Choose a License website](https://choosealicense.com/appendix/), you can [request including the license](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). +[The open source Ruby gem Licensee](https://github.com/licensee/licensee) compares the repository's _LICENSE_ file to a short list of known licenses. Licensee also provides the [Licenses API](/rest/licenses) and [gives us insight into how repositories on {% data variables.product.product_name %} are licensed](https://github.com/blog/1964-open-source-license-usage-on-github-com). If your repository is using a license that isn't listed on the [Choose a License website](https://choosealicense.com/appendix/), you can [request including the license](https://github.com/github/choosealicense.com/blob/gh-pages/CONTRIBUTING.md#adding-a-license). -If your repository is using a license that is listed on the Choose a License website and it's not displaying clearly at the top of the repository page, it may contain multiple licenses or other complexity. To have your license detected, simplify your *LICENSE* file and note the complexity somewhere else, such as your repository's *README* file. +If your repository is using a license that is listed on the Choose a License website and it's not displaying clearly at the top of the repository page, it may contain multiple licenses or other complexity. To have your license detected, simplify your _LICENSE_ file and note the complexity somewhere else, such as your repository's _README_ file. ## Applying a license to a repository with an existing license diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md index 7dbee2dcc7..7d405bb4be 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-git-lfs-objects-in-archives-of-your-repository.md @@ -14,11 +14,11 @@ redirect_from: --- ## About {% data variables.large_files.product_name_short %} objects in archives -{% data variables.product.product_name %} creates [source code archives](/repositories/working-with-files/using-files/downloading-source-code-archives) of your repository in the form of ZIP files and tarballs. People can download these archives on the main page of your repository or as release assets. By default, {% data variables.large_files.product_name_short %} objects are not included in these archives, only the pointer files to these objects. To improve the usability of archives for your repository, you can choose to include the {% data variables.large_files.product_name_short %} objects instead. To be included, the {% data variables.large_files.product_name_short %} objects must be covered by tracking rules in a *.gitattributes* file that has been committed to the repository. +{% data variables.product.product_name %} creates [source code archives](/repositories/working-with-files/using-files/downloading-source-code-archives) of your repository in the form of ZIP files and tarballs. People can download these archives on the main page of your repository or as release assets. By default, {% data variables.large_files.product_name_short %} objects are not included in these archives, only the pointer files to these objects. To improve the usability of archives for your repository, you can choose to include the {% data variables.large_files.product_name_short %} objects instead. To be included, the {% data variables.large_files.product_name_short %} objects must be covered by tracking rules in a _.gitattributes_ file that has been committed to the repository. If you choose to include {% data variables.large_files.product_name_short %} objects in archives of your repository, every download of those archives will count towards bandwidth usage for your account. Each account receives {% data variables.large_files.initial_bandwidth_quota %} per month of bandwidth for free, and you can pay for additional usage. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-storage-and-bandwidth-usage)" and "[AUTOTITLE](/billing/managing-billing-for-git-large-file-storage)." -If you use an external LFS server (configured in your *.lfsconfig*), those LFS files will not be included in archives of the repository. The archive will only contain files that have been committed to {% data variables.product.product_name %}. +If you use an external LFS server (configured in your _.lfsconfig_), those LFS files will not be included in archives of the repository. The archive will only contain files that have been committed to {% data variables.product.product_name %}. ## Managing {% data variables.large_files.product_name_short %} objects in archives diff --git a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md index dcf9dde474..4a675685df 100644 --- a/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md +++ b/content/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-the-push-policy-for-your-repository.md @@ -30,4 +30,4 @@ The push policy also blocks the Git command: `git push --mirror`. This is a pote 1. Under "Pushes", select **Limit how many branches and tags can be updated in a single push**. 1. After "Up to", type the number of branches and tags you want to limit in a single push. Lower numbers are more restrictive of which pushes are allowed, and higher numbers are less restrictive but have more potential for being destructive. - We recommend the default maximum of `5` branch or tag updates allowed in one push. The minimum value is `2`, because Git requires two branch updates to rename a branch in a single push: *delete branch* and *create branch*. + We recommend the default maximum of `5` branch or tag updates allowed in one push. The minimum value is `2`, because Git requires two branch updates to rename a branch in a single push: _delete branch_ and _create branch_. diff --git a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md index 11ac9139bc..00fdbd3fd2 100644 --- a/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md +++ b/content/repositories/working-with-files/managing-files/customizing-how-changed-files-appear-on-github.md @@ -14,12 +14,12 @@ topics: - Repositories shortTitle: How changed files appear --- -Use a *.gitattributes* file to mark files that match a given "pattern" with the specified attributes. A *.gitattributes* file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation. +Use a _.gitattributes_ file to mark files that match a given "pattern" with the specified attributes. A _.gitattributes_ file uses the same rules for matching as _.gitignore_ files. For more information, see [PATTERN FORMAT](https://www.git-scm.com/docs/gitignore#_pattern_format) in the Git documentation. -1. Unless the *.gitattributes* file already exists, create a *.gitattributes* file in the root of the repository. +1. Unless the _.gitattributes_ file already exists, create a _.gitattributes_ file in the root of the repository. 2. Use the `linguist-generated` attribute to mark or unmark paths that you would like to be ignored for the repository's language statistics and hidden by default in diffs. - For example, to mark `search/index.json` as a generated file, add this line to *.gitattributes*: + For example, to mark `search/index.json` as a generated file, add this line to _.gitattributes_: ``` search/index.json linguist-generated=true diff --git a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md index a3c374ec71..5a614f3d9a 100644 --- a/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage.md @@ -36,15 +36,15 @@ If there are existing files in your repository that you'd like to use {% data va $ git {% data variables.large_files.command_name %} track "*.psd" > Adding path *.psd ``` - Every file type you want to associate with {% data variables.large_files.product_name_short %} will need to be added with `git {% data variables.large_files.command_name %} track`. This command amends your repository's *.gitattributes* file and associates large files with {% data variables.large_files.product_name_short %}. + Every file type you want to associate with {% data variables.large_files.product_name_short %} will need to be added with `git {% data variables.large_files.command_name %} track`. This command amends your repository's _.gitattributes_ file and associates large files with {% data variables.large_files.product_name_short %}. {% note %} - **Note:** We strongly suggest that you commit your local *.gitattributes* file into your repository. + **Note:** We strongly suggest that you commit your local _.gitattributes_ file into your repository. - - Relying on a global *.gitattributes* file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. - - Including the *.gitattributes* file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. - - Including the *.gitattributes* file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. + - Relying on a global _.gitattributes_ file associated with {% data variables.large_files.product_name_short %} may cause conflicts when contributing to other Git projects. + - Including the _.gitattributes_ file in the repository allows people creating forks or fresh clones to more easily collaborate using {% data variables.large_files.product_name_short %}. + - Including the _.gitattributes_ file in the repository allows {% data variables.large_files.product_name_short %} objects to optionally be included in ZIP file and tarball archives. {% endnote %} 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 d89b86e8e9..cf6e5e40b0 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 @@ -61,7 +61,7 @@ shortTitle: Install Git LFS {% endtip %} 2. On your computer, locate the downloaded file. -3. Double click on the file called *git-lfs-windows-1.X.X.exe*, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}. +3. Double click on the file called _git-lfs-windows-1.X.X.exe_, where 1.X.X is replaced with the Git LFS version you downloaded. When you open this file Windows will run a setup wizard to install {% data variables.large_files.product_name_short %}. {% data reusables.command_line.open_the_multi_os_terminal %} 5. Verify that the installation was successful: ```shell diff --git a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md index 239269c189..2e23d08c70 100644 --- a/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md +++ b/content/repositories/working-with-files/managing-large-files/removing-files-from-git-large-file-storage.md @@ -15,15 +15,15 @@ shortTitle: Remove files ## Removing a single file 1. Remove the file from the repository's Git history using either the `filter-repo` command or BFG Repo-Cleaner. For detailed information on using these, see "[AUTOTITLE](/authentication/keeping-your-account-and-data-secure/removing-sensitive-data-from-a-repository)." -2. Navigate to your *.gitattributes* file. +2. Navigate to your _.gitattributes_ file. {% note %} - **Note:** Your *.gitattributes* file is generally saved within your local repository. In some cases, you may have created a global *.gitattributes* file that contains all of your {% data variables.large_files.product_name_short %} associations. + **Note:** Your _.gitattributes_ file is generally saved within your local repository. In some cases, you may have created a global _.gitattributes_ file that contains all of your {% data variables.large_files.product_name_short %} associations. {% endnote %} -3. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the *.gitattributes* file. -4. Save and exit the *.gitattributes* file. +3. Find and remove the associated {% data variables.large_files.product_name_short %} tracking rule within the _.gitattributes_ file. +4. Save and exit the _.gitattributes_ file. ## Removing all files within a {% data variables.large_files.product_name_short %} repository diff --git a/content/repositories/working-with-files/using-files/navigating-code-on-github.md b/content/repositories/working-with-files/using-files/navigating-code-on-github.md index 42587f6993..76c80a26be 100644 --- a/content/repositories/working-with-files/using-files/navigating-code-on-github.md +++ b/content/repositories/working-with-files/using-files/navigating-code-on-github.md @@ -47,7 +47,7 @@ You do not need to configure anything in your repository to enable code navigati To learn more about these approaches, see "[Precise and search-based navigation](#precise-and-search-based-navigation)." -Future releases will add *precise code navigation* for more languages, which is a code navigation approach that can give more accurate results. +Future releases will add _precise code navigation_ for more languages, which is a code navigation approach that can give more accurate results. {% ifversion code-search-code-view %}You can use keyboard shortcuts to navigate within a code file. For more information, see "[AUTOTITLE](/get-started/using-github/keyboard-shortcuts#navigating-within-code-files)."{% endif %} @@ -85,7 +85,7 @@ You can find all references for a function or method within the same repository ## Precise and search-based navigation -Certain languages supported by {% data variables.product.prodname_dotcom %} have access to *precise code navigation*, which uses an algorithm (based on the open source [`stack-graphs`](https://github.com/github/stack-graphs) library) that resolves definitions and references based on the set of classes, functions, and imported definitions that are visible at any given point in your code. Other languages use *search-based code navigation*, which searches all definitions and references across a repository to find entities with a given name. Both strategies are effective at finding results and both make sure to avoid inappropriate results such as comments, but precise code navigation can give more accurate results, especially when a repository contains multiple methods or functions with the same name. +Certain languages supported by {% data variables.product.prodname_dotcom %} have access to _precise code navigation_, which uses an algorithm (based on the open source [`stack-graphs`](https://github.com/github/stack-graphs) library) that resolves definitions and references based on the set of classes, functions, and imported definitions that are visible at any given point in your code. Other languages use _search-based code navigation_, which searches all definitions and references across a repository to find entities with a given name. Both strategies are effective at finding results and both make sure to avoid inappropriate results such as comments, but precise code navigation can give more accurate results, especially when a repository contains multiple methods or functions with the same name. If you don't see the results you expect from a precise code navigation query, you can click on the "search-based" link in the displayed popover to perform search-based navigation. 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 1c2a024539..26b391a93b 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 @@ -75,7 +75,7 @@ You can visually compare images in three different modes: [2-up](#2-up), [swipe] ## 3D File Viewer -{% data variables.product.product_name %} can host and render 3D files with the *.stl* extension. +{% data variables.product.product_name %} can host and render 3D files with the _.stl_ extension. When looking directly at an STL file on {% data variables.product.product_name %} you can: @@ -134,7 +134,7 @@ You can embed ASCII STL syntax directly in Markdown. For more information, see " ## Rendering CSV and TSV data -{% data variables.product.prodname_dotcom %} supports rendering tabular data in the form of *.csv* (comma-separated) and .*tsv* (tab-separated) files. +{% data variables.product.prodname_dotcom %} supports rendering tabular data in the form of _.csv_ (comma-separated) and ._tsv_ (tab-separated) files. ![Screenshot of a rendered CSV file, with data shown in a table format.](/assets/images/help/repository/rendered_csv.png) @@ -166,7 +166,7 @@ Currently, links within PDFs are ignored. ## Rendering differences in prose documents -Commits and pull requests that include prose documents have the ability to represent those documents with *source* and *rendered* views. +Commits and pull requests that include prose documents have the ability to represent those documents with _source_ and _rendered_ views. The source view shows the raw text that has been typed, while the rendered view shows how that text would look once it's rendered on {% data variables.product.product_name %}. For example, @@ -207,7 +207,7 @@ another, we'd show a tooltip like this: ### Commenting on changes [Commit comments](/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request) can only -be added to files within the *source* view, on a line-by-line basis. +be added to files within the _source_ view, on a line-by-line basis. ### Linking to headers @@ -310,11 +310,11 @@ It may still be possible to render the data by converting the `.geojson` file to ## Working with Jupyter Notebook files on {% data variables.product.prodname_dotcom %} -When you add Jupyter Notebook or IPython Notebook files with a *.ipynb* extension on {% data variables.location.product_location %}, they will render as static HTML files in your repository. +When you add Jupyter Notebook or IPython Notebook files with a _.ipynb_ extension on {% data variables.location.product_location %}, they will render as static HTML files in your repository. -The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.location.product_location %}. For an example, see [*Linking and Interactions.ipynb*](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). +The interactive features of the notebook, such as custom JavaScript plots, will not work in your repository on {% data variables.location.product_location %}. For an example, see [_Linking and Interactions.ipynb_](https://github.com/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb). -To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [*Linking and Interactions.ipynb*](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. +To view your Jupyter notebook with JavaScript content rendered or to share your notebook files with others you can use [nbviewer](https://nbviewer.jupyter.org/). For an example, see [_Linking and Interactions.ipynb_](https://nbviewer.jupyter.org/github/bokeh/bokeh-notebooks/blob/main/tutorial/06%20-%20Linking%20and%20Interactions.ipynb) rendered on nbviewer. To view a fully interactive version of your Jupyter Notebook, you can set up a notebook server locally. For more information, see [Jupyter's official documentation](http://jupyter.readthedocs.io/en/latest/index.html). diff --git a/content/rest/enterprise-admin/pre-receive-hooks.md b/content/rest/enterprise-admin/pre-receive-hooks.md index ed612fe71b..e6371b2582 100644 --- a/content/rest/enterprise-admin/pre-receive-hooks.md +++ b/content/rest/enterprise-admin/pre-receive-hooks.md @@ -27,7 +27,7 @@ These endpoints are only available to [authenticated](/rest/overview/authenticat | `enforcement` | `string` | The state of enforcement for this hook. | | `allow_downstream_configuration` | `boolean` | Whether enforcement can be overridden at the org or repo level. | -Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject +Possible values for _enforcement_ are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. diff --git a/content/rest/enterprise-admin/repo-pre-receive-hooks.md b/content/rest/enterprise-admin/repo-pre-receive-hooks.md index 8e57213543..f682130dc6 100644 --- a/content/rest/enterprise-admin/repo-pre-receive-hooks.md +++ b/content/rest/enterprise-admin/repo-pre-receive-hooks.md @@ -22,7 +22,7 @@ autogenerated: rest | `enforcement` | `string` | The state of enforcement for the hook on this repository. | | `configuration_url` | `string` | URL for the endpoint where enforcement is set. | -Possible values for *enforcement* are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. +Possible values for _enforcement_ are `enabled`, `disabled` and`testing`. `disabled` indicates the pre-receive hook will not run. `enabled` indicates it will run and reject any pushes that result in a non-zero status. `testing` means the script will run but will not cause any pushes to be rejected. `configuration_url` may be a link to this repository, it's organization owner or global configuration. Authorization to access the endpoint at `configuration_url` is determined at the owner or site admin level. diff --git a/content/rest/guides/best-practices-for-integrators.md b/content/rest/guides/best-practices-for-integrators.md index 4f2816b946..37c83daebe 100644 --- a/content/rest/guides/best-practices-for-integrators.md +++ b/content/rest/guides/best-practices-for-integrators.md @@ -15,17 +15,17 @@ shortTitle: Integrator best practices --- -Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users *and* ensure that it's reliably interacting with the API. +Interested in integrating with the GitHub platform? [You're in good company](https://github.com/integrations). This guide will help you build an app that provides the best experience for your users _and_ ensure that it's reliably interacting with the API. ## Secure payloads delivered from GitHub -It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking *any* information is not good. Some information that might be sensitive include committer email address or the names of private repositories. +It's very important that you secure [the payloads sent from GitHub][event-types]. Although no personal information (like passwords) is ever transmitted in a payload, leaking _any_ information is not good. Some information that might be sensitive include committer email address or the names of private repositories. There are several steps you can take to secure receipt of payloads delivered by GitHub: 1. Ensure that your receiving server is on an HTTPS connection. By default, GitHub will verify SSL certificates when delivering payloads.{% ifversion fpt or ghec %} 1. You can add [the IP address we use when delivering hooks](/authentication/keeping-your-account-and-data-secure/about-githubs-ip-addresses) to your server's allow list. To ensure that you're always checking the right IP address, you can [use the `/meta` endpoint](/rest/meta#meta) to find the address we use.{% endif %} -1. Provide [a secret token](/webhooks-and-events/webhooks/securing-your-webhooks) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token *per user* of your service. That way, if one token is compromised, no other user would be affected. +1. Provide [a secret token](/webhooks-and-events/webhooks/securing-your-webhooks) to ensure payloads are definitely coming from GitHub. By enforcing a secret token, you're ensuring that any data received by your server is absolutely coming from GitHub. Ideally, you should provide a different secret token _per user_ of your service. That way, if one token is compromised, no other user would be affected. ## Favor asynchronous work over synchronous diff --git a/content/rest/guides/building-a-ci-server.md b/content/rest/guides/building-a-ci-server.md index 5e777cd935..784d244aa7 100644 --- a/content/rest/guides/building-a-ci-server.md +++ b/content/rest/guides/building-a-ci-server.md @@ -77,7 +77,7 @@ Great! Click on **Let me select individual events**, and select the following: - Pull Request These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action -occurs. Let's update our server to *just* handle the Pull Request scenario right now: +occurs. Let's update our server to _just_ handle the Pull Request scenario right now: ``` ruby post '/event_handler' do diff --git a/content/rest/guides/delivering-deployments.md b/content/rest/guides/delivering-deployments.md index c8a3d33791..09d72d4c70 100644 --- a/content/rest/guides/delivering-deployments.md +++ b/content/rest/guides/delivering-deployments.md @@ -79,7 +79,7 @@ Great! Click on **Let me select individual events.**, and select the following: - Pull Request These are the events {% data variables.product.product_name %} will send to our server whenever the relevant action -occurs. We'll configure our server to *just* handle when pull requests are merged +occurs. We'll configure our server to _just_ handle when pull requests are merged right now: ``` ruby diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index fa48f47c6f..7489e05850 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -238,7 +238,7 @@ Resources may also send custom validation errors (where `code` is `custom`). Cus ## HTTP redirects The {% data variables.product.product_name %} REST API uses HTTP redirection where appropriate. Clients should assume that any -request may result in a redirection. Receiving an HTTP redirection is *not* an +request may result in a redirection. Receiving an HTTP redirection is _not_ an error and clients should follow that redirect. Redirect responses will have a `Location` header field which contains the URI of the resource to which the client should repeat the requests. diff --git a/content/rest/overview/troubleshooting.md b/content/rest/overview/troubleshooting.md index 413f6570c7..e284c0c7dd 100644 --- a/content/rest/overview/troubleshooting.md +++ b/content/rest/overview/troubleshooting.md @@ -49,7 +49,7 @@ pagination. If you're making requests and receiving an incomplete set of results probably only seeing the first page. You'll need to request the remaining pages in order to get more results. -It's important to *not* try and guess the format of the pagination URL. Not every +It's important to _not_ try and guess the format of the pagination URL. Not every API call uses the same structure. Instead, extract the pagination information from the link header, which is returned with every request. For more information about pagination, see "[AUTOTITLE](/rest/guides/using-pagination-in-the-rest-api)." diff --git a/content/search-github/searching-on-github/searching-code.md b/content/search-github/searching-on-github/searching-code.md index 7ae19b1845..b6b291ebf3 100644 --- a/content/search-github/searching-on-github/searching-code.md +++ b/content/search-github/searching-on-github/searching-code.md @@ -104,8 +104,8 @@ The `filename` qualifier matches code files with a certain filename. You can als | Qualifier | Example | ------------- | ------------- | filename:FILENAME | [**filename:linguist**](https://github.com/search?utf8=%E2%9C%93&q=filename%3Alinguist&type=Code) matches files named "linguist." -| filename:FILENAME | [**filename:.vimrc commands**](https://github.com/search?q=filename%3A.vimrc+commands&type=Code) matches *.vimrc* files with the word "commands." -| filename:FILENAME | [**filename:test_helper path:test language:ruby**](https://github.com/search?q=minitest+filename%3Atest_helper+path%3Atest+language%3Aruby&type=Code) matches Ruby files named *test_helper* within the *test* directory. +| filename:FILENAME | [**filename:.vimrc commands**](https://github.com/search?q=filename%3A.vimrc+commands&type=Code) matches _.vimrc_ files with the word "commands." +| filename:FILENAME | [**filename:test_helper path:test language:ruby**](https://github.com/search?q=minitest+filename%3Atest_helper+path%3Atest+language%3Aruby&type=Code) matches Ruby files named _test_helper_ within the _test_ directory. ## Search by file extension diff --git a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md index c675eeba56..e97828a065 100644 --- a/content/search-github/searching-on-github/searching-issues-and-pull-requests.md +++ b/content/search-github/searching-on-github/searching-issues-and-pull-requests.md @@ -174,7 +174,7 @@ You can narrow your results by labels, using the `label` qualifier. Since issues | Qualifier | Example | ------------- | ------------- | label:LABEL | [**label:"help wanted" language:ruby**](https://github.com/search?utf8=%E2%9C%93&q=label%3A%22help+wanted%22+language%3Aruby&type=Issues) matches issues with the label "help wanted" that are in Ruby repositories. -| `in:body` -label:LABEL label:LABEL | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) matches issues with the word "broken" in the body, that lack the label "bug", but *do* have the label "priority." +| `in:body` -label:LABEL label:LABEL | [**broken in:body -label:bug label:priority**](https://github.com/search?q=broken+in%3Abody+-label%3Abug+label%3Apriority&type=Issues) matches issues with the word "broken" in the body, that lack the label "bug", but _do_ have the label "priority." | label:LABEL label:LABEL | [**label:bug label:resolved**](https://github.com/search?l=&q=label%3Abug+label%3Aresolved&type=Issues) matches issues with the labels "bug" and "resolved." | label:LABEL,LABEL | [**label:bug,resolved**](https://github.com/search?q=label%3Abug%2Cresolved&type=Issues) matches issues with the label "bug" or the label "resolved." diff --git a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md index 3a3c906740..e4394d1f63 100644 --- a/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md +++ b/content/site-policy/acceptable-use-policies/github-acceptable-use-policies.md @@ -95,7 +95,7 @@ Any person, entity, or service collecting data from the Service must comply with The Service's bandwidth limitations vary based on the features you use. If we determine your bandwidth usage to be significantly excessive in relation to other users of similar features, we reserve the right to suspend your Account, throttle your file hosting, or otherwise limit your activity until you can reduce your bandwidth consumption. We also reserve the right—after providing advance notice—to delete repositories that we determine to be placing undue strain on our infrastructure. For guidance on acceptable use of object storage in repositories, refer to "[AUTOTITLE](/repositories/working-with-files/managing-large-files/about-large-files-on-github)". For more details on specific features' bandwidth limitations, see the [GitHub Additional Product Terms](/site-policy/github-terms/github-terms-for-additional-products-and-features). ## 10. Advertising on GitHub -**Short version:** *We do not generally prohibit use of GitHub for advertising. However, we expect our users to follow certain limitations, so GitHub does not become a spam haven. No one wants that.* +**Short version:** _We do not generally prohibit use of GitHub for advertising. However, we expect our users to follow certain limitations, so GitHub does not become a spam haven. No one wants that._ While we understand that you may want to promote your Content by posting supporters' names or logos in your Account, the primary focus of the Content posted in or through your Account to the Service should not be advertising or promotional marketing. This includes Content posted in or through Pages, Packages, repositories, and all other parts of the Service. You may include static images, links, and promotional text in the README documents or project description sections associated with your Account, but they must be related to the project you are hosting on GitHub. You may not advertise in other Users' Accounts, such as by posting monetized or excessive bulk content in issues. diff --git a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md index 48c8cf1628..c76b51c66b 100644 --- a/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md +++ b/content/site-policy/acceptable-use-policies/github-active-malware-or-exploits.md @@ -24,4 +24,4 @@ Being part of a community includes not taking advantage of other members of the - Clearly identify and describe any potentially harmful content in a disclaimer in the project’s README.md file or source code comments. - Provide a preferred contact method for any 3rd party abuse inquiries through a SECURITY.md file in the repository (e.g. "Please create an issue on this repository for any questions or concerns"). Such a contact method allows 3rd parties to reach out to project maintainers directly and potentially resolve concerns without the need to file abuse reports. - *GitHub considers the npm registry to be a platform used primarily for installation and run-time use of code, and not for research.* + _GitHub considers the npm registry to be a platform used primarily for installation and run-time use of code, and not for research._ diff --git a/content/site-policy/content-removal-policies/dmca-takedown-policy.md b/content/site-policy/content-removal-policies/dmca-takedown-policy.md index f43cd8f237..c58b3f28d2 100644 --- a/content/site-policy/content-removal-policies/dmca-takedown-policy.md +++ b/content/site-policy/content-removal-policies/dmca-takedown-policy.md @@ -53,11 +53,11 @@ Here are the basic steps in the process. 3. **GitHub Asks User to Make Changes.** If the notice alleges that the entire contents of a repository infringe, or a package infringes, we will skip to Step 6 and disable the entire repository or package expeditiously. Otherwise, because GitHub cannot disable access to specific files within a repository, we will contact the user who created the repository and give them approximately 1 business day to delete or modify the content specified in the notice. We'll notify the copyright owner if and when we give the user a chance to make changes. Because packages are immutable, if only part of a package is infringing, GitHub would need to disable the entire package, but we permit reinstatement once the infringing portion is removed. -4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they *must* tell us so within the window of approximately 1 business day. If they don't, we will disable the repository (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. +4. **User Notifies GitHub of Changes.** If the user chooses to make the specified changes, they _must_ tell us so within the window of approximately 1 business day. If they don't, we will disable the repository (as described in Step 6). If the user notifies us that they made changes, we will verify that the changes have been made and then notify the copyright owner. 5. **Copyright Owner Revises or Retracts the Notice.** If the user makes changes, the copyright owner must review them and renew or revise their takedown notice if the changes are insufficient. GitHub will not take any further action unless the copyright owner contacts us to either renew the original takedown notice or submit a revised one. If the copyright owner is satisfied with the changes, they may either submit a formal retraction or else do nothing. GitHub will interpret silence longer than two weeks as an implied retraction of the takedown notice. -6. **GitHub May Disable Access to the Content.** GitHub will disable a user's content if: (i) the copyright owner has alleged copyright over the user's entire repository or package (as noted in Step 3); (ii) the user has not made any changes after being given an opportunity to do so (as noted in Step 4); or (iii) the copyright owner has renewed their takedown notice after the user had a chance to make changes. If the copyright owner chooses instead to *revise* the notice, we will go back to Step 2 and repeat the process as if the revised notice were a new notice. +6. **GitHub May Disable Access to the Content.** GitHub will disable a user's content if: (i) the copyright owner has alleged copyright over the user's entire repository or package (as noted in Step 3); (ii) the user has not made any changes after being given an opportunity to do so (as noted in Step 4); or (iii) the copyright owner has renewed their takedown notice after the user had a chance to make changes. If the copyright owner chooses instead to _revise_ the notice, we will go back to Step 2 and repeat the process as if the revised notice were a new notice. 7. **User May Send A Counter Notice.** We encourage users who have had content disabled to consult with a lawyer about their options. If a user believes that their content was disabled as a result of a mistake or misidentification, they may send us a [counter notice](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice). As with the original notice, we will make sure that the counter notice is sufficiently detailed (as explained in the [how-to guide](/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice)). If it is, we will [post it](#d-transparency) to our [public repository](https://github.com/github/dmca) and pass the notice back to the copyright owner by sending them the link. @@ -67,7 +67,7 @@ Here are the basic steps in the process. One of the best features of GitHub is the ability for users to "fork" one another's repositories. What does that mean? In essence, it means that users can make a copy of a project on GitHub into their own repositories. As the license or the law allows, users can then make changes to that fork to either push back to the main project or just keep as their own variation of a project. Each of these copies is a "[AUTOTITLE](/get-started/quickstart/github-glossary#fork)" of the original repository, which in turn may also be called the "parent" of the fork. -GitHub *will not* automatically disable forks when disabling a parent repository. This is because forks belong to different users, may have been altered in significant ways, and may be licensed or used in a different way that is protected by the fair-use doctrine. GitHub does not conduct any independent investigation into forks. We expect copyright owners to conduct that investigation and, if they believe that the forks are also infringing, expressly include forks in their takedown notice. +GitHub _will not_ automatically disable forks when disabling a parent repository. This is because forks belong to different users, may have been altered in significant ways, and may be licensed or used in a different way that is protected by the fair-use doctrine. GitHub does not conduct any independent investigation into forks. We expect copyright owners to conduct that investigation and, if they believe that the forks are also infringing, expressly include forks in their takedown notice. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks I have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. diff --git a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md index ccd8fb6047..97fefad8c6 100644 --- a/content/site-policy/content-removal-policies/github-private-information-removal-policy.md +++ b/content/site-policy/content-removal-policies/github-private-information-removal-policy.md @@ -15,7 +15,7 @@ We offer this private information removal process as an exceptional service only ## What is Private Information? -For the purposes of this document, “private information” refers to content that (i) should have been kept confidential, *and* (ii) whose public availability poses a specific or targeted security risk to you or your organization. +For the purposes of this document, “private information” refers to content that (i) should have been kept confidential, _and_ (ii) whose public availability poses a specific or targeted security risk to you or your organization. "Security risk" refers to a situation involving exposure to physical danger, identity theft, or increased likelihood of unauthorized access to physical or network facilities. diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md index 23c3e7a356..16aa6cecb8 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-counter-notice.md @@ -21,19 +21,19 @@ As with all legal matters, it is always best to consult with a professional abou ## Before You Start ***Tell the Truth.*** -The DMCA requires that you swear to your counter notice *under penalty of perjury*. It is a federal crime to intentionally lie in a sworn declaration. (*See* [U.S. Code, Title 18, Section 1621](https://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm).) Submitting false information could also result in civil liability—that is, you could get sued for money damages. +The DMCA requires that you swear to your counter notice _under penalty of perjury_. It is a federal crime to intentionally lie in a sworn declaration. (_See_ [U.S. Code, Title 18, Section 1621](https://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm).) Submitting false information could also result in civil liability—that is, you could get sued for money damages. ***Investigate.*** Submitting a DMCA counter notice can have real legal consequences. If the complaining party disagrees that their takedown notice was mistaken, they might decide to file a lawsuit against you to keep the content disabled. You should conduct a thorough investigation into the allegations made in the takedown notice and probably talk to a lawyer before submitting a counter notice. ***You Must Have a Good Reason to Submit a Counter Notice.*** -In order to file a counter notice, you must have "a good faith belief that the material was removed or disabled as a result of mistake or misidentification of the material to be removed or disabled." ([U.S. Code, Title 17, Section 512(g)](https://www.copyright.gov/title17/92chap5.html#512).) Whether you decide to explain why you believe there was a mistake is up to you and your lawyer, but you *do* need to identify a mistake before you submit a counter notice. In the past, we have received counter notices citing mistakes in the takedown notice such as: the complaining party doesn't have the copyright; I have a license; the code has been released under an open-source license that permits my use; or the complaint doesn't account for the fact that my use is protected by the fair-use doctrine. Of course, there could be other defects with the takedown notice. +In order to file a counter notice, you must have "a good faith belief that the material was removed or disabled as a result of mistake or misidentification of the material to be removed or disabled." ([U.S. Code, Title 17, Section 512(g)](https://www.copyright.gov/title17/92chap5.html#512).) Whether you decide to explain why you believe there was a mistake is up to you and your lawyer, but you _do_ need to identify a mistake before you submit a counter notice. In the past, we have received counter notices citing mistakes in the takedown notice such as: the complaining party doesn't have the copyright; I have a license; the code has been released under an open-source license that permits my use; or the complaint doesn't account for the fact that my use is protected by the fair-use doctrine. Of course, there could be other defects with the takedown notice. ***Copyright Laws Are Complicated.*** Sometimes a takedown notice might allege infringement in a way that seems odd or indirect. Copyright laws are complicated and can lead to some unexpected results. In some cases a takedown notice might allege that your source code infringes because of what it can do after it is compiled and run. For example: - The notice may claim that your software is used to [circumvent access controls](https://www.copyright.gov/title17/92chap12.html) to copyrighted works. - [Sometimes](https://www.copyright.gov/docs/mgm/) distributing software can be copyright infringement, if you induce end users to use the software to infringe copyrighted works. - - A copyright complaint might also be based on [non-literal copying](https://en.wikipedia.org/wiki/Substantial_similarity) of design elements in the software, rather than the source code itself — in other words, someone has sent a notice saying they think your *design* looks too similar to theirs. + - A copyright complaint might also be based on [non-literal copying](https://en.wikipedia.org/wiki/Substantial_similarity) of design elements in the software, rather than the source code itself — in other words, someone has sent a notice saying they think your _design_ looks too similar to theirs. These are just a few examples of the complexities of copyright law. Since there are many nuances to the law and some unsettled questions in these types of cases, it is especially important to get professional advice if the infringement allegations do not seem straightforward. @@ -73,7 +73,7 @@ The fastest way to get a response is to enter your information and answer all th You can also send an email notification to . You may include an attachment if you like, but please also include a plain-text version of your letter in the body of your message. -If you must send your notice by physical mail, you can do that too, but it will take *substantially* longer for us to receive and respond to it—and the 10-14 day waiting period starts from when we *receive* your counter notice. Notices we receive via plain-text email have a much faster turnaround than PDF attachments or physical mail. If you still wish to mail us your notice, our physical address is: +If you must send your notice by physical mail, you can do that too, but it will take _substantially_ longer for us to receive and respond to it—and the 10-14 day waiting period starts from when we _receive_ your counter notice. Notices we receive via plain-text email have a much faster turnaround than PDF attachments or physical mail. If you still wish to mail us your notice, our physical address is: ``` GitHub, Inc diff --git a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md index 7194e89a58..9cf88d5162 100644 --- a/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/site-policy/content-removal-policies/guide-to-submitting-a-dmca-takedown-notice.md @@ -20,7 +20,7 @@ As with all legal matters, it is always best to consult with a professional abou ## Before You Start -***Tell the Truth.*** The DMCA requires that you swear to the facts in your copyright complaint *under penalty of perjury*. It is a federal crime to intentionally lie in a sworn declaration. (*See* [U.S. Code, Title 18, Section 1621](https://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm).) Submitting false information could also result in civil liability — that is, you could get sued for money damages. The DMCA itself [provides for damages](https://en.wikipedia.org/wiki/Online_Copyright_Infringement_Liability_Limitation_Act#%C2%A7_512(f)_Misrepresentations) against any person who knowingly materially misrepresents that material or activity is infringing. +***Tell the Truth.*** The DMCA requires that you swear to the facts in your copyright complaint _under penalty of perjury_. It is a federal crime to intentionally lie in a sworn declaration. (_See_ [U.S. Code, Title 18, Section 1621](https://www.gpo.gov/fdsys/pkg/USCODE-2011-title18/html/USCODE-2011-title18-partI-chap79-sec1621.htm).) Submitting false information could also result in civil liability — that is, you could get sued for money damages. The DMCA itself [provides for damages](https://en.wikipedia.org/wiki/Online_Copyright_Infringement_Liability_Limitation_Act#%C2%A7_512(f)_Misrepresentations) against any person who knowingly materially misrepresents that material or activity is infringing. ***Investigate.*** Millions of users and organizations pour their hearts and souls into the projects they create and contribute to on GitHub. Filing a DMCA complaint against such a project is a serious legal allegation that carries real consequences for real people. Because of that, we ask that you conduct a thorough investigation and consult with an attorney before submitting a takedown to make sure that the use isn't actually permissible. @@ -58,7 +58,7 @@ GitHub exercises little discretion in the process other than determining whether 2. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. 3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. - - Please note that GitHub will *not* automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. + - Please note that GitHub will _not_ automatically disable [forks](/site-policy/content-removal-policies/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. 4. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. @@ -85,7 +85,7 @@ The fastest way to get a response is to enter your information and answer all th You can also send an email notification to . You may include an attachment if you like, but please also include a plain-text version of your letter in the body of your message. -If you must send your notice by physical mail, you can do that too, but it will take *substantially* longer for us to receive and respond to it. Notices we receive via plain-text email have a much faster turnaround than PDF attachments or physical mail. If you still wish to mail us your notice, our physical address is: +If you must send your notice by physical mail, you can do that too, but it will take _substantially_ longer for us to receive and respond to it. Notices we receive via plain-text email have a much faster turnaround than PDF attachments or physical mail. If you still wish to mail us your notice, our physical address is: ``` GitHub, Inc diff --git a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md index 0b4ade6f57..e3506a1c7c 100644 --- a/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md +++ b/content/site-policy/github-company-policies/github-statement-against-modern-slavery-and-child-labor.md @@ -9,7 +9,7 @@ topics: - Policy - Legal --- -*2018 statement* +_2018 statement_ According to the International Labour Organization (ILO), [40 million people were victims of modern slavery and 152 million children were subject to child labor](https://www.ilo.org/global/about-the-ilo/newsroom/news/WCMS_574717/lang--en/index.htm) globally in 2016. As the [ILO reports](https://www.ilo.org/global/topics/forced-labour/lang--en/index.htm): - 1 in 4 victims of modern slavery are children. diff --git a/content/site-policy/github-terms/github-community-code-of-conduct.md b/content/site-policy/github-terms/github-community-code-of-conduct.md index 9948fe7a97..decdef6aa6 100644 --- a/content/site-policy/github-terms/github-community-code-of-conduct.md +++ b/content/site-policy/github-terms/github-community-code-of-conduct.md @@ -32,7 +32,7 @@ Treat GitHub Community with respect. We are a shared resource — a place to sha The following are not hard and fast rules, merely aids to the human judgment of our community. Use these guidelines to keep this a clean, well-lighted place for civilized public discourse. -### *Best Practices for Maintaining a Strong Community* +### _Best Practices for Maintaining a Strong Community_ The primary purpose of the GitHub community is to collaborate on software projects. We are committed to maintaining a community where users are free to express themselves and challenge one another's ideas, both technical and otherwise. At the same time, it's important that users remain respectful and allow space for others to contribute openly. In order to foster both a safe and productive environment, we encourage our community members to look to these guidelines to inform how they interact on our platform. Below, you’ll find some suggestions for how to have successful interactions as a valued member of the GitHub community. @@ -67,7 +67,7 @@ The primary purpose of the GitHub community is to collaborate on software projec - Be trustworthy. - **Always be honest.** Don’t knowingly share incorrect information or intentionally mislead other GitHub Community participants. If you don’t know the answer to someone’s question but still want to help, you can try helping them research or find resources instead. GitHub staff will also be active in GitHub Community, so if you’re unsure of an answer, it’s likely a moderator will be able to help. -### *What is not Allowed* +### _What is not Allowed_ GitHub's [Acceptable Use Policies](/site-policy/acceptable-use-policies/github-acceptable-use-policies), which are part of GitHub's [Terms of Service](/site-policy/github-terms/github-terms-of-service), set a baseline for what is not allowed on GitHub. Since GitHub Community is on GitHub.com, these terms and restrictions apply to GitHub Community, including the following restrictions: @@ -81,7 +81,7 @@ GitHub's [Acceptable Use Policies](/site-policy/acceptable-use-policies/github-a ## Enforcement -### *What GitHub Community Participants Can Do* +### _What GitHub Community Participants Can Do_ - **If you see a problem, report it.** Moderators have special authority; they are responsible for this GitHub Community. But so are you. With your help, moderators can be community facilitators, not just janitors or police. diff --git a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md index 991cbc9efc..f1f6ea5511 100644 --- a/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md +++ b/content/site-policy/github-terms/github-terms-for-additional-products-and-features.md @@ -39,19 +39,19 @@ Actions and any elements of the Actions product or service may not be used in vi In order to prevent violations of these limitations and abuse of GitHub Actions, GitHub may monitor your use of GitHub Actions. Misuse of GitHub Actions may result in termination of jobs, restrictions in your ability to use GitHub Actions, disabling of repositories created to run Actions in a way that violates these Terms, or in some cases, suspension or termination of your GitHub account. -*Use for Development and Testing* +_Use for Development and Testing_ You may only access and use GitHub Actions to develop and test your application(s). Only one licensed user may access a virtual machine provided by Actions at any time. -*Authorized Developer* +_Authorized Developer_ You appoint GitHub as your authorized developer with respect to Apple software included in Actions. GitHub is responsible for complying with the terms for any such software included in Actions and will keep confidential any confidential information of Apple accessed as part of Actions. -*Third Party Repository Service Access* +_Third Party Repository Service Access_ If you grant GitHub access to your third-party repository service account(s), you authorize GitHub to scan the account(s), including the contents of your Public and Private Repositories, for purposes of providing GitHub Actions. -*Self-Hosted Runners on GitHub Actions* +_Self-Hosted Runners on GitHub Actions_ If you use self-hosted runners, you have the ability to turn off automatic updates but GitHub reserves the right to override your choice for critical security updates. diff --git a/content/site-policy/github-terms/github-terms-of-service.md b/content/site-policy/github-terms/github-terms-of-service.md index 74e9dd0985..90da5b8d31 100644 --- a/content/site-policy/github-terms/github-terms-of-service.md +++ b/content/site-policy/github-terms/github-terms-of-service.md @@ -44,7 +44,7 @@ Effective date: November 16, 2020 ## A. Definitions -**Short version:** *We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. There's not going to be a test on it, but it's still useful information.* +**Short version:** _We use these basic terms throughout the agreement, and they have specific meanings. You should know what we mean when we use each of the terms. There's not going to be a test on it, but it's still useful information._ 1. An "Account" represents your legal relationship with GitHub. A “Personal Account” represents an individual User’s authorization to log in to and use the Service and serves as a User’s identity on GitHub. “Organizations” are shared workspaces that may be associated with a single entity or with one or more Users where multiple Users can collaborate across many projects at once. A Personal Account can be a member of any number of Organizations. 2. The “Agreement” refers, collectively, to all the terms, conditions, notices contained or referenced in this document (the “Terms of Service” or the "Terms") and all other operating rules, policies (including the GitHub Privacy Statement, available at [github.com/site/privacy](https://github.com/site/privacy)) and procedures that we may publish from time to time on the Website. Most of our site policies are available at [docs.github.com/categories/site-policy](/site-policy). @@ -56,7 +56,7 @@ Effective date: November 16, 2020 8. The “Website” refers to GitHub’s website located at [github.com](https://github.com/), and all content, services, and products provided by GitHub at or through the Website. It also refers to GitHub-owned subdomains of github.com, such as [education.github.com](https://education.github.com/) and [pages.github.com](https://pages.github.com/). These Terms also govern GitHub’s conference websites, such as [githubuniverse.com](https://githubuniverse.com/), and product websites, such as [electronjs.org](https://www.electronjs.org/). Occasionally, websites owned by GitHub may provide different or additional terms of service. If those additional terms conflict with this Agreement, the more specific terms apply to the relevant page or service. ## B. Account Terms -**Short version:** *Personal Accounts and Organizations have different administrative controls; a human must create your Account; you must be 13 or over; you must provide a valid email address; and you may not have more than one free Account. You alone are responsible for your Account and anything that happens while you are signed in to or using your Account. You are responsible for keeping your Account secure.* +**Short version:** _Personal Accounts and Organizations have different administrative controls; a human must create your Account; you must be 13 or over; you must provide a valid email address; and you may not have more than one free Account. You alone are responsible for your Account and anything that happens while you are signed in to or using your Account. You are responsible for keeping your Account secure._ ### 1. Account Controls - Users. Subject to these Terms, you retain ultimate administrative control over your Personal Account and the Content within it. @@ -89,14 +89,14 @@ If you are a government User or otherwise accessing or using any GitHub Service If you have signed up for GitHub Enterprise Cloud, the [Enterprise Cloud Addendum](/site-policy/site-policy-deprecated/github-enterprise-service-level-agreement) applies to you, and you agree to its provisions. ## C. Acceptable Use -**Short version:** *GitHub hosts a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the service, you must follow the terms of this section, which include some restrictions on content you can post, conduct on the service, and other limitations. In short, be excellent to each other.* +**Short version:** _GitHub hosts a wide variety of collaborative projects from all over the world, and that collaboration only works when our users are able to work together in good faith. While using the service, you must follow the terms of this section, which include some restrictions on content you can post, conduct on the service, and other limitations. In short, be excellent to each other._ Your use of the Website and Service must not violate any applicable laws, including copyright or trademark laws, export control or sanctions laws, or other laws in your jurisdiction. You are responsible for making sure that your use of the Service is in compliance with laws and any applicable regulations. You agree that you will not under any circumstances violate our [Acceptable Use Policies](/site-policy/acceptable-use-policies/github-acceptable-use-policies) or [Community Guidelines](/site-policy/github-terms/github-community-guidelines). ## D. User-Generated Content -**Short version:** *You own content you create, but you allow us certain rights to it, so that we can display and share the content you post. You still have control over your content, and responsibility for it, and the rights you grant us are limited to those we need to provide the service. We have the right to remove content or close Accounts if we need to.* +**Short version:** _You own content you create, but you allow us certain rights to it, so that we can display and share the content you post. You still have control over your content, and responsibility for it, and the rights you grant us are limited to those we need to provide the service. We have the right to remove content or close Accounts if we need to._ ### 1. Responsibility for User-Generated Content You may create or upload User-Generated Content while using the Service. You are solely responsible for the content of, and for any harm resulting from, any User-Generated Content that you post, upload, link to or otherwise make available via the Service, regardless of the form of that Content. We are not responsible for any public display or misuse of your User-Generated Content. @@ -130,7 +130,7 @@ You retain all moral rights to Your Content that you upload, publish, or submit To the extent this agreement is not enforceable by applicable law, you grant GitHub the rights we need to use Your Content without attribution and to make reasonable adaptations of Your Content as necessary to render the Website and provide the Service. ## E. Private Repositories -**Short version:** *We treat the content of private repositories as confidential, and we only access it as described in our Privacy Statement—for security purposes, to assist the repository owner with a support matter, to maintain the integrity of the Service, to comply with our legal obligations, if we have reason to believe the contents are in violation of the law, or with your consent.* +**Short version:** _We treat the content of private repositories as confidential, and we only access it as described in our Privacy Statement—for security purposes, to assist the repository owner with a support matter, to maintain the integrity of the Service, to comply with our legal obligations, if we have reason to believe the contents are in violation of the law, or with your consent._ ### 1. Control of Private Repositories Some Accounts may have private repositories, which allow the User to control access to Content. @@ -154,7 +154,7 @@ If you believe that content on our website violates your copyright, please conta We will terminate the Accounts of [repeat infringers](/site-policy/content-removal-policies/dmca-takedown-policy#e-repeated-infringement) of this policy. ## G. Intellectual Property Notice -**Short version:** *We own the service and all of our content. In order for you to use our content, we give you certain rights to it, but you may only use our content in the way we have allowed.* +**Short version:** _We own the service and all of our content. In order for you to use our content, we give you certain rights to it, but you may only use our content in the way we have allowed._ ### 1. GitHub's Rights to Content GitHub and our licensors, vendors, agents, and/or our content providers retain ownership of all intellectual property rights of any kind related to the Website and Service. We reserve all rights that are not expressly granted to you under this Agreement or by law. The look and feel of the Website and Service is copyright © GitHub, Inc. All rights reserved. You may not duplicate, copy, or reuse any portion of the HTML/CSS, Javascript, or visual design elements or concepts without express written permission from GitHub. @@ -166,7 +166,7 @@ If you’d like to use GitHub’s trademarks, you must follow all of our tradema This Agreement is licensed under this [Creative Commons Zero license](https://creativecommons.org/publicdomain/zero/1.0/). For details, see our [site-policy repository](https://github.com/github/site-policy#license). ## H. API Terms -**Short version:** *You agree to these Terms of Service, plus this Section H, when using any of GitHub's APIs (Application Provider Interface), including use of the API through a third party product that accesses GitHub.* +**Short version:** _You agree to these Terms of Service, plus this Section H, when using any of GitHub's APIs (Application Provider Interface), including use of the API through a third party product that accesses GitHub._ Abuse or excessively frequent requests to GitHub via the API may result in the temporary or permanent suspension of your Account's access to the API. GitHub, in our sole discretion, will determine abuse or excessive usage of the API. We will make a reasonable attempt to warn you via email prior to suspension. @@ -179,12 +179,12 @@ All use of the GitHub API is subject to these Terms of Service and the [GitHub P GitHub may offer subscription-based access to our API for those Users who require high-throughput access or access that would result in resale of GitHub's Service. ## I. GitHub Additional Product Terms -**Short version:** *You need to follow certain specific terms and conditions for GitHub's various features and products, and you agree to the Supplemental Terms and Conditions when you agree to this Agreement.* +**Short version:** _You need to follow certain specific terms and conditions for GitHub's various features and products, and you agree to the Supplemental Terms and Conditions when you agree to this Agreement._ Some Service features may be subject to additional terms specific to that feature or product as set forth in the GitHub Additional Product Terms. By accessing or using the Services, you also agree to the [GitHub Additional Product Terms](/site-policy/github-terms/github-terms-for-additional-products-and-features). ## J. Beta Previews -**Short version:** *Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better.* +**Short version:** _Beta Previews may not be supported or may change at any time. You may receive confidential information through those programs that must remain confidential while the program is private. We'd love your feedback to make our Beta Previews better._ ### 1. Subject to Change @@ -203,7 +203,7 @@ As a user of Beta Previews, you may get access to special information that isn We’re always trying to improve of products and services, and your feedback as a Beta Preview user will help us do that. If you choose to give us any ideas, know-how, algorithms, code contributions, suggestions, enhancement requests, recommendations or any other feedback for our products or services (collectively, “Feedback”), you acknowledge and agree that GitHub will have a royalty-free, fully paid-up, worldwide, transferable, sub-licensable, irrevocable and perpetual license to implement, use, modify, commercially exploit and/or incorporate the Feedback into our products, services, and documentation. ## K. Payment -**Short version:** *You are responsible for any fees associated with your use of GitHub. We are responsible for communicating those fees to you clearly and accurately, and letting you know well in advance if those prices change.* +**Short version:** _You are responsible for any fees associated with your use of GitHub. We are responsible for communicating those fees to you clearly and accurately, and letting you know well in advance if those prices change._ ### 1. Pricing Our pricing and payment terms are available at [github.com/pricing](https://github.com/pricing). If you agree to a subscription price, that will remain your price for the duration of the payment term; however, prices are subject to change at the end of a payment term. @@ -228,7 +228,7 @@ By agreeing to these Terms, you are giving us permission to charge your on-file You are responsible for all fees, including taxes, associated with your use of the Service. By using the Service, you agree to pay GitHub any charge incurred in connection with your use of the Service. If you dispute the matter, contact [GitHub Support](https://support.github.com/contact?tags=docs-policy). You are responsible for providing us with a valid means of payment for paid Accounts. Free Accounts are not required to provide payment information. ## L. Cancellation and Termination -**Short version:** *You may close your Account at any time. If you do, we'll treat your information responsibly.* +**Short version:** _You may close your Account at any time. If you do, we'll treat your information responsibly._ ### 1. Account Cancellation It is your responsibility to properly cancel your Account with GitHub. You can [cancel your Account at any time](/billing/managing-billing-for-your-github-account/downgrading-your-github-subscription) by going into your Settings in the global navigation bar at the top of the screen. The Account screen provides a simple, no questions asked cancellation link. We are not able to cancel Accounts in response to an email or phone request. @@ -244,10 +244,10 @@ Upon request, we will make a reasonable effort to provide an Account owner with GitHub has the right to suspend or terminate your access to all or any part of the Website at any time, with or without cause, with or without notice, effective immediately. GitHub reserves the right to refuse service to anyone for any reason at any time. ### 4. Survival -All provisions of this Agreement which, by their nature, should survive termination *will* survive termination — including, without limitation: ownership provisions, warranty disclaimers, indemnity, and limitations of liability. +All provisions of this Agreement which, by their nature, should survive termination _will_ survive termination — including, without limitation: ownership provisions, warranty disclaimers, indemnity, and limitations of liability. ## M. Communications with GitHub -**Short version:** *We use email and other electronic means to stay in touch with our users.* +**Short version:** _We use email and other electronic means to stay in touch with our users._ ### 1. Electronic Communication Required For contractual purposes, you (1) consent to receive communications from us in an electronic form via the email address you have submitted or via the Service; and (2) agree that all Terms of Service, agreements, notices, disclosures, and other communications that we provide to you electronically satisfy any legal requirement that those communications would satisfy if they were on paper. This section does not affect your non-waivable rights. @@ -259,14 +259,14 @@ Communications made through email or GitHub Support's messaging system will not GitHub only offers support via email, in-Service communications, and electronic messages. We do not offer telephone support. ## N. Disclaimer of Warranties -**Short version:** *We provide our service as is, and we make no promises or guarantees about this service. Please read this section carefully; you should understand what to expect.* +**Short version:** _We provide our service as is, and we make no promises or guarantees about this service. Please read this section carefully; you should understand what to expect._ GitHub provides the Website and the Service “as is” and “as available,” without warranty of any kind. Without limiting this, we expressly disclaim all warranties, whether express, implied or statutory, regarding the Website and the Service including without limitation any warranty of merchantability, fitness for a particular purpose, title, security, accuracy and non-infringement. GitHub does not warrant that the Service will meet your requirements; that the Service will be uninterrupted, timely, secure, or error-free; that the information provided through the Service is accurate, reliable or correct; that any defects or errors will be corrected; that the Service will be available at any particular time or location; or that the Service is free of viruses or other harmful components. You assume full responsibility and risk of loss resulting from your downloading and/or use of files, information, content or other material obtained from the Service. ## O. Limitation of Liability -**Short version:** *We will not be liable for damages or losses arising from your use or inability to use the service or otherwise arising under this agreement. Please read this section carefully; it limits our obligations to you.* +**Short version:** _We will not be liable for damages or losses arising from your use or inability to use the service or otherwise arising under this agreement. Please read this section carefully; it limits our obligations to you._ You understand and agree that we will not be liable to you or any third party for any loss of profits, use, goodwill, or data, or for any incidental, indirect, special, consequential or exemplary damages, however arising, that result from @@ -282,14 +282,14 @@ You understand and agree that we will not be liable to you or any third party fo Our liability is limited whether or not we have been informed of the possibility of such damages, and even if a remedy set forth in this Agreement is found to have failed of its essential purpose. We will have no liability for any failure or delay due to matters beyond our reasonable control. ## P. Release and Indemnification -**Short version:** *You are responsible for your use of the service. If you harm someone else or get into a dispute with someone else, we will not be involved.* +**Short version:** _You are responsible for your use of the service. If you harm someone else or get into a dispute with someone else, we will not be involved._ If you have a dispute with one or more Users, you agree to release GitHub from any and all claims, demands and damages (actual and consequential) of every kind and nature, known and unknown, arising out of or in any way connected with such disputes. You agree to indemnify us, defend us, and hold us harmless from and against any and all claims, liabilities, and expenses, including attorneys’ fees, arising out of your use of the Website and the Service, including but not limited to your violation of this Agreement, provided that GitHub (1) promptly gives you written notice of the claim, demand, suit or proceeding; (2) gives you sole control of the defense and settlement of the claim, demand, suit or proceeding (provided that you may not settle any claim, demand, suit or proceeding unless the settlement unconditionally releases GitHub of all liability); and (3) provides to you all reasonable assistance, at your expense. ## Q. Changes to These Terms -**Short version:** *We want our users to be informed of important changes to our terms, but some changes aren't that important — we don't want to bother you every time we fix a typo. So while we may modify this agreement at any time, we will notify users of any material changes and give you time to adjust to them.* +**Short version:** _We want our users to be informed of important changes to our terms, but some changes aren't that important — we don't want to bother you every time we fix a typo. So while we may modify this agreement at any time, we will notify users of any material changes and give you time to adjust to them._ We reserve the right, at our sole discretion, to amend these Terms of Service at any time and will update these Terms of Service in the event of any such amendments. We will notify our Users of material changes to this Agreement, such as price increases, at least 30 days prior to the change taking effect by posting a notice on our Website or sending email to the primary email address specified in your GitHub account. Customer's continued use of the Service after those 30 days constitutes agreement to those revisions of this Agreement. For any other modifications, your continued use of the Website constitutes agreement to our revisions of these Terms of Service. You can view all changes to these Terms in our [Site Policy](https://github.com/github/site-policy) repository. diff --git a/content/site-policy/other-site-policies/github-government-takedown-policy.md b/content/site-policy/other-site-policies/github-government-takedown-policy.md index 9397284dd3..09b9555671 100644 --- a/content/site-policy/other-site-policies/github-government-takedown-policy.md +++ b/content/site-policy/other-site-policies/github-government-takedown-policy.md @@ -31,7 +31,7 @@ When we receive a notice from a relevant, official government agency that identi We are concerned about Internet censorship, and believe that transparency on a specific and ongoing level is essential to good governance. By publicly posting the notices, we can better inform the public about what content is being withheld from GitHub, and why. We post takedown notices to document their potential to chill speech. ## What does it mean if we post a notice in our gov-takedowns repository? -It means that we received the notice on the indicated date. It does *not* mean that the content was unlawful or wrong. It does *not* mean that the user identified in the notice has done anything wrong. We don't make or imply any judgment about the merit of the claims they make. We post these notices and requests only for informational purposes. +It means that we received the notice on the indicated date. It does _not_ mean that the content was unlawful or wrong. It does _not_ mean that the user identified in the notice has done anything wrong. We don't make or imply any judgment about the merit of the claims they make. We post these notices and requests only for informational purposes. ## Government takedowns based on violations of GitHub's Terms of Service In some cases, GitHub receives reports from government officials of violations of GitHub's Terms of Service. We process those violations as we would process a Terms-of-Service violation reported by anyone else. However, we notify the affected users that the report came from a government and, as with any other case, allow them the opportunity to appeal. diff --git a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md index a48cfa7800..cd7fd02ec2 100644 --- a/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md +++ b/content/site-policy/other-site-policies/guidelines-for-legal-requests-of-user-data.md @@ -93,7 +93,7 @@ All user public profiles display: - Their location - A public email address - Their personal web page - - Organizations to which the user is a member (*depending on either the organizations' or the users' preferences*) + - Organizations to which the user is a member (_depending on either the organizations' or the users' preferences_) - **Private account data** — @@ -177,7 +177,7 @@ In the case of organization accounts, we can provide the name(s) and email addre Please note that the information available will vary from case to case. Some of the information is optional for users to provide. In other cases, we may not have collected or retained the information. - -**With a court order *or* a search warrant** — We will not disclose account access logs unless compelled to do so by either +**With a court order _or_ a search warrant** — We will not disclose account access logs unless compelled to do so by either (i) a court order issued under 18 U.S.C. Section 2703(d), upon a showing of specific and articulable facts showing that there are reasonable grounds to believe that the information sought is relevant and material to an ongoing criminal investigation; or (ii) a search warrant issued under the procedures described in the Federal Rules of Criminal Procedure or equivalent state warrant procedures, upon a showing of probable cause. In addition to the non-public account information listed above, we can provide account access logs in response to a court order or search warrant, which may include: diff --git a/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md b/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md index b4df0185e5..cf2c525d30 100644 --- a/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md +++ b/content/site-policy/site-policy-deprecated/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md @@ -28,44 +28,44 @@ GitHub and You (together, the "Parties") agree that modifications to the [GitHub ## A. Public purpose -1. *Government entity* - "You" within the ToS shall mean the Government itself and shall not bind, in their individual capacity, the individual(s) who utilize the Company site or services on the Government's behalf. Company will look solely to the Government to enforce any violation or breach of the ToS by such individuals, subject to federal law. +1. _Government entity_ - "You" within the ToS shall mean the Government itself and shall not bind, in their individual capacity, the individual(s) who utilize the Company site or services on the Government's behalf. Company will look solely to the Government to enforce any violation or breach of the ToS by such individuals, subject to federal law. -2. *Advertisements* - Company hereby agrees not to serve or display any third-party commercial advertisements or solicitations on any pages within the Company site displaying content created by or under the control of the Government. This exclusion shall not extend to house ads, which Company may serve on such pages in a non-intrusive manner. The foregoing obligations are contingent upon the email address designated on Your account details page ending in `.gov`, `.mil`, or `.fed.us`. +2. _Advertisements_ - Company hereby agrees not to serve or display any third-party commercial advertisements or solicitations on any pages within the Company site displaying content created by or under the control of the Government. This exclusion shall not extend to house ads, which Company may serve on such pages in a non-intrusive manner. The foregoing obligations are contingent upon the email address designated on Your account details page ending in `.gov`, `.mil`, or `.fed.us`. ## B. Your content on GitHub -1. *Access and use* - Company acknowledges that the Government's use of the Service may energize significant citizen engagement. Language in the ToS allowing Company to terminate service, refuse or remove any Content, or close the Government's account, at any time, for any reason, is modified to reflect the Parties' agreement that Company may unilaterally modify or discontinue service, temporarily or permanently, refuse or remove any Content, and/or terminate the Government's account only for breach of the Government’s obligations under the ToS or its material failure to comply with the instructions and guidelines posted on the Service, or if Company ceases to operate the Service generally. Company will provide the Government with a reasonable opportunity to cure any breach or failure on the Government's part. +1. _Access and use_ - Company acknowledges that the Government's use of the Service may energize significant citizen engagement. Language in the ToS allowing Company to terminate service, refuse or remove any Content, or close the Government's account, at any time, for any reason, is modified to reflect the Parties' agreement that Company may unilaterally modify or discontinue service, temporarily or permanently, refuse or remove any Content, and/or terminate the Government's account only for breach of the Government’s obligations under the ToS or its material failure to comply with the instructions and guidelines posted on the Service, or if Company ceases to operate the Service generally. Company will provide the Government with a reasonable opportunity to cure any breach or failure on the Government's part. -2. *No endorsement* - Company agrees that Your seals, trademarks, logos, service marks, trade names, and the fact that You have a presence on the Company site and use its services, shall not be used by Company in such a manner as to state or imply that Company's products or services are endorsed, sponsored or recommended by You or by any other element of the federal government, or are considered by these entities to be superior to any other products or services. Except for pages whose design and content is under the control of the Government, or for links to or promotion of such pages, Company agrees not to display any government seals or logos on the Company's homepage or elsewhere on the Company Site, unless permission to do so has been granted by the Government or by other relevant federal government authority. Company may list the Government's name in a publicly available customer list so long as the name is not displayed in a more prominent fashion than that of any other third-party name. +2. _No endorsement_ - Company agrees that Your seals, trademarks, logos, service marks, trade names, and the fact that You have a presence on the Company site and use its services, shall not be used by Company in such a manner as to state or imply that Company's products or services are endorsed, sponsored or recommended by You or by any other element of the federal government, or are considered by these entities to be superior to any other products or services. Except for pages whose design and content is under the control of the Government, or for links to or promotion of such pages, Company agrees not to display any government seals or logos on the Company's homepage or elsewhere on the Company Site, unless permission to do so has been granted by the Government or by other relevant federal government authority. Company may list the Government's name in a publicly available customer list so long as the name is not displayed in a more prominent fashion than that of any other third-party name. -3. *Provision of data* - In case of termination of service, within 30 days of such termination, upon request, Company will provide you with all user-generated content that is publicly visible through the Sites You created at Company. Data will be provided in a commonly used file or database format as Company deems appropriate. Company will not provide data if doing so would violate its privacy policy, available at [https://docs.github.com/privacy](/site-policy/privacy-policies/github-privacy-statement). +3. _Provision of data_ - In case of termination of service, within 30 days of such termination, upon request, Company will provide you with all user-generated content that is publicly visible through the Sites You created at Company. Data will be provided in a commonly used file or database format as Company deems appropriate. Company will not provide data if doing so would violate its privacy policy, available at [https://docs.github.com/privacy](/site-policy/privacy-policies/github-privacy-statement). ## C. Unpaid and paid plans -1. *No cost agreement* - Nothing in this Amendment or ToS obligates You to expend appropriations or incur financial obligations. The Parties acknowledge and agree that none of the obligations arising from this Amendment or ToS are contingent upon the payment of fees by one party to the other. At the Company’s discretion, GitHub may offer a free account under a free usage plan, such as a Free for Open Source Plan, and in that case this Amendment will apply to the Government’s usage under the free account/plan. This Amendment also applies when the Government uses one of GitHub’s paid usage plans. +1. _No cost agreement_ - Nothing in this Amendment or ToS obligates You to expend appropriations or incur financial obligations. The Parties acknowledge and agree that none of the obligations arising from this Amendment or ToS are contingent upon the payment of fees by one party to the other. At the Company’s discretion, GitHub may offer a free account under a free usage plan, such as a Free for Open Source Plan, and in that case this Amendment will apply to the Government’s usage under the free account/plan. This Amendment also applies when the Government uses one of GitHub’s paid usage plans. -2. *Government responsibilities under paid usage plans* - You acknowledge that while Company will provide You with service under a free plan, Company reserves the right to begin charging for that service at some point in the future. Company will provide You with at least 30 days advance notice of a change involving the charging of fees for a free service. You also understand that Company offers paid plans for a fee. The Parties understand that fee-based services are categorically different than free products, and are subject to federal procurement rules and processes. Before the Government decides to enter into a business or enterprise subscription, or any other fee-based service that this Company or alternative providers may offer now or in the future, You agree: to determine the Government has a need for those additional services for a fee; to consider the subscription's value in comparison with comparable services available elsewhere; to determine that Government funds are available for payment; to properly use the Government Purchase Card if that Card is used as the payment method; to review any then-applicable ToS for conformance to federal procurement law; and in all other respects to follow applicable federal acquisition laws, regulations and agency guidelines (including those related to payments) when initiating that separate action. +2. _Government responsibilities under paid usage plans_ - You acknowledge that while Company will provide You with service under a free plan, Company reserves the right to begin charging for that service at some point in the future. Company will provide You with at least 30 days advance notice of a change involving the charging of fees for a free service. You also understand that Company offers paid plans for a fee. The Parties understand that fee-based services are categorically different than free products, and are subject to federal procurement rules and processes. Before the Government decides to enter into a business or enterprise subscription, or any other fee-based service that this Company or alternative providers may offer now or in the future, You agree: to determine the Government has a need for those additional services for a fee; to consider the subscription's value in comparison with comparable services available elsewhere; to determine that Government funds are available for payment; to properly use the Government Purchase Card if that Card is used as the payment method; to review any then-applicable ToS for conformance to federal procurement law; and in all other respects to follow applicable federal acquisition laws, regulations and agency guidelines (including those related to payments) when initiating that separate action. -3. *No business relationship created* - The Parties are independent entities and nothing in this Amendment or ToS creates an agency, partnership, joint venture, or employer/employee relationship. +3. _No business relationship created_ - The Parties are independent entities and nothing in this Amendment or ToS creates an agency, partnership, joint venture, or employer/employee relationship. ## D. Federal Regulations -1. *Security* - Company will, in good faith, exercise due diligence using generally accepted commercial business practices for IT security, to ensure that systems are operated and maintained in a secure manner, and that management, operational and technical controls will be employed to ensure security of systems and data. Recognizing the changing nature of the Web, Company will continuously work with users to ensure that its products and services are operated and maintained in a secure manner. Company agrees to discuss implementing additional security controls as deemed necessary by the Government to conform to the Federal Information Security Management Act (FISMA), 44 U.S.C. 3541 et seq. +1. _Security_ - Company will, in good faith, exercise due diligence using generally accepted commercial business practices for IT security, to ensure that systems are operated and maintained in a secure manner, and that management, operational and technical controls will be employed to ensure security of systems and data. Recognizing the changing nature of the Web, Company will continuously work with users to ensure that its products and services are operated and maintained in a secure manner. Company agrees to discuss implementing additional security controls as deemed necessary by the Government to conform to the Federal Information Security Management Act (FISMA), 44 U.S.C. 3541 et seq. -2. *Federal Records* - Government acknowledges that use of Company's site and services may require management of Federal records. Government and user-generated content may meet the definition of Federal records as determined by the agency. If the Company holds Federal records, the Government and the Company must manage Federal records in accordance with all applicable records management laws and regulations, including but not limited to the Federal Records Act (44 U.S.C. chs. 21, 29, 31, 33), and regulations of the National Archives and Records Administration (NARA) at 36 CFR Chapter XII Subchapter B). Managing the records includes, but is not limited to, secure storage, retrievability, and proper disposition of all Federal records including transfer of permanently valuable records to NARA in a format and manner acceptable to NARA at the time of transfer. The Government is responsible for ensuring that the Company is compliant with applicable records management laws and regulations through the life and termination of the Agreement. +2. _Federal Records_ - Government acknowledges that use of Company's site and services may require management of Federal records. Government and user-generated content may meet the definition of Federal records as determined by the agency. If the Company holds Federal records, the Government and the Company must manage Federal records in accordance with all applicable records management laws and regulations, including but not limited to the Federal Records Act (44 U.S.C. chs. 21, 29, 31, 33), and regulations of the National Archives and Records Administration (NARA) at 36 CFR Chapter XII Subchapter B). Managing the records includes, but is not limited to, secure storage, retrievability, and proper disposition of all Federal records including transfer of permanently valuable records to NARA in a format and manner acceptable to NARA at the time of transfer. The Government is responsible for ensuring that the Company is compliant with applicable records management laws and regulations through the life and termination of the Agreement. ## E. General Conditions -1. *Indemnification* - Any provisions in the ToS related to indemnification, damages, attorney’s fees, and settlement are hereby waived. Liability of the Government for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined under the Federal Tort Claims Act, or other governing authority. Liability of Company for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined by applicable federal or state law. +1. _Indemnification_ - Any provisions in the ToS related to indemnification, damages, attorney’s fees, and settlement are hereby waived. Liability of the Government for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined under the Federal Tort Claims Act, or other governing authority. Liability of Company for any breach of the ToS or this Agreement, or any claim, demand, suit or proceeding arising from the ToS or this Agreement, shall be determined by applicable federal or state law. -2. *Limitation of liability* - The Parties agree that nothing in the Limitation of Liability clause or elsewhere in the ToS in any way grants Company a waiver from, release of, or limitation of liability pertaining to, any past, current or future violation of federal law. +2. _Limitation of liability_ - The Parties agree that nothing in the Limitation of Liability clause or elsewhere in the ToS in any way grants Company a waiver from, release of, or limitation of liability pertaining to, any past, current or future violation of federal law. -3. *Governing law and Forum* - The dispute resolution provision in the ToS is hereby deleted. The ToS and this Amendment shall be governed, interpreted and enforced in accordance with applicable federal laws of the United States of America and exclusive jurisdiction shall be in the appropriate U.S. federal courts. To the extent permitted by federal law, the laws of the State of California will apply in the absence of federal law. +3. _Governing law and Forum_ - The dispute resolution provision in the ToS is hereby deleted. The ToS and this Amendment shall be governed, interpreted and enforced in accordance with applicable federal laws of the United States of America and exclusive jurisdiction shall be in the appropriate U.S. federal courts. To the extent permitted by federal law, the laws of the State of California will apply in the absence of federal law. -4. *Assignment* - Neither party may assign its obligations under this Amendment or ToS to any third-party without prior written consent of the other; however, GitHub may, without the Government's consent, assign its obligations to an Government using the service under a free usage plan under this Amendment or ToS to an affiliate or to a successor or acquirer, as the case may be, in connection with a merger, acquisition, corporate reorganization or consolidation, or the sale of all or substantially all of GitHub's assets. +4. _Assignment_ - Neither party may assign its obligations under this Amendment or ToS to any third-party without prior written consent of the other; however, GitHub may, without the Government's consent, assign its obligations to an Government using the service under a free usage plan under this Amendment or ToS to an affiliate or to a successor or acquirer, as the case may be, in connection with a merger, acquisition, corporate reorganization or consolidation, or the sale of all or substantially all of GitHub's assets. ## F. Changes to this agreement -1. *Precedence; Further Amendment; Termination* - This Amendment constitutes an amendment to the ToS; language in the ToS indicating it may not be modified or that it alone is the entire agreement between the Parties is waived. If there is any conflict between this Amendment and the ToS, or between this Amendment and other rules or policies on the Company site or services, this Amendment shall prevail. This Amendment may be further amended only upon written agreement executed by both Parties. The Government may close its account and terminate this agreement at any time. Company may close Government's account and terminate this agreement on 30 days written notice, but the Government shall not be entitled to a refund of any fees paid. +1. _Precedence; Further Amendment; Termination_ - This Amendment constitutes an amendment to the ToS; language in the ToS indicating it may not be modified or that it alone is the entire agreement between the Parties is waived. If there is any conflict between this Amendment and the ToS, or between this Amendment and other rules or policies on the Company site or services, this Amendment shall prevail. This Amendment may be further amended only upon written agreement executed by both Parties. The Government may close its account and terminate this agreement at any time. Company may close Government's account and terminate this agreement on 30 days written notice, but the Government shall not be entitled to a refund of any fees paid. -2. *Posting and availability of this Amendment* - The parties agree this Amendment contains no confidential or proprietary information, and either party may release it to the public at large. +2. _Posting and availability of this Amendment_ - The parties agree this Amendment contains no confidential or proprietary information, and either party may release it to the public at large. diff --git a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md index 0992a40e1e..92cdd272c7 100644 --- a/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-ae-data-protection-agreement.md @@ -79,15 +79,15 @@ Upon Customer’s reasonable request, unless prohibited by law, GitHub will retu #### 3.4 Data Processing. GitHub provides the following information, required by Article 28(3) of the GDPR, regarding its processing of Customer’s Protected Data: -a. *The subject matter and duration of the processing* of Customer Personal Data are set out in the Agreement and the DPA. +a. _The subject matter and duration of the processing_ of Customer Personal Data are set out in the Agreement and the DPA. -b. *The nature and purpose of the processing* of Customer Personal Data is described in Section 3.1 of the DPA. +b. _The nature and purpose of the processing_ of Customer Personal Data is described in Section 3.1 of the DPA. -c. *The types of Customer Personal Data to be processed* are described in the Agreement, and include Customer Personal Data; or any type of Personal Data that Customer elects to include in Customer Personal Data. Customer may choose to supply GitHub with additional Customer Personal Data, such as in Customer’s profile settings or by uploading Customer Personal Data to its GitHub repositories. +c. _The types of Customer Personal Data to be processed_ are described in the Agreement, and include Customer Personal Data; or any type of Personal Data that Customer elects to include in Customer Personal Data. Customer may choose to supply GitHub with additional Customer Personal Data, such as in Customer’s profile settings or by uploading Customer Personal Data to its GitHub repositories. -d. *The categories of Data Subject to whom the Customer Personal Data relates* are the Customer itself and its End Users. +d. _The categories of Data Subject to whom the Customer Personal Data relates_ are the Customer itself and its End Users. -e. *The obligations and rights of Customer* are set out in the Agreement and the DPA. +e. _The obligations and rights of Customer_ are set out in the Agreement and the DPA. ### 4. Security and Audit Obligations. diff --git a/content/site-policy/site-policy-deprecated/github-enterprise-cloud-evaluation-agreement.md b/content/site-policy/site-policy-deprecated/github-enterprise-cloud-evaluation-agreement.md index 346fe8d0f3..3f46f3bd45 100644 --- a/content/site-policy/site-policy-deprecated/github-enterprise-cloud-evaluation-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-enterprise-cloud-evaluation-agreement.md @@ -19,11 +19,11 @@ Customer must have a Corporate Account on GitHub.com in order to have evaluation ## 2. Term and Termination -*2.1 Term.* "Evaluation Agreement Effective Date" is the date on which Customer agrees to the terms and conditions of this Evaluation Agreement. This Agreement begins on the Evaluation Agreement Effective Date and continues in effect for fourteen (14) days ("**Evaluation Term**"). +_2.1 Term._ "Evaluation Agreement Effective Date" is the date on which Customer agrees to the terms and conditions of this Evaluation Agreement. This Agreement begins on the Evaluation Agreement Effective Date and continues in effect for fourteen (14) days ("**Evaluation Term**"). -*2.2 Termination.* Either party may terminate this Evaluation Agreement for any reason, without cause. Section 2.3 will apply to either party's election to terminate this Evaluation Agreement. This Evaluation Agreement will terminate immediately, without the requirement of notice, if Customer breaches any terms of the Evaluation Agreement. +_2.2 Termination._ Either party may terminate this Evaluation Agreement for any reason, without cause. Section 2.3 will apply to either party's election to terminate this Evaluation Agreement. This Evaluation Agreement will terminate immediately, without the requirement of notice, if Customer breaches any terms of the Evaluation Agreement. -*2.3 Effect of Termination.* Upon expiration of the Evaluation Term, any Subscription Licenses will automatically terminate; Customer will no longer have the right to use Enterprise Cloud; and Customer may lose access to Content, features, or capacity of its account. Please see the "Effect of Termination" section of the Corporate Terms of Service for information on obtaining a copy of that Content. +_2.3 Effect of Termination._ Upon expiration of the Evaluation Term, any Subscription Licenses will automatically terminate; Customer will no longer have the right to use Enterprise Cloud; and Customer may lose access to Content, features, or capacity of its account. Please see the "Effect of Termination" section of the Corporate Terms of Service for information on obtaining a copy of that Content. ## 3. Warranties and Disclaimers diff --git a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md index f34c7eb1a0..192226f31b 100644 --- a/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md +++ b/content/site-policy/site-policy-deprecated/github-enterprise-server-license-agreement.md @@ -89,11 +89,11 @@ If Customer has purchased the Products from a GitHub Partner, the following prov **8. Payment** -**8.1** *Fees.* Customer agrees to pay the Fees in full, up front without deduction or setoff of any kind, in U.S. Dollars. Customer must pay the Fees within thirty (30) days of the GitHub invoice date. Amounts payable under this Agreement are non-refundable, except as provided in Sections 13 and 14.1. If Customer fails to pay any Fees on time, GitHub reserves the right, in addition to taking any other action at law or equity, to (i) charge interest on past due amounts at 1.0% per month or the highest interest rate allowed by law, whichever is less, and to charge all expenses of recovery, and (ii) terminate the applicable Order Form or SOW. Customer is solely responsible for all taxes, fees, duties and governmental assessments (except for taxes based on GitHub's net income) that are imposed or become due in connection with this Agreement. +**8.1** _Fees._ Customer agrees to pay the Fees in full, up front without deduction or setoff of any kind, in U.S. Dollars. Customer must pay the Fees within thirty (30) days of the GitHub invoice date. Amounts payable under this Agreement are non-refundable, except as provided in Sections 13 and 14.1. If Customer fails to pay any Fees on time, GitHub reserves the right, in addition to taking any other action at law or equity, to (i) charge interest on past due amounts at 1.0% per month or the highest interest rate allowed by law, whichever is less, and to charge all expenses of recovery, and (ii) terminate the applicable Order Form or SOW. Customer is solely responsible for all taxes, fees, duties and governmental assessments (except for taxes based on GitHub's net income) that are imposed or become due in connection with this Agreement. -**8.2** *Purchasing Additional Subscription Licenses.* Customer may obtain additional Subscription Licenses under this Agreement by submitting a request through GitHub’s website or via its sales team. A new Order Form will then be generated and if Customer purchases the additional Subscription Licenses, Customer must pay the then-currently applicable Fees for them, prorated for the balance of the applicable Subscription Term. Upon renewal of Customer’s Subscription Licenses for another Subscription Term, GitHub will invoice all Subscription Licenses at once on an annual basis unless otherwise specified in an Order Form. +**8.2** _Purchasing Additional Subscription Licenses._ Customer may obtain additional Subscription Licenses under this Agreement by submitting a request through GitHub’s website or via its sales team. A new Order Form will then be generated and if Customer purchases the additional Subscription Licenses, Customer must pay the then-currently applicable Fees for them, prorated for the balance of the applicable Subscription Term. Upon renewal of Customer’s Subscription Licenses for another Subscription Term, GitHub will invoice all Subscription Licenses at once on an annual basis unless otherwise specified in an Order Form. -**8.3** *Add-On Software.* Add-On Software is licensed on a per User basis. For the avoidance of doubt, and unless otherwise set forth in an Order Form, the number of Subscription Licenses Customer has at any given time for Add-On Software must equal the number of Subscription Licenses Customer has for the Products under this Agreement. For example, if Customer wishes to purchase a subscription to Advanced Security and already holds Subscription Licenses for 100 Users for the Products, it must purchase Subscription Licenses for 100 Users for Advanced Security. +**8.3** _Add-On Software._ Add-On Software is licensed on a per User basis. For the avoidance of doubt, and unless otherwise set forth in an Order Form, the number of Subscription Licenses Customer has at any given time for Add-On Software must equal the number of Subscription Licenses Customer has for the Products under this Agreement. For example, if Customer wishes to purchase a subscription to Advanced Security and already holds Subscription Licenses for 100 Users for the Products, it must purchase Subscription Licenses for 100 Users for Advanced Security. **9. Delivery.** GitHub will make the License Key available for Customer to download on a secure, password-protected website. All deliveries under this Section 9 will be electronic. For the avoidance of doubt, Customer is responsible for installation of any Software and acknowledge that GitHub has no further delivery obligation with respect to the Software after delivery of the License Key. As Updates become available, GitHub will make those available for download on the same website. Customer must Update the Software on a commercially reasonable basis but no less than one (1) time per year. Customer is responsible for maintaining the confidentiality of Customer’s usernames and passwords. @@ -101,88 +101,88 @@ If Customer has purchased the Products from a GitHub Partner, the following prov **11. Support.** -**11.1** *Standard Support.* GitHub will provide standard technical Support for the Software at no additional charge twenty-four (24) hours per day, five (5) days per week, excluding weekends and national U.S. holidays. Standard Support is only offered via web-based ticketing through GitHub Support, and Support requests must be initiated from a User with which GitHub's Support team can interact. GitHub may provide premium Support (subject to the [Premium Support for Enterprise Server terms](/support/learning-about-github-support/about-github-premium-support)) or dedicated technical Support for the Software at the Support level, Fees, and Subscription Term specified in an Order Form or SOW. +**11.1** _Standard Support._ GitHub will provide standard technical Support for the Software at no additional charge twenty-four (24) hours per day, five (5) days per week, excluding weekends and national U.S. holidays. Standard Support is only offered via web-based ticketing through GitHub Support, and Support requests must be initiated from a User with which GitHub's Support team can interact. GitHub may provide premium Support (subject to the [Premium Support for Enterprise Server terms](/support/learning-about-github-support/about-github-premium-support)) or dedicated technical Support for the Software at the Support level, Fees, and Subscription Term specified in an Order Form or SOW. -**11.2** *Enhanced Support Offerings.* GitHub may provide enhanced Support offerings for the Software (including the Premium, Premium Plus, and Engineering Direct Support offerings) in accordance with the [Support terms](/support/learning-about-github-support/about-github-premium-support), and at the Support level, Fees, and Subscription Term specified in an Order Form or SOW. +**11.2** _Enhanced Support Offerings._ GitHub may provide enhanced Support offerings for the Software (including the Premium, Premium Plus, and Engineering Direct Support offerings) in accordance with the [Support terms](/support/learning-about-github-support/about-github-premium-support), and at the Support level, Fees, and Subscription Term specified in an Order Form or SOW. -**11.3** *Exclusions.* GitHub will use reasonable efforts to correct any material, reproducible errors in the Software of which Customer notifies GitHub. However, GitHub will not be responsible for providing Support where (i) someone (other than GitHub) modifies the Software; (ii) Customer changes its operating system or environment in a way that adversely affects the Software or its performance; (iii) Customer uses the Software in a manner other than as authorized under this Agreement or the Documentation; or (iv) there is negligence or misuse by Customer of the Software. +**11.3** _Exclusions._ GitHub will use reasonable efforts to correct any material, reproducible errors in the Software of which Customer notifies GitHub. However, GitHub will not be responsible for providing Support where (i) someone (other than GitHub) modifies the Software; (ii) Customer changes its operating system or environment in a way that adversely affects the Software or its performance; (iii) Customer uses the Software in a manner other than as authorized under this Agreement or the Documentation; or (iv) there is negligence or misuse by Customer of the Software. -**11.4** *Updates; Releases.* GitHub will only Support a given Release of the Software for one (1) year from the original Release date, or six (6) months from the last Update of the Release, whichever is longer. If Customer requires Support for earlier Releases of the Software, then Customer must pay for that Support in accordance with the terms of a mutually agreed upon Order Form or SOW. +**11.4** _Updates; Releases._ GitHub will only Support a given Release of the Software for one (1) year from the original Release date, or six (6) months from the last Update of the Release, whichever is longer. If Customer requires Support for earlier Releases of the Software, then Customer must pay for that Support in accordance with the terms of a mutually agreed upon Order Form or SOW. **12. Professional Services.** Upon Customer’s request for Professional Services, GitHub will provide an SOW detailing such Professional Services. GitHub will perform the Professional Services described in each SOW. GitHub will control the manner and means by which the Professional Services are performed and reserves the right to determine personnel assigned. GitHub may use third parties to perform the Professional Services, provided that GitHub remains responsible for their acts and omissions. Customer acknowledges and agrees that GitHub retains all right, title and interest in and to anything used or developed in connection with performing the Professional Services, including software, tools, specifications, ideas, concepts, inventions, processes, techniques, and know-how. To the extent GitHub delivers anything to Customer while performing the Professional Services, GitHub grants to Customer a non-exclusive, non-transferable, worldwide, royalty-free, limited-term license to use those deliverables during the term of this Agreement, solely in conjunction with Customer’s use of the Software. **13. Limited Warranties.** -**13.1** *Limited Software Warranties*. GitHub warrants that: (i) the unmodified Software, at the time it is made available to Customer for download, will not contain or transmit any malware, viruses, or worms (otherwise known as computer code or other technology specifically designed to disrupt, disable, or harm Customer’s software, hardware, computer system, or network) and (ii) for ninety (90) days from the date it is made available for initial download, the unmodified Software will substantially conform to its Documentation. GitHub does not warrant that Customer’s use of the Software will be uninterrupted, or that the operation of the Software will be error-free. The warranty in this Section 13.1 will not apply if Customer modifies or uses the Software in any way that is not expressly permitted by this Agreement and the Documentation. GitHub's only obligation, and Customer’s only remedy, for any breach of this warranty will be, at GitHub's option and expense, to either (a) repair the Software; (b) replace the Software; or (c) terminate this Agreement with respect to the defective Software, and refund the unused, prepaid Fees for the defective Software during the then-current Subscription Term. +**13.1** _Limited Software Warranties_. GitHub warrants that: (i) the unmodified Software, at the time it is made available to Customer for download, will not contain or transmit any malware, viruses, or worms (otherwise known as computer code or other technology specifically designed to disrupt, disable, or harm Customer’s software, hardware, computer system, or network) and (ii) for ninety (90) days from the date it is made available for initial download, the unmodified Software will substantially conform to its Documentation. GitHub does not warrant that Customer’s use of the Software will be uninterrupted, or that the operation of the Software will be error-free. The warranty in this Section 13.1 will not apply if Customer modifies or uses the Software in any way that is not expressly permitted by this Agreement and the Documentation. GitHub's only obligation, and Customer’s only remedy, for any breach of this warranty will be, at GitHub's option and expense, to either (a) repair the Software; (b) replace the Software; or (c) terminate this Agreement with respect to the defective Software, and refund the unused, prepaid Fees for the defective Software during the then-current Subscription Term. -**13.2** *Professional Services Warranty.* GitHub warrants to Customer that any Professional Services performed under this Agreement will be performed in a professional and workmanlike manner by appropriately qualified personnel. GitHub's only obligation, and Customer’s only remedy, for a breach of this warranty will be, at GitHub's option and expense, to either: (i) promptly re-perform any Professional Services that fail to meet this warranty or (ii) if the breach cannot be cured, terminate the SOW and refund the unused, prepaid Fees. +**13.2** _Professional Services Warranty._ GitHub warrants to Customer that any Professional Services performed under this Agreement will be performed in a professional and workmanlike manner by appropriately qualified personnel. GitHub's only obligation, and Customer’s only remedy, for a breach of this warranty will be, at GitHub's option and expense, to either: (i) promptly re-perform any Professional Services that fail to meet this warranty or (ii) if the breach cannot be cured, terminate the SOW and refund the unused, prepaid Fees. -**13.3** *General Warranty.* Each Party represents and warrants that it has the legal power and authority to enter into this Agreement, and that this Agreement and each Order Form is entered into by an employee or agent of such Party with all necessary authority to bind such Party to the terms and conditions of this Agreement. +**13.3** _General Warranty._ Each Party represents and warrants that it has the legal power and authority to enter into this Agreement, and that this Agreement and each Order Form is entered into by an employee or agent of such Party with all necessary authority to bind such Party to the terms and conditions of this Agreement. -**13.4** *Beta Previews.* Customer may choose to use Beta Previews in its sole discretion. Beta Previews may not be supported and may be changed at any time without notice. Beta Previews may not be as reliable or available as the Software. Beta Previews are not subject to the same security measures to which the Software has been and is subject. GitHub will have no liability arising out of or in connection with Beta Previews. **CUSTOMER USERS BETA PREVIEWS AT ITS OWN RISK.** +**13.4** _Beta Previews._ Customer may choose to use Beta Previews in its sole discretion. Beta Previews may not be supported and may be changed at any time without notice. Beta Previews may not be as reliable or available as the Software. Beta Previews are not subject to the same security measures to which the Software has been and is subject. GitHub will have no liability arising out of or in connection with Beta Previews. **CUSTOMER USERS BETA PREVIEWS AT ITS OWN RISK.** -**13.5** *Warranty Disclaimer.* THE LIMITED WARRANTIES DESCRIBED ABOVE ARE THE ONLY WARRANTIES GITHUB MAKES WITH RESPECT TO THE SOFTWARE, PROFESSIONAL SERVICES, AND SUPPORT. GITHUB DOES NOT MAKE ANY OTHER WARRANTIES AND REPRESENTATIONS OF ANY KIND, AND HEREBY SPECIFICALLY DISCLAIMS ANY OTHER WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR ANY WARRANTIES OR CONDITIONS ARISING OUT OF COURSE OF DEALING OR USAGE OF TRADE. NO ADVICE OR INFORMATION, WHETHER ORAL OR WRITTEN, PROVIDED BY GITHUB OR ANYWHERE ELSE WILL CREATE ANY WARRANTY OR CONDITION NOT EXPRESSLY STATED IN THIS AGREEMENT. +**13.5** _Warranty Disclaimer._ THE LIMITED WARRANTIES DESCRIBED ABOVE ARE THE ONLY WARRANTIES GITHUB MAKES WITH RESPECT TO THE SOFTWARE, PROFESSIONAL SERVICES, AND SUPPORT. GITHUB DOES NOT MAKE ANY OTHER WARRANTIES AND REPRESENTATIONS OF ANY KIND, AND HEREBY SPECIFICALLY DISCLAIMS ANY OTHER WARRANTIES, WHETHER EXPRESS, IMPLIED, OR STATUTORY, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, OR ANY WARRANTIES OR CONDITIONS ARISING OUT OF COURSE OF DEALING OR USAGE OF TRADE. NO ADVICE OR INFORMATION, WHETHER ORAL OR WRITTEN, PROVIDED BY GITHUB OR ANYWHERE ELSE WILL CREATE ANY WARRANTY OR CONDITION NOT EXPRESSLY STATED IN THIS AGREEMENT. **14. Defense of Claims; Release.** The Parties will defend each other against third-party claims, as and to the extent set forth in this Section 14 and will pay the amount of any resulting adverse final judgment or approved settlement, but only if the defending Party is promptly notified in writing of the claim and has the right to control the defense and any settlement of it. The Party being defended must provide the defending Party with all requested assistance, information, and authority. The defending Party will reimburse the other Party for reasonable out-of-pocket expenses it incurs in providing assistance, and will not settle or make any admissions with respect to a third-party claim without the other Party’s prior written consent, not to be unreasonably withheld or delayed. This Section 14 describes the Parties’ sole remedies and entire liability for such claims. -**14.1** *GitHub*. GitHub will defend Customer against any claim brought by an unaffiliated third party to the extent it alleges Customer’s authorized use of the Software infringes a copyright, patent, or trademark or misappropriates a trade secret of an unaffiliated third party. If GitHub is unable to resolve any such claim under commercially reasonable terms, it may, at its option, either: (a) modify, repair, or replace the Software (as applicable); or (b) terminate Customer’s subscription and refund any prepaid, unused subscription Fees. GitHub will have no obligation under this Section 14.1 for any such claim arising from: (i) the modification of the Software, or the combination, operation, or use of the Software with equipment, devices, software, systems, or data, other than as expressly authorized by this Agreement (including the Documentation); (ii) Customer’s failure to stop using the Software after receiving notice to do so; (iii) Customer’s obligations under Section 14.2; (iv) products or services (including use of the Software) that are provided by GitHub free of charge; or (v) access or use of Beta Previews. For purposes of GitHub’s obligation under this Section 14.1, the Software includes open source components incorporated by GitHub therein. +**14.1** _GitHub_. GitHub will defend Customer against any claim brought by an unaffiliated third party to the extent it alleges Customer’s authorized use of the Software infringes a copyright, patent, or trademark or misappropriates a trade secret of an unaffiliated third party. If GitHub is unable to resolve any such claim under commercially reasonable terms, it may, at its option, either: (a) modify, repair, or replace the Software (as applicable); or (b) terminate Customer’s subscription and refund any prepaid, unused subscription Fees. GitHub will have no obligation under this Section 14.1 for any such claim arising from: (i) the modification of the Software, or the combination, operation, or use of the Software with equipment, devices, software, systems, or data, other than as expressly authorized by this Agreement (including the Documentation); (ii) Customer’s failure to stop using the Software after receiving notice to do so; (iii) Customer’s obligations under Section 14.2; (iv) products or services (including use of the Software) that are provided by GitHub free of charge; or (v) access or use of Beta Previews. For purposes of GitHub’s obligation under this Section 14.1, the Software includes open source components incorporated by GitHub therein. -**14.2** *Customer*. Customer will defend GitHub against any claim brought by an unaffiliated third party arising from: (i) Customer Content that Customer uploads to the Software; (ii) Customer's violation of this Agreement, including Customer’s breach of confidentiality; (iii) Customer Modifications to the Software; or (iv) any third party-branded equipment, devices, software, systems, or data that Customer combines, operates, or uses with the Software. +**14.2** _Customer_. Customer will defend GitHub against any claim brought by an unaffiliated third party arising from: (i) Customer Content that Customer uploads to the Software; (ii) Customer's violation of this Agreement, including Customer’s breach of confidentiality; (iii) Customer Modifications to the Software; or (iv) any third party-branded equipment, devices, software, systems, or data that Customer combines, operates, or uses with the Software. **15. LIMITATION OF LIABILITY.** -**15.1** *No Indirect Damages*. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL EITHER PARTY BE LIABLE TO THE OTHER PARTY OR TO ANY THIRD PARTY FOR ANY INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES (INCLUDING FOR LOSS OF PROFITS, REVENUE, OR DATA) OR FOR THE COST OF OBTAINING SUBSTITUTE PRODUCTS ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, HOWEVER CAUSED, WHETHER SUCH LIABILITY ARISES FROM ANY CLAIM BASED UPON CONTRACT, WARRANTY, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, AND WHETHER OR NOT A PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. +**15.1** _No Indirect Damages_. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL EITHER PARTY BE LIABLE TO THE OTHER PARTY OR TO ANY THIRD PARTY FOR ANY INDIRECT, SPECIAL, INCIDENTAL, PUNITIVE, OR CONSEQUENTIAL DAMAGES (INCLUDING FOR LOSS OF PROFITS, REVENUE, OR DATA) OR FOR THE COST OF OBTAINING SUBSTITUTE PRODUCTS ARISING OUT OF OR IN CONNECTION WITH THIS AGREEMENT, HOWEVER CAUSED, WHETHER SUCH LIABILITY ARISES FROM ANY CLAIM BASED UPON CONTRACT, WARRANTY, TORT (INCLUDING NEGLIGENCE), STRICT LIABILITY OR OTHERWISE, AND WHETHER OR NOT A PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. -**15.2** *Limitation of Total Liability*. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL EITHER PARTY’S TOTAL CUMULATIVE LIABILITY UNDER THIS AGREEMENT FROM ALL CAUSES OF ACTION AND ALL THEORIES OF LIABILITY EXCEED THE FEES CUSTOMER HAS ACTUALLY PAID TO GITHUB DURING THE TWELVE (12) MONTHS PRECEDING THE CLAIM GIVING RISE TO SUCH LIABILITY. FOR PRODUCTS AND SERVICES THAT ARE PROVIDED FREE OF CHARGE, GITHUB’S LIABILITY IS LIMITED TO DIRECT DAMAGES UP TO $5,000.00 USD. FOR BETA PREVIEWS, GITHUB’S LIABILITY IS LIMITED TO DIRECT DAMAGES UP TO $500.00 USD. +**15.2** _Limitation of Total Liability_. TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW, IN NO EVENT WILL EITHER PARTY’S TOTAL CUMULATIVE LIABILITY UNDER THIS AGREEMENT FROM ALL CAUSES OF ACTION AND ALL THEORIES OF LIABILITY EXCEED THE FEES CUSTOMER HAS ACTUALLY PAID TO GITHUB DURING THE TWELVE (12) MONTHS PRECEDING THE CLAIM GIVING RISE TO SUCH LIABILITY. FOR PRODUCTS AND SERVICES THAT ARE PROVIDED FREE OF CHARGE, GITHUB’S LIABILITY IS LIMITED TO DIRECT DAMAGES UP TO $5,000.00 USD. FOR BETA PREVIEWS, GITHUB’S LIABILITY IS LIMITED TO DIRECT DAMAGES UP TO $500.00 USD. -**15.3** *Exceptions*. The exclusions and limitations set forth in this Section 15 will not apply to liability arising out of (1) Customer’s non-compliance with the license grant or license restrictions in Sections 2 and 3; (2) a Party’s defense obligations in Section 14; or (c) a Party’s breach of its confidentiality obligations in Section 16. +**15.3** _Exceptions_. The exclusions and limitations set forth in this Section 15 will not apply to liability arising out of (1) Customer’s non-compliance with the license grant or license restrictions in Sections 2 and 3; (2) a Party’s defense obligations in Section 14; or (c) a Party’s breach of its confidentiality obligations in Section 16. **16. Confidentiality.** -**16.1** *Definition of Confidential Information*. For the purposes of this Agreement, "Confidential Information" means any business or technical information that either Party discloses to the other, in writing, orally, or by any other means, including disclosures like computer programs, code, algorithms, data, know-how, formulas, processes, ideas, inventions (whether patentable or not), schematics and other technical, business, financial, and product development plans, names and expertise of employees and consultants, and customer lists. For the purposes of this Agreement, except as expressly set forth in Section 2.1, the source code of the Software will be deemed to be GitHub's Confidential Information, regardless of whether it is marked as such. +**16.1** _Definition of Confidential Information_. For the purposes of this Agreement, "Confidential Information" means any business or technical information that either Party discloses to the other, in writing, orally, or by any other means, including disclosures like computer programs, code, algorithms, data, know-how, formulas, processes, ideas, inventions (whether patentable or not), schematics and other technical, business, financial, and product development plans, names and expertise of employees and consultants, and customer lists. For the purposes of this Agreement, except as expressly set forth in Section 2.1, the source code of the Software will be deemed to be GitHub's Confidential Information, regardless of whether it is marked as such. -**16.2** *Restrictions on Use and Disclosure.* Neither Party will use the other Party's Confidential Information, except as permitted under this Agreement. Each Party agrees to maintain in confidence and protect the other Party's Confidential Information using at least the same degree of care as it uses for its own information of a similar nature, but in all events at least a reasonable degree of care. Each Party agrees to take all reasonable precautions to prevent any unauthorized disclosure of the other Party's Confidential Information, including, without limitation, disclosing Confidential Information only to its employees, independent contractors, consultants, and legal and financial advisors (collectively, "Representatives") (i) with a need to know such information, (ii) who are parties to appropriate agreements sufficient to comply with this Section 16, and (iii) who are informed of the non-disclosure obligations imposed by this Section 16. Each Party is responsible for all acts and omissions of its Representatives. The foregoing obligations will not restrict either Party from disclosing Confidential Information of the other Party pursuant to the order or requirement of a court, administrative agency, or other governmental body, provided that the Party required to make such a disclosure gives reasonable notice to the other Party to enable them to contest such order or requirement. The restrictions set forth in this Section 16 will survive the termination or expiration of this Agreement. +**16.2** _Restrictions on Use and Disclosure._ Neither Party will use the other Party's Confidential Information, except as permitted under this Agreement. Each Party agrees to maintain in confidence and protect the other Party's Confidential Information using at least the same degree of care as it uses for its own information of a similar nature, but in all events at least a reasonable degree of care. Each Party agrees to take all reasonable precautions to prevent any unauthorized disclosure of the other Party's Confidential Information, including, without limitation, disclosing Confidential Information only to its employees, independent contractors, consultants, and legal and financial advisors (collectively, "Representatives") (i) with a need to know such information, (ii) who are parties to appropriate agreements sufficient to comply with this Section 16, and (iii) who are informed of the non-disclosure obligations imposed by this Section 16. Each Party is responsible for all acts and omissions of its Representatives. The foregoing obligations will not restrict either Party from disclosing Confidential Information of the other Party pursuant to the order or requirement of a court, administrative agency, or other governmental body, provided that the Party required to make such a disclosure gives reasonable notice to the other Party to enable them to contest such order or requirement. The restrictions set forth in this Section 16 will survive the termination or expiration of this Agreement. -**16.3** *Exclusions*. The restrictions set forth in Section 16.2 will not apply with respect to any Confidential Information that: (i) was or becomes publicly known through no fault of the receiving party; (ii) was rightfully known or becomes rightfully known to the receiving party without confidential or proprietary restriction from a source other than the disclosing party who has a right to disclose it; (iii) is approved by the disclosing party for disclosure without restriction in a written document which is signed by a duly authorized officer of such disclosing party; or (iv) the receiving party independently develops without access to or use of the other Party's Confidential Information. +**16.3** _Exclusions_. The restrictions set forth in Section 16.2 will not apply with respect to any Confidential Information that: (i) was or becomes publicly known through no fault of the receiving party; (ii) was rightfully known or becomes rightfully known to the receiving party without confidential or proprietary restriction from a source other than the disclosing party who has a right to disclose it; (iii) is approved by the disclosing party for disclosure without restriction in a written document which is signed by a duly authorized officer of such disclosing party; or (iv) the receiving party independently develops without access to or use of the other Party's Confidential Information. **17. Term and Termination.** -**17.1** *Agreement* *Term*. This Agreement starts on the Agreement Effective Date and will continue in effect until this Agreement is terminated by a Party in accordance with this Section 17. If this Agreement is terminated before the expiration or termination of a Subscription Term, then any active Order Forms will remain in force pursuant to the terms of this Agreement. +**17.1** _Agreement_ _Term_. This Agreement starts on the Agreement Effective Date and will continue in effect until this Agreement is terminated by a Party in accordance with this Section 17. If this Agreement is terminated before the expiration or termination of a Subscription Term, then any active Order Forms will remain in force pursuant to the terms of this Agreement. -**17.2** *Termination for Convenience*. Either Party may terminate an Order Form, with or without cause, upon at least thirty (30) days written notice before the end of the then-current Subscription Term. +**17.2** _Termination for Convenience_. Either Party may terminate an Order Form, with or without cause, upon at least thirty (30) days written notice before the end of the then-current Subscription Term. -**17.3** *Termination for Material Breach*. Either Party may terminate this Agreement immediately upon notice if the other Party breaches a material obligation under this Agreement and fails to cure the breach within thirty (30) days from the date it receives notification. Either Party reserves the right to terminate this Agreement immediately upon written notice, but without giving the other Party a cure period, if Customer breaches any of the terms of this Agreement relating to GitHub's intellectual property (including Customer's compliance with the license grant and any license restrictions) or either Party's Confidential Information. +**17.3** _Termination for Material Breach_. Either Party may terminate this Agreement immediately upon notice if the other Party breaches a material obligation under this Agreement and fails to cure the breach within thirty (30) days from the date it receives notification. Either Party reserves the right to terminate this Agreement immediately upon written notice, but without giving the other Party a cure period, if Customer breaches any of the terms of this Agreement relating to GitHub's intellectual property (including Customer's compliance with the license grant and any license restrictions) or either Party's Confidential Information. -**17.4** *Effect of Termination; Survival.* When this Agreement terminates or expires, Customer may not execute additional Order Forms; however, the Agreement will remain in full force and effect for the remainder of any active Order Forms. When an Order Form terminates or expires, as to that Order Form: (i) the Subscription Term for any Software will immediately end; (ii) Customer will no longer have the right to use the Software, and any Subscription Licenses granted in the Order Form will automatically cease to exist as of the date of termination or expiration; (iii) if any Fees were owed prior to termination, Customer must pay those Fees immediately; (iv) Customer must destroy all copies of the Software in its possession or control, and certify in writing to GitHub that it has done so; and (v) each Party will promptly return to the other (or, if the other party requests it, destroy) all Confidential Information belonging to the other. Notwithstanding the foregoing, Customer may continue to access the Software to migrate its data for ninety (90) days after termination or expiration of this Agreement or an Order Form; however, Customer must not use the Software on a production basis during that time. Any terms or sections which by their nature should reasonably survive will survive the termination or expiration of this Agreement or an Order Form. +**17.4** _Effect of Termination; Survival._ When this Agreement terminates or expires, Customer may not execute additional Order Forms; however, the Agreement will remain in full force and effect for the remainder of any active Order Forms. When an Order Form terminates or expires, as to that Order Form: (i) the Subscription Term for any Software will immediately end; (ii) Customer will no longer have the right to use the Software, and any Subscription Licenses granted in the Order Form will automatically cease to exist as of the date of termination or expiration; (iii) if any Fees were owed prior to termination, Customer must pay those Fees immediately; (iv) Customer must destroy all copies of the Software in its possession or control, and certify in writing to GitHub that it has done so; and (v) each Party will promptly return to the other (or, if the other party requests it, destroy) all Confidential Information belonging to the other. Notwithstanding the foregoing, Customer may continue to access the Software to migrate its data for ninety (90) days after termination or expiration of this Agreement or an Order Form; however, Customer must not use the Software on a production basis during that time. Any terms or sections which by their nature should reasonably survive will survive the termination or expiration of this Agreement or an Order Form. **18. General Provisions.** -**18.1** *Compliance with Laws and Regulations.* Customer will comply with all applicable laws and regulations, including, but not limited to, data protection and employment laws and regulations, in its use of the Products. +**18.1** _Compliance with Laws and Regulations._ Customer will comply with all applicable laws and regulations, including, but not limited to, data protection and employment laws and regulations, in its use of the Products. -**18.2** *Data Protection Considerations for Use of GitHub Insights and Learning Lab for Enterprise Server.* If Customer’s planned use of GitHub Insights or Learning Lab for Enterprise Server involves processing personal data, Customer is solely responsible for determining whether or not to complete a data protection impact assessment or otherwise secure formal legal analysis of Customer’s planned use. It is in Customer’s sole discretion whether to use GitHub Insights or Learning Lab for Enterprise Server to process Customer’s employees’ and/or users’ data, and if Customer does so, Customer is solely responsible for conducting such processing in compliance with applicable law. +**18.2** _Data Protection Considerations for Use of GitHub Insights and Learning Lab for Enterprise Server._ If Customer’s planned use of GitHub Insights or Learning Lab for Enterprise Server involves processing personal data, Customer is solely responsible for determining whether or not to complete a data protection impact assessment or otherwise secure formal legal analysis of Customer’s planned use. It is in Customer’s sole discretion whether to use GitHub Insights or Learning Lab for Enterprise Server to process Customer’s employees’ and/or users’ data, and if Customer does so, Customer is solely responsible for conducting such processing in compliance with applicable law. -**18.3** *Governing Law; Venue.* For Customers domiciled in the United States, Canada, Mexico, or a country in Central or South America or the Caribbean (the "Americas"), this Agreement will be governed by and construed in accordance with the laws of the State of California, as if performed wholly within the state and without giving effect to the principles of conflict of law. For such Customers, any legal action or proceeding arising under this Agreement will be brought exclusively in the federal or state courts located in the Northern District of California and the parties hereby consent to personal jurisdiction and venue therein. If Customer’s principal office is outside the Americas, this Agreement will be governed by the laws of Ireland, any legal action or proceeding arising under this Agreement will be brought exclusively in the courts located in Dublin, and the Parties hereby consent to personal jurisdiction and venue therein. The Parties expressly agree that the United Nations Convention on Contracts for the International Sale of Goods and the Uniform Computer Information Transactions Act will not apply to this Agreement. Notwithstanding the foregoing, GitHub may bring a claim for equitable relief in any court with proper jurisdiction. +**18.3** _Governing Law; Venue._ For Customers domiciled in the United States, Canada, Mexico, or a country in Central or South America or the Caribbean (the "Americas"), this Agreement will be governed by and construed in accordance with the laws of the State of California, as if performed wholly within the state and without giving effect to the principles of conflict of law. For such Customers, any legal action or proceeding arising under this Agreement will be brought exclusively in the federal or state courts located in the Northern District of California and the parties hereby consent to personal jurisdiction and venue therein. If Customer’s principal office is outside the Americas, this Agreement will be governed by the laws of Ireland, any legal action or proceeding arising under this Agreement will be brought exclusively in the courts located in Dublin, and the Parties hereby consent to personal jurisdiction and venue therein. The Parties expressly agree that the United Nations Convention on Contracts for the International Sale of Goods and the Uniform Computer Information Transactions Act will not apply to this Agreement. Notwithstanding the foregoing, GitHub may bring a claim for equitable relief in any court with proper jurisdiction. -**18.4** *Government Users.* The Products and Documentation were developed solely with private funds and are considered "Commercial Computer Software" and "Commercial Computer Software Documentation" as described in Federal Acquisition Regulations 12.212 and 27.405-3, and Defense Federal Acquisition Regulation Supplement 227.7202-3. The Products are licensed to the United States Government end user as restricted computer software and limited rights data. No technical data or computer software is developed under this Agreement. Any use, disclosure, modification, distribution, or reproduction of the Products or Documentation by the United States Government or its contractors is subject to the restrictions set forth in this Agreement. All other use is prohibited. +**18.4** _Government Users._ The Products and Documentation were developed solely with private funds and are considered "Commercial Computer Software" and "Commercial Computer Software Documentation" as described in Federal Acquisition Regulations 12.212 and 27.405-3, and Defense Federal Acquisition Regulation Supplement 227.7202-3. The Products are licensed to the United States Government end user as restricted computer software and limited rights data. No technical data or computer software is developed under this Agreement. Any use, disclosure, modification, distribution, or reproduction of the Products or Documentation by the United States Government or its contractors is subject to the restrictions set forth in this Agreement. All other use is prohibited. -**18.5** *Export.* The Products are subject to export and sanctions restrictions administered by the U.S. Government and import restrictions by certain foreign governments, and Customer will comply with all applicable export and import laws and regulations in Customer’s use of the Products. Customer must not, and must not allow any third party to, remove or export from the United States or allow the export or re-export of any part of the Products or any direct product thereof: (i) into (or to a national or resident of) any embargoed or terrorist-supporting country or territory; (ii) to anyone on the U.S. Commerce Department’s Entity List or Table of Denial Orders, anyone blocked pursuant to rules administered by the U.S. Office of Foreign Assets Control, including anyone on the List of Specially Designated Nationals or sanctioned country “Government” entities, or anyone subject to other applicable prohibited or sanctioned persons lists; (iii) to any country or territory to which such export or re-export is restricted or prohibited, or as to which the U.S. government or any agency thereof requires an export license or other governmental approval at the time of export or re-export without first obtaining such license or approval; or (iv) otherwise in violation of any export, sanctions, or import restrictions, laws or regulations of any United States or foreign agency or authority. Customer represents and warrants that Customer is not located in under the control of, or a national or resident of any such prohibited country or territory or on any such prohibited party list. GitHub Enterprise Server is a self-hosted virtual appliance that can be run within Customer’s own datacenter or virtual private cloud. As such, GitHub Enterprise Server can be used to store ITAR or other export-controlled information. However, Customer is responsible for ensuring such compliance. Customer acknowledges and agrees that the Products are restricted from being used for the design or development of nuclear, chemical, or biological weapons or missile technology without the prior required permission of the U.S. government. +**18.5** _Export._ The Products are subject to export and sanctions restrictions administered by the U.S. Government and import restrictions by certain foreign governments, and Customer will comply with all applicable export and import laws and regulations in Customer’s use of the Products. Customer must not, and must not allow any third party to, remove or export from the United States or allow the export or re-export of any part of the Products or any direct product thereof: (i) into (or to a national or resident of) any embargoed or terrorist-supporting country or territory; (ii) to anyone on the U.S. Commerce Department’s Entity List or Table of Denial Orders, anyone blocked pursuant to rules administered by the U.S. Office of Foreign Assets Control, including anyone on the List of Specially Designated Nationals or sanctioned country “Government” entities, or anyone subject to other applicable prohibited or sanctioned persons lists; (iii) to any country or territory to which such export or re-export is restricted or prohibited, or as to which the U.S. government or any agency thereof requires an export license or other governmental approval at the time of export or re-export without first obtaining such license or approval; or (iv) otherwise in violation of any export, sanctions, or import restrictions, laws or regulations of any United States or foreign agency or authority. Customer represents and warrants that Customer is not located in under the control of, or a national or resident of any such prohibited country or territory or on any such prohibited party list. GitHub Enterprise Server is a self-hosted virtual appliance that can be run within Customer’s own datacenter or virtual private cloud. As such, GitHub Enterprise Server can be used to store ITAR or other export-controlled information. However, Customer is responsible for ensuring such compliance. Customer acknowledges and agrees that the Products are restricted from being used for the design or development of nuclear, chemical, or biological weapons or missile technology without the prior required permission of the U.S. government. -**18.6** *No Publicity without Permission.* GitHub may identify Customer as a customer to current and prospective customers. However, GitHub may not use Customer’s name or logo in any advertising or marketing materials without Customer’s permission. +**18.6** _No Publicity without Permission._ GitHub may identify Customer as a customer to current and prospective customers. However, GitHub may not use Customer’s name or logo in any advertising or marketing materials without Customer’s permission. -**18.7** *Assignment*. Neither Party may assign or otherwise transfer this Agreement, in whole or in part, without the other Party's prior written consent, such consent not to be unreasonably withheld, and any attempt to do so will be null and void, except that GitHub may assign this Agreement in its entirety, upon notice to the other party but without the other Party's consent, in connection with a merger, acquisition, corporate reorganization, or sale of all or substantially all of the assigning party's business or assets. +**18.7** _Assignment_. Neither Party may assign or otherwise transfer this Agreement, in whole or in part, without the other Party's prior written consent, such consent not to be unreasonably withheld, and any attempt to do so will be null and void, except that GitHub may assign this Agreement in its entirety, upon notice to the other party but without the other Party's consent, in connection with a merger, acquisition, corporate reorganization, or sale of all or substantially all of the assigning party's business or assets. -**18.8** *Notices*. Unless otherwise stated herein, any notice, request, demand or other communication under this Agreement must be in writing (e-mail is acceptable), must reference this Agreement, and will be deemed to be properly given: (i) upon receipt, if delivered personally; (ii) one (1) business day following confirmation of receipt by the intended recipient, if by e-mail; (iii) five (5) business days after it is sent by registered or certified mail, with written confirmation of receipt and email; or (iv) three (3) business days after deposit with an internationally recognized express courier and email, with written confirmation of receipt. Notices can be sent to the address(es) set forth in this Agreement, unless a Party notifies the other that those addresses have changed. +**18.8** _Notices_. Unless otherwise stated herein, any notice, request, demand or other communication under this Agreement must be in writing (e-mail is acceptable), must reference this Agreement, and will be deemed to be properly given: (i) upon receipt, if delivered personally; (ii) one (1) business day following confirmation of receipt by the intended recipient, if by e-mail; (iii) five (5) business days after it is sent by registered or certified mail, with written confirmation of receipt and email; or (iv) three (3) business days after deposit with an internationally recognized express courier and email, with written confirmation of receipt. Notices can be sent to the address(es) set forth in this Agreement, unless a Party notifies the other that those addresses have changed. -**18.9** *Force Majeure*. GitHub will be excused from liability to the extent that it is unable to perform any obligation under this Agreement due to extraordinary causes beyond its reasonable control, including acts of God, natural disasters, strikes, lockouts, riots, acts of war, epidemics, or power, telecommunication or network failures. +**18.9** _Force Majeure_. GitHub will be excused from liability to the extent that it is unable to perform any obligation under this Agreement due to extraordinary causes beyond its reasonable control, including acts of God, natural disasters, strikes, lockouts, riots, acts of war, epidemics, or power, telecommunication or network failures. -**18.10** *Independent Contractors*. The Parties are each independent contractors with respect to the subject matter of this Agreement. Nothing contained in this Agreement will be deemed or construed in any manner to create a legal association, partnership, joint venture, employment, agency, fiduciary, or other similar relationship between the Parties, and neither Party can bind the other contractually. +**18.10** _Independent Contractors_. The Parties are each independent contractors with respect to the subject matter of this Agreement. Nothing contained in this Agreement will be deemed or construed in any manner to create a legal association, partnership, joint venture, employment, agency, fiduciary, or other similar relationship between the Parties, and neither Party can bind the other contractually. -**18.11** *Waiver*. A Party's obligations under this Agreement must only be waived in a writing signed by an authorized representative of the other Party, which waiver will be effective only with respect to the specific obligation described. No failure or delay by a Party to this Agreement in exercising any right hereunder will operate as a waiver thereof, nor will any single or partial exercise thereof preclude any other or further exercise thereof or the exercise of any right hereunder at law or equity. +**18.11** _Waiver_. A Party's obligations under this Agreement must only be waived in a writing signed by an authorized representative of the other Party, which waiver will be effective only with respect to the specific obligation described. No failure or delay by a Party to this Agreement in exercising any right hereunder will operate as a waiver thereof, nor will any single or partial exercise thereof preclude any other or further exercise thereof or the exercise of any right hereunder at law or equity. -**18.12** *Entire Agreement*. This Agreement, including each Order Form and SOW, constitutes the entire agreement and understanding of the Parties with respect to its subject matter, and supersedes all prior or contemporaneous understandings and agreements, whether oral or written, between the Parties with respect to its subject matter. The terms of any purchase order, written terms or conditions, or other document that Customer submits to GitHub that contains terms that are different from, in conflict with, or in addition to the terms of this Agreement, SOW or any Order Form will be void and of no effect. +**18.12** _Entire Agreement_. This Agreement, including each Order Form and SOW, constitutes the entire agreement and understanding of the Parties with respect to its subject matter, and supersedes all prior or contemporaneous understandings and agreements, whether oral or written, between the Parties with respect to its subject matter. The terms of any purchase order, written terms or conditions, or other document that Customer submits to GitHub that contains terms that are different from, in conflict with, or in addition to the terms of this Agreement, SOW or any Order Form will be void and of no effect. -**18.13** *Amendments; Order of Precedence*. GitHub reserves the right to amend this Agreement at any time and will update the terms and conditions of this Agreement in the event of any such amendments. Changes to this Agreement will become effective upon the anniversary of Customer's then-current Subscription Term. In the event of a conflict between this Agreement and an Order Form, an Order Form will govern with respect to that order only. This Agreement and any addenda, including an Order Form, must control and no modification, change, or amendment of this Agreement will be binding upon the Parties or supersede the terms of this Agreement unless it is in writing, and is duly signed by each Party's authorized representative. +**18.13** _Amendments; Order of Precedence_. GitHub reserves the right to amend this Agreement at any time and will update the terms and conditions of this Agreement in the event of any such amendments. Changes to this Agreement will become effective upon the anniversary of Customer's then-current Subscription Term. In the event of a conflict between this Agreement and an Order Form, an Order Form will govern with respect to that order only. This Agreement and any addenda, including an Order Form, must control and no modification, change, or amendment of this Agreement will be binding upon the Parties or supersede the terms of this Agreement unless it is in writing, and is duly signed by each Party's authorized representative. -**18.14** *Severability*. If any provision of this Agreement is deemed by a court of competent jurisdiction to be illegal, invalid, or unenforceable, the court will modify or reform this Agreement to give as much effect as possible to that provision. Any provision that cannot be modified or reformed in this way will be deemed deleted and the remaining provisions of this Agreement will continue in full force and effect. +**18.14** _Severability_. If any provision of this Agreement is deemed by a court of competent jurisdiction to be illegal, invalid, or unenforceable, the court will modify or reform this Agreement to give as much effect as possible to that provision. Any provision that cannot be modified or reformed in this way will be deemed deleted and the remaining provisions of this Agreement will continue in full force and effect. diff --git a/content/webhooks-and-events/webhooks/testing-webhooks.md b/content/webhooks-and-events/webhooks/testing-webhooks.md index 545bdaa5e1..d5fbf70677 100644 --- a/content/webhooks-and-events/webhooks/testing-webhooks.md +++ b/content/webhooks-and-events/webhooks/testing-webhooks.md @@ -28,7 +28,7 @@ Every webhook has its own "Recent Deliveries" section, which lists, at a glance ## Digging into results -By expanding an individual delivery, you'll be able to witness *precisely* +By expanding an individual delivery, you'll be able to witness _precisely_ what information GitHub is attempting to send to your server. This includes both the HTTP Request and Response. diff --git a/data/reusables/actions/policy-label-for-select-actions-workflows.md b/data/reusables/actions/policy-label-for-select-actions-workflows.md index 38b50f3e4b..fcd775467b 100644 --- a/data/reusables/actions/policy-label-for-select-actions-workflows.md +++ b/data/reusables/actions/policy-label-for-select-actions-workflows.md @@ -1 +1 @@ -{% ifversion actions-workflow-policy %}{% ifversion ghec or ghes or ghae %}**Allow enterprise, and select non-enterprise, actions and reusable workflows**{% else %}**Allow *OWNER*, and select non-*OWNER*, actions and reusable workflows**{% endif %}{% else %}**Allow select actions**{% endif %} +{% ifversion actions-workflow-policy %}{% ifversion ghec or ghes or ghae %}**Allow enterprise, and select non-enterprise, actions and reusable workflows**{% else %}**Allow _OWNER_, and select non-_OWNER_, actions and reusable workflows**{% endif %}{% else %}**Allow select actions**{% endif %} diff --git a/data/reusables/actions/postgres-environment-variables.md b/data/reusables/actions/postgres-environment-variables.md index ea2d30a367..2e1f481b58 100644 --- a/data/reusables/actions/postgres-environment-variables.md +++ b/data/reusables/actions/postgres-environment-variables.md @@ -1 +1 @@ -The *client.js* script looks for the `POSTGRES_HOST` and `POSTGRES_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to PostgreSQL" step to make them available to the *client.js* script. For more information about the script, see "[Testing the PostgreSQL service container](#testing-the-postgresql-service-container)." +The _client.js_ script looks for the `POSTGRES_HOST` and `POSTGRES_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to PostgreSQL" step to make them available to the _client.js_ script. For more information about the script, see "[Testing the PostgreSQL service container](#testing-the-postgresql-service-container)." diff --git a/data/reusables/actions/redis-environment-variables.md b/data/reusables/actions/redis-environment-variables.md index 739b793248..5b6d26ba54 100644 --- a/data/reusables/actions/redis-environment-variables.md +++ b/data/reusables/actions/redis-environment-variables.md @@ -1 +1 @@ -The *client.js* script looks for the `REDIS_HOST` and `REDIS_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to Redis" step to make them available to the *client.js* script. For more information about the script, see "[Testing the Redis service container](#testing-the-redis-service-container)." +The _client.js_ script looks for the `REDIS_HOST` and `REDIS_PORT` environment variables to create the client. The workflow sets those two environment variables as part of the "Connect to Redis" step to make them available to the _client.js_ script. For more information about the script, see "[Testing the Redis service container](#testing-the-redis-service-container)." diff --git a/data/reusables/actions/service-container-add-script.md b/data/reusables/actions/service-container-add-script.md index d31bd24005..e07d3d85a6 100644 --- a/data/reusables/actions/service-container-add-script.md +++ b/data/reusables/actions/service-container-add-script.md @@ -1 +1 @@ -Add a new file called *client.js* to your repository with the following code. +Add a new file called _client.js_ to your repository with the following code. diff --git a/data/reusables/actions/setup-node-intro.md b/data/reusables/actions/setup-node-intro.md index 2d9c4b1726..7a7baafb23 100644 --- a/data/reusables/actions/setup-node-intro.md +++ b/data/reusables/actions/setup-node-intro.md @@ -1 +1 @@ -You can use the `setup-node` action to create a local *.npmrc* file on the runner that configures the default registry and scope. The `setup-node` action also accepts an authentication token as input, used to access private registries or publish node packages. For more information, see [`setup-node`](https://github.com/actions/setup-node/). +You can use the `setup-node` action to create a local _.npmrc_ file on the runner that configures the default registry and scope. The `setup-node` action also accepts an authentication token as input, used to access private registries or publish node packages. For more information, see [`setup-node`](https://github.com/actions/setup-node/). diff --git a/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md b/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md index b3616b7ffe..2c960dafba 100644 --- a/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md +++ b/data/reusables/actions/workflows/section-run-on-specific-branches-or-tags.md @@ -7,7 +7,7 @@ Use the `tags` filter when you want to include tag name patterns or when you wan If you define only `tags`/`tags-ignore` or only `branches`/`branches-ignore`, the workflow won't run for events affecting the undefined Git ref. If you define neither `tags`/`tags-ignore` or `branches`/`branches-ignore`, the workflow will run for events affecting either branches or tags. If you define both `branches`/`branches-ignore` and [`paths`/`paths-ignore`](/actions/using-workflows/workflow-syntax-for-github-actions#onpushpull_requestpull_request_targetpathspaths-ignore), the workflow will only run when both filters are satisfied. -The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `branches`, `branches-ignore`, `tags`, and `tags-ignore` keywords accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch or tag name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." #### Example: Including branches and tags diff --git a/data/reusables/actions/workflows/section-specifying-branches.md b/data/reusables/actions/workflows/section-specifying-branches.md index 24f46598f5..3d225ada01 100644 --- a/data/reusables/actions/workflows/section-specifying-branches.md +++ b/data/reusables/actions/workflows/section-specifying-branches.md @@ -1,7 +1,7 @@ When using the `workflow_run` event, you can specify what branches the triggering workflow must run on in order to trigger your workflow. -The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to *escape* each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." +The `branches` and `branches-ignore` filters accept glob patterns that use characters like `*`, `**`, `+`, `?`, `!` and others to match more than one branch name. If a name contains any of these characters and you want a literal match, you need to _escape_ each of these special characters with `\`. For more information about glob patterns, see the "[AUTOTITLE](/actions/using-workflows/workflow-syntax-for-github-actions#filter-pattern-cheat-sheet)." For example, a workflow with the following trigger will only run when the workflow named `Build` runs on a branch whose name starts with `releases/`: diff --git a/data/reusables/audit_log/audit-log-action-categories.md b/data/reusables/audit_log/audit-log-action-categories.md index a5a2fa7126..6a6635e0f3 100644 --- a/data/reusables/audit_log/audit-log-action-categories.md +++ b/data/reusables/audit_log/audit-log-action-categories.md @@ -83,7 +83,7 @@ {%- endif %} {%- ifversion fpt or ghec %} | `members_can_view_dependency_insights` | Contains organization-level configuration activities allowing organization members to view dependency insights. -| `migration` | Contains activities related to transferring data from a *source* location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a *target* {% data variables.product.prodname_ghe_server %} instance. +| `migration` | Contains activities related to transferring data from a _source_ location (such as a {% data variables.product.prodname_dotcom_the_website %} organization or a {% data variables.product.prodname_ghe_server %} instance) to a _target_ {% data variables.product.prodname_ghe_server %} instance. {%- endif %} | `oauth_access` | Contains activities related to OAuth access tokens. | `oauth_application` | Contains activities related to {% data variables.product.prodname_oauth_app %}s. diff --git a/data/reusables/dependabot/automatically-pause-dependabot-updates.md b/data/reusables/dependabot/automatically-pause-dependabot-updates.md index fe34d474cf..c4e3d0c2ca 100644 --- a/data/reusables/dependabot/automatically-pause-dependabot-updates.md +++ b/data/reusables/dependabot/automatically-pause-dependabot-updates.md @@ -5,7 +5,7 @@ The automatic deactivation of {% data variables.product.prodname_dependabot %} u An active repository is a repository for which a user (not {% data variables.product.prodname_dependabot %}) has carried out _any_ of the actions below in the last 90 days: - Merge or close a {% data variables.product.prodname_dependabot %} pull request on the repository. -- Make a change to the *dependabot.yml* file for the repository. +- Make a change to the _dependabot.yml_ file for the repository. - Manually trigger a security update or a version update. - Enable {% data variables.product.prodname_dependabot_security_updates %} for the repository. - Use `@dependabot` commands on pull requests. @@ -16,4 +16,4 @@ When {% data variables.product.prodname_dependabot %} is paused, {% data variabl As soon as a maintainer interacts with a {% data variables.product.prodname_dependabot %} pull request again, {% data variables.product.prodname_dependabot %} will unpause itself: - Security updates are automatically resumed for {% data variables.product.prodname_dependabot_alerts %}. -- Version updates are automatically resumed with the schedule specified in the *dependabot.yml* file. +- Version updates are automatically resumed with the schedule specified in the _dependabot.yml_ file. diff --git a/data/reusables/dependabot/check-in-dependabot-yml.md b/data/reusables/dependabot/check-in-dependabot-yml.md index 629a740586..0ed3a69e2d 100644 --- a/data/reusables/dependabot/check-in-dependabot-yml.md +++ b/data/reusables/dependabot/check-in-dependabot-yml.md @@ -1 +1 @@ -1. Check the *dependabot.yml* configuration file in to the `.github` directory of the repository. +1. Check the _dependabot.yml_ configuration file in to the `.github` directory of the repository. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index 7c419fc8df..c0dcd89576 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -1,5 +1,5 @@ The following table shows, for each package manager: -- The YAML value to use in the *dependabot.yml* file +- The YAML value to use in the _dependabot.yml_ file - The supported versions of the package manager - Whether dependencies in private {% data variables.product.prodname_dotcom %} repositories or registries are supported - Whether vendored dependencies are supported @@ -31,7 +31,7 @@ Terraform | `terraform` | >= 0.13, <= 1.3.x | {% octicon "check" aria {% tip %} -**Tip:** For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your *dependabot.yml* file. +**Tip:** For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your _dependabot.yml_ file. {% endtip %} 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 3465598ef8..e36805d0d3 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,4 +1,4 @@ -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. +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 diff --git a/data/reusables/enterprise_installation/necessary_ports.md b/data/reusables/enterprise_installation/necessary_ports.md index 041209e5b4..20df4e9f21 100644 --- a/data/reusables/enterprise_installation/necessary_ports.md +++ b/data/reusables/enterprise_installation/necessary_ports.md @@ -2,11 +2,11 @@ |------|---------|------------------------------------------------------------| | 22 | SSH | Git over SSH access. Clone, fetch, and push operations to public/private repositories supported. | | 25 | SMTP | SMTP with encryption (STARTTLS) support. | -| 80 | HTTP | Web application access. *All requests are redirected to the HTTPS port when SSL is enabled.* | -| 122 | SSH | Instance shell access. *The default SSH port (22) is dedicated to application git+ssh network traffic.* | +| 80 | HTTP | Web application access. _All requests are redirected to the HTTPS port when SSL is enabled._ | +| 122 | SSH | Instance shell access. _The default SSH port (22) is dedicated to application git+ssh network traffic._ | | 161/UDP | SNMP | Required for network monitoring protocol operation. | | 443 | HTTPS | Web application and Git over HTTPS access. | | 1194/UDP | VPN | Secure replication network tunnel in high availability configuration. | -| 8080 | HTTP | Plain-text web based {% data variables.enterprise.management_console %}. *Not required unless SSL is disabled manually.* | -| 8443 | HTTPS | Secure web based {% data variables.enterprise.management_console %}. *Required for basic installation and configuration.* | -| 9418 | Git | Simple Git protocol port. Clone and fetch operations to public repositories only. *Unencrypted network communication.* {% data reusables.enterprise_installation.when-9418-necessary %} | +| 8080 | HTTP | Plain-text web based {% data variables.enterprise.management_console %}. _Not required unless SSL is disabled manually._ | +| 8443 | HTTPS | Secure web based {% data variables.enterprise.management_console %}. _Required for basic installation and configuration._ | +| 9418 | Git | Simple Git protocol port. Clone and fetch operations to public repositories only. _Unencrypted network communication._ {% data reusables.enterprise_installation.when-9418-necessary %} | diff --git a/data/reusables/organizations/reseller-ask-to-become-billing-manager.md b/data/reusables/organizations/reseller-ask-to-become-billing-manager.md index 3c4cf5a145..249d2b1d14 100644 --- a/data/reusables/organizations/reseller-ask-to-become-billing-manager.md +++ b/data/reusables/organizations/reseller-ask-to-become-billing-manager.md @@ -1 +1 @@ -If you're not a billing manager for the organization, ask your client to have an *owner* of the organization [add you to the organization as a billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization). +If you're not a billing manager for the organization, ask your client to have an _owner_ of the organization [add you to the organization as a billing manager](/organizations/managing-peoples-access-to-your-organization-with-roles/adding-a-billing-manager-to-your-organization). diff --git a/data/reusables/organizations/team-discussions-permissions.md b/data/reusables/organizations/team-discussions-permissions.md index a90cc05c41..ce37dbdee6 100644 --- a/data/reusables/organizations/team-discussions-permissions.md +++ b/data/reusables/organizations/team-discussions-permissions.md @@ -1 +1 @@ -*Private* posts are only visible to team members and organization owners, and *public* posts are visible to all members of the organization. +_Private_ posts are only visible to team members and organization owners, and _public_ posts are visible to all members of the organization. diff --git a/data/reusables/package_registry/add-npmrc-to-repo-step.md b/data/reusables/package_registry/add-npmrc-to-repo-step.md index bbdd334086..b50b379fda 100644 --- a/data/reusables/package_registry/add-npmrc-to-repo-step.md +++ b/data/reusables/package_registry/add-npmrc-to-repo-step.md @@ -1 +1 @@ -3. Add the *.npmrc* file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." +3. Add the _.npmrc_ file to the repository where {% data variables.product.prodname_registry %} can find your project. For more information, see "[AUTOTITLE](/repositories/working-with-files/managing-files/adding-a-file-to-a-repository)." diff --git a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md index 8728373612..4ecebf610f 100644 --- a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md +++ b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md @@ -1 +1 @@ -{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the {% data variables.product.prodname_registry %} repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your *~/.m2/settings.xml* file. +{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the {% data variables.product.prodname_registry %} repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your _~/.m2/settings.xml_ file. diff --git a/data/reusables/package_registry/checksum-maven-plugin.md b/data/reusables/package_registry/checksum-maven-plugin.md index 3d980144e1..312be929f4 100644 --- a/data/reusables/package_registry/checksum-maven-plugin.md +++ b/data/reusables/package_registry/checksum-maven-plugin.md @@ -1,5 +1,5 @@ {%- ifversion ghae %} -1. In the `plugins` element of the *pom.xml* file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. +1. In the `plugins` element of the _pom.xml_ file, add the [checksum-maven-plugin](https://search.maven.org/artifact/net.nicoulaj.maven.plugins/checksum-maven-plugin) plugin, and configure the plugin to send at least SHA-256 checksums. ```xml diff --git a/data/reusables/package_registry/verify_repository_field.md b/data/reusables/package_registry/verify_repository_field.md index 1826aa08c9..462e08bc54 100644 --- a/data/reusables/package_registry/verify_repository_field.md +++ b/data/reusables/package_registry/verify_repository_field.md @@ -1 +1 @@ -1. Verify the `repository` field in your project's *package.json*. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. +1. Verify the `repository` field in your project's _package.json_. The `repository` field must match the URL for your {% data variables.product.prodname_dotcom %} repository. For example, if your repository URL is `github.com/my-org/test` then the repository field should be `https://github.com/my-org/test.git`. diff --git a/data/reusables/ssh/add-ssh-key-to-ssh-agent.md b/data/reusables/ssh/add-ssh-key-to-ssh-agent.md index 43243b9f14..0f6111156e 100644 --- a/data/reusables/ssh/add-ssh-key-to-ssh-agent.md +++ b/data/reusables/ssh/add-ssh-key-to-ssh-agent.md @@ -1 +1 @@ -If you created your key with a different name, or if you are adding an existing key that has a different name, replace *id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}* in the command with the name of your private key file. +If you created your key with a different name, or if you are adding an existing key that has a different name, replace _id_{% ifversion ghae %}rsa{% else %}ed25519{% endif %}_ in the command with the name of your private key file. diff --git a/src/content-linter/README.md b/src/content-linter/README.md index 381a00a470..fe1374fa0e 100644 --- a/src/content-linter/README.md +++ b/src/content-linter/README.md @@ -24,6 +24,7 @@ We are using the [markdownlint](https://github.com/DavidAnson/markdownlint) fram | [MD042](https://github.com/DavidAnson/markdownlint/blob/main/doc/md042.md) | Do not allow empty links. | error | | [MD047](https://github.com/DavidAnson/markdownlint/blob/main/doc/md047.md) | All files should end with a new line character. | warning | | [MD049](https://github.com/DavidAnson/markdownlint/blob/main/doc/md049.md) | All emphasis styling should use underscores. | warning | +| [MD050](https://github.com/DavidAnson/markdownlint/blob/main/doc/md050.md) | All strong styling should use asterisks. | warning | | [MD011](https://github.com/DavidAnson/markdownlint/blob/main/doc/md011.md) | Make sure that link syntax is not reversed. | error | | [MD111](./linting-rules/image-alt-text-length.js) | Images alternate text should be between 40-150 characters. | warning | | [MD112](./linting-rules/image-alt-text-end-punctuation.js) | Images alternate text should end with a punctuation. | error | diff --git a/src/content-linter/scripts/markdownlint.js b/src/content-linter/scripts/markdownlint.js index b8a9f7fbdd..825195ce81 100755 --- a/src/content-linter/scripts/markdownlint.js +++ b/src/content-linter/scripts/markdownlint.js @@ -76,6 +76,7 @@ async function main() { }, MD047: true, MD049: { style: 'underscore' }, + MD050: { style: 'asterisk' }, MD111: true, MD112: true, MD113: true,