зеркало из https://github.com/github/docs.git
[Improvement]: Fix duplicate headers for Core Productivity (#34405)
Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Laura Coursen <lecoursen@github.com>
This commit is contained in:
Sophie
GitHub
Родитель
bb7575d0bb
Коммит
ed79ca1e2b
|
|
@ -17,10 +17,12 @@ topics:
|
|||
- Notifications
|
||||
shortTitle: Find your username or email
|
||||
---
|
||||
{% mac %}
|
||||
|
||||
|
||||
## {% data variables.product.prodname_desktop %} users
|
||||
|
||||
{% mac %}
|
||||
|
||||
1. In the **GitHub Desktop** menu, click **Preferences**.
|
||||
2. In the Preferences window, verify the following:
|
||||
- To view your {% data variables.product.product_name %} username, click **Accounts**.
|
||||
|
|
@ -30,13 +32,11 @@ shortTitle: Find your username or email
|
|||
|
||||
{% windows %}
|
||||
|
||||
## {% data variables.product.prodname_desktop %} users
|
||||
|
||||
1. In the **File** menu, click **Options**.
|
||||
2. In the Options window, verify the following:
|
||||
- To view your {% data variables.product.product_name %} username, click **Accounts**.
|
||||
- To view your Git email, click **Git**. Note that this email is not guaranteed to be [your primary {% data variables.product.product_name %} email](/articles/changing-your-primary-email-address).
|
||||
|
||||
|
||||
{% endwindows %}
|
||||
|
||||
## Finding your username in your `user.name` configuration
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ If you have users that want to receive billing reports, you can add their email
|
|||
|
||||
{% data reusables.dotcom_billing.org-billing-perms %}
|
||||
|
||||
### Adding a recipient for billing notifications
|
||||
### Adding a recipient for billing notifications for your organization
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
1. Under "Billing management", to the right of "Email recipients", click **Add**.
|
||||
|
|
@ -53,7 +53,7 @@ If you have users that want to receive billing reports, you can add their email
|
|||
1. Type the email address of the recipient, then click **Add**.
|
||||
|
||||
|
||||
### Changing the primary recipient for billing notifications
|
||||
### Changing the primary recipient for billing notifications for your organization
|
||||
|
||||
One address must always be designated as the primary recipient. The address with this designation can't be removed until a new primary recipient is selected.
|
||||
|
||||
|
|
@ -62,7 +62,7 @@ One address must always be designated as the primary recipient. The address with
|
|||
1. To the right of the email address, use the "Edit" drop-down menu, and click **Mark as primary**.
|
||||
|
||||
|
||||
### Removing a recipient from billing notifications
|
||||
### Removing a recipient from billing notifications for your organization
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
1. Under "Email recipients", find the email address you want to remove.
|
||||
|
|
@ -82,7 +82,7 @@ Only enterprise members with the owner or billing manager role can access or cha
|
|||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. Click **Billing emails**.
|
||||
1. Click **Billing emails**.
|
||||
2. Under "Email recipients", to the right of the billing email address, click **Edit**.
|
||||
|
||||
2. Type a valid email address, then click **Update**.
|
||||
|
|
@ -90,27 +90,27 @@ Only enterprise members with the owner or billing manager role can access or cha
|
|||
|
||||
## Managing additional recipients for your enterprise's billing email
|
||||
|
||||
If you have users that want to receive billing reports, you can add their email addresses as billing email recipients.
|
||||
If you have users that want to receive billing reports, you can add their email addresses as billing email recipients.
|
||||
|
||||
Only enterprise members with the owner or billing manager role can access or change billing settings for your enterprise. For more information, see "[Managing users in your enterprise](/admin/user-management/managing-users-in-your-enterprise/roles-in-an-enterprise)."
|
||||
|
||||
### Adding a recipient for billing notifications
|
||||
### Adding a recipient for billing notifications for your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. Click **Billing emails**.
|
||||
1. Click **Billing emails**.
|
||||
2. Under "Email recipients", to the right of the billing email address, click **Add**.
|
||||
|
||||
3. Type the email address of the recipient, then click **Add**.
|
||||
|
||||
|
||||
### Removing a recipient from billing notifications
|
||||
### Removing a recipient from billing notifications for your enterprise
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. Click **Billing emails**.
|
||||
1. Click **Billing emails**.
|
||||
2. Under "Email recipients", find the email address you want to remove.
|
||||
3. For the user's entry in the list, click **Edit**.
|
||||
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ topics:
|
|||
|
||||
The template does not contain a `name` field, which means it is not clear what to call your issue template when giving users a list of options.
|
||||
|
||||
### Example
|
||||
### Example of "required top level key `name` is missing" error
|
||||
|
||||
```yaml
|
||||
description: "Thank you for reporting a bug!"
|
||||
|
|
@ -34,7 +34,7 @@ description: "Thank you for reporting a bug!"
|
|||
|
||||
This error message means that a permitted key has been provided, but its value cannot be parsed as the data type is not supported.
|
||||
|
||||
### Example
|
||||
### Example of "`key` must be a string" error
|
||||
|
||||
The `description` below is being parsed as a Boolean, but it should be a string.
|
||||
|
||||
|
|
@ -73,7 +73,7 @@ description: "File a bug report"
|
|||
|
||||
An unexpected key was supplied at the top level of the template. For more information about which top-level keys are supported, see "[Syntax for issue forms](/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms#top-level-syntax)."
|
||||
|
||||
### Example
|
||||
### Example of "`input` is not a permitted key" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -100,7 +100,7 @@ The error can be fixed by removing the forbidden keys.
|
|||
|
||||
Issue forms must accept user input, which means that at least one of its fields must contain a user input field. A `markdown` element is static text, so a `body` array cannot contain only `markdown` elements.
|
||||
|
||||
### Example
|
||||
### Example of "body must contain at least one non-markdown field" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -127,7 +127,7 @@ body:
|
|||
|
||||
If using `id` attributes to distinguish multiple elements, each `id` attribute must be unique.
|
||||
|
||||
### Example
|
||||
### Example of "body must have unique ids" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -161,7 +161,7 @@ body:
|
|||
|
||||
When there are multiple `body` elements that accept user input, the `label` attribute for each user input field must be unique.
|
||||
|
||||
### Example
|
||||
### Example of "body must have unique labels" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -209,7 +209,7 @@ body:
|
|||
|
||||
Similar labels may be processed into identical references. If an `id` attribute is not provided for an `input`, the `label` attribute is used to generate a reference to the `input` field. To do this, we process the `label` by leveraging the Rails [parameterize](https://apidock.com/rails/ActiveSupport/Inflector/parameterize) method. In some cases, two labels that are distinct can be processed into the same parameterized string.
|
||||
|
||||
### Example
|
||||
### Example of "labels are too similar" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -254,7 +254,7 @@ body:
|
|||
|
||||
When a `checkboxes` element is present, each of its nested labels must be unique among its peers, as well as among other input types.
|
||||
|
||||
### Example
|
||||
### Example of "checkboxes must have unique labels" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -305,7 +305,7 @@ Each body block must contain the key `type`.
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the zero-indexed index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: required key type is missing" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -328,7 +328,7 @@ One of the body blocks contains a type value that is not one of the [permitted t
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `x` is not a valid input type" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -352,7 +352,7 @@ One of the required `value` attributes has not been provided. The error occurs w
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: required attribute key `value` is missing" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -380,7 +380,7 @@ Within its `attributes` block, a value has the wrong data type.
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: label must be a string" error
|
||||
|
||||
The `label` below is being parsed as a Boolean, but it should be a string.
|
||||
|
||||
|
|
@ -429,7 +429,7 @@ body:
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `id` can only contain numbers, letters, -, _" error
|
||||
|
||||
```yaml
|
||||
name: "Bug report"
|
||||
|
|
@ -457,7 +457,7 @@ An unexpected key, `x`, was provided at the same indentation level as `type` and
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `x` is not a permitted key" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -482,7 +482,7 @@ To minimize the risk of private information and credentials being posted publicl
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `label` contains forbidden word" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -512,7 +512,7 @@ An invalid key has been supplied in an `attributes` block.
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `x` is not a permitted attribute" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -537,7 +537,7 @@ For checkboxes and dropdown input types, the choices defined in the `options` ar
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `options` must be unique" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -568,7 +568,7 @@ body:
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `options` must not include the reserved word, none" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -603,7 +603,7 @@ There are a number of English words that become processed into Boolean values by
|
|||
|
||||
Errors with `body` will be prefixed with `body[i]` where `i` represents the index of the body block containing the error. For example, `body[0]` tells us that the error has been caused by the first block in the `body` list.
|
||||
|
||||
### Example
|
||||
### Example of "body[i]: `options` must not include booleans. Please wrap values such as 'yes', and 'true' in quotes" error
|
||||
|
||||
```yaml
|
||||
body:
|
||||
|
|
@ -635,7 +635,7 @@ The template body `key:value` pair can not be empty. For more information about
|
|||
|
||||
The error can be fixed by adding the `body:` section.
|
||||
|
||||
### Example
|
||||
### Example of "body cannot be empty" error
|
||||
|
||||
```yaml
|
||||
name: Support Request
|
||||
|
|
|
|||
|
|
@ -81,7 +81,7 @@ You can choose from the following types of form elements. Each type has unique a
|
|||
|
||||
You can use a `markdown` element to display Markdown in your form that provides extra context to the user, but is not submitted.
|
||||
|
||||
#### Attributes
|
||||
#### Attributes for `markdown`
|
||||
|
||||
{% data reusables.form-schema.attributes-intro %}
|
||||
|
||||
|
|
@ -97,7 +97,7 @@ For multi-line text, you can use the pipe operator.
|
|||
|
||||
{% endtip %}
|
||||
|
||||
#### Example
|
||||
#### Example of `markdown`
|
||||
|
||||
```YAML{:copy}
|
||||
body:
|
||||
|
|
@ -114,7 +114,7 @@ body:
|
|||
|
||||
You can use a `textarea` element to add a multi-line text field to your form. Contributors can also attach files in `textarea` fields.
|
||||
|
||||
#### Attributes
|
||||
#### Attributes for `textarea`
|
||||
|
||||
{% data reusables.form-schema.attributes-intro %}
|
||||
|
||||
|
|
@ -126,7 +126,7 @@ You can use a `textarea` element to add a multi-line text field to your form. Co
|
|||
| `value` | Text that is pre-filled in the text area. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
|
||||
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). |
|
||||
|
||||
#### Validations
|
||||
#### Validations for `textarea`
|
||||
|
||||
{% data reusables.form-schema.validations-intro %}
|
||||
|
||||
|
|
@ -134,7 +134,7 @@ You can use a `textarea` element to add a multi-line text field to your form. Co
|
|||
| --- | ----------- | -------- | ---- | ------- | ------- |
|
||||
{% data reusables.form-schema.required-key %}
|
||||
|
||||
#### Example
|
||||
#### Example of `textarea`
|
||||
|
||||
```YAML{:copy}
|
||||
body:
|
||||
|
|
@ -157,7 +157,7 @@ body:
|
|||
|
||||
You can use an `input` element to add a single-line text field to your form.
|
||||
|
||||
#### Attributes
|
||||
#### Attributes for `input`
|
||||
|
||||
{% data reusables.form-schema.attributes-intro %}
|
||||
|
||||
|
|
@ -168,7 +168,7 @@ You can use an `input` element to add a single-line text field to your form.
|
|||
| `placeholder` | A semi-transparent placeholder that renders in the field when empty. | Optional | String | Empty String | {% octicon "dash" aria-label="The dash icon" %} |
|
||||
| `value` | Text that is pre-filled in the field. | Optional | String | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
|
||||
|
||||
#### Validations
|
||||
#### Validations for `input`
|
||||
|
||||
{% data reusables.form-schema.validations-intro %}
|
||||
|
||||
|
|
@ -176,7 +176,7 @@ You can use an `input` element to add a single-line text field to your form.
|
|||
| --- | ----------- | -------- | ---- | ------- | ------- |
|
||||
{% data reusables.form-schema.required-key %}
|
||||
|
||||
#### Example
|
||||
#### Example of `input`
|
||||
|
||||
```YAML{:copy}
|
||||
body:
|
||||
|
|
@ -194,7 +194,7 @@ body:
|
|||
|
||||
You can use a `dropdown` element to add a dropdown menu in your form.
|
||||
|
||||
#### Attributes
|
||||
#### Attributes for `dropdown`
|
||||
|
||||
{% data reusables.form-schema.attributes-intro %}
|
||||
|
||||
|
|
@ -205,7 +205,7 @@ You can use a `dropdown` element to add a dropdown menu in your form.
|
|||
| `multiple` | Determines if the user can select more than one option. | Optional | Boolean | false | {% octicon "dash" aria-label="The dash icon" %} |
|
||||
| `options` | An array of options the user can choose from. Cannot be empty and all choices must be distinct. | Required | String array | {% octicon "dash" aria-label="The dash icon" %} | {% octicon "dash" aria-label="The dash icon" %} |
|
||||
|
||||
#### Validations
|
||||
#### Validations for `dropdown`
|
||||
|
||||
{% data reusables.form-schema.validations-intro %}
|
||||
|
||||
|
|
@ -213,7 +213,7 @@ You can use a `dropdown` element to add a dropdown menu in your form.
|
|||
| --- | ----------- | -------- | ---- | ------- | ------- |
|
||||
{% data reusables.form-schema.required-key %}
|
||||
|
||||
#### Example
|
||||
#### Example of `dropdown`
|
||||
|
||||
```YAML{:copy}
|
||||
body:
|
||||
|
|
@ -234,7 +234,7 @@ body:
|
|||
|
||||
You can use the `checkboxes` element to add a set of checkboxes to your form.
|
||||
|
||||
#### Attributes
|
||||
#### Attributes for `checkboxes`
|
||||
|
||||
{% data reusables.form-schema.attributes-intro %}
|
||||
|
||||
|
|
@ -246,7 +246,7 @@ You can use the `checkboxes` element to add a set of checkboxes to your form.
|
|||
|
||||
{% data reusables.form-schema.options-syntax %}
|
||||
|
||||
#### Validations
|
||||
#### Validations for `checkboxes`
|
||||
|
||||
{% data reusables.form-schema.validations-intro %}
|
||||
|
||||
|
|
@ -254,7 +254,7 @@ You can use the `checkboxes` element to add a set of checkboxes to your form.
|
|||
| --- | ----------- | -------- | ---- | ------- | ------- |
|
||||
{% data reusables.form-schema.required-key %}
|
||||
|
||||
#### Example
|
||||
#### Example of `checkboxes`
|
||||
|
||||
```YAML{:copy}
|
||||
body:
|
||||
|
|
|
|||
|
|
@ -16,85 +16,100 @@ versions:
|
|||
ghec: '*'
|
||||
shortTitle: Associate text editors
|
||||
---
|
||||
{% mac %}
|
||||
|
||||
## Using {% data variables.product.prodname_vscode %} as your editor
|
||||
|
||||
{% mac %}
|
||||
|
||||
1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "code --wait"
|
||||
```
|
||||
|
||||
## Using Sublime Text as your editor
|
||||
|
||||
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "subl -n -w"
|
||||
```
|
||||
|
||||
## Using TextMate as your editor
|
||||
|
||||
1. Install [TextMate](https://macromates.com/).
|
||||
2. Install TextMate's `mate` shell utility. For more information, see "[`mate` and `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
4. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "mate -w"
|
||||
```
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
## Using {% data variables.product.prodname_vscode %} as your editor
|
||||
|
||||
1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "code --wait"
|
||||
```
|
||||
|
||||
## Using Sublime Text as your editor
|
||||
|
||||
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w"
|
||||
```
|
||||
|
||||
## Using Notepad++ as your editor
|
||||
|
||||
1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "'C:/Program Files (x86)/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin"
|
||||
```
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
## Using {% data variables.product.prodname_vscode %} as your editor
|
||||
|
||||
1. Install [{% data variables.product.prodname_vscode %}](https://code.visualstudio.com/) ({% data variables.product.prodname_vscode_shortname %}). For more information, see "[Setting up {% data variables.product.prodname_vscode_shortname %}](https://code.visualstudio.com/Docs/setup/setup-overview)" in the {% data variables.product.prodname_vscode_shortname %} documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "code --wait"
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
## Using Sublime Text as your editor
|
||||
|
||||
{% mac %}
|
||||
|
||||
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
3. Type this command:
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "subl -n -w"
|
||||
```
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "'C:/Program Files (x86)/sublime text 3/subl.exe' -w"
|
||||
```
|
||||
|
||||
{% endwindows %}
|
||||
|
||||
{% linux %}
|
||||
|
||||
1. Install [Sublime Text](https://www.sublimetext.com/). For more information, see "[Installation](https://docs.sublimetext.io/guide/getting-started/installation.html)" in the Sublime Text documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "subl -n -w"
|
||||
```
|
||||
|
||||
{% endlinux %}
|
||||
|
||||
{% mac %}
|
||||
|
||||
## Using TextMate as your editor
|
||||
|
||||
1. Install [TextMate](https://macromates.com/).
|
||||
1. Install TextMate's `mate` shell utility. For more information, see "[`mate` and `rmate`](https://macromates.com/blog/2011/mate-and-rmate/)" in the TextMate documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "mate -w"
|
||||
```
|
||||
|
||||
{% endmac %}
|
||||
|
||||
{% windows %}
|
||||
|
||||
## Using Notepad++ as your editor
|
||||
|
||||
1. Install Notepad++ from https://notepad-plus-plus.org/. For more information, see "[Getting started](https://npp-user-manual.org/docs/getting-started/)" in the Notepad++ documentation.
|
||||
{% data reusables.command_line.open_the_multi_os_terminal %}
|
||||
1. Type this command:
|
||||
```shell
|
||||
$ git config --global core.editor "'C:/Program Files (x86)/Notepad++/notepad++.exe' -multiInst -notabbar -nosession -noPlugin"
|
||||
```
|
||||
|
||||
{% endwindows %}
|
||||
|
|
@ -151,7 +151,7 @@ The `git remote rename` command takes two arguments:
|
|||
* An existing remote name, for example, `origin`
|
||||
* A new name for the remote, for example, `destination`
|
||||
|
||||
## Example
|
||||
### Example of renaming a remote repository
|
||||
|
||||
These examples assume you're [cloning using HTTPS](/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls), which is recommended.
|
||||
|
||||
|
|
@ -187,7 +187,7 @@ $ git remote -v
|
|||
|
||||
This error means that the remote name you want to use already exists. To solve this, either use a different remote name, or rename the original remote.
|
||||
|
||||
## Removing a remote repository
|
||||
## Removing a remote repository
|
||||
|
||||
Use the `git remote rm` command to remove a remote URL from your repository.
|
||||
|
||||
|
|
@ -196,7 +196,7 @@ The `git remote rm` command takes one argument:
|
|||
|
||||
Removing the remote URL from your repository only unlinks the local and remote repositories. It does not delete the remote repository.
|
||||
|
||||
## Example
|
||||
### Example of removing a remote repository
|
||||
|
||||
These examples assume you're [cloning using HTTPS](/get-started/getting-started-with-git/about-remote-repositories#cloning-with-https-urls), which is recommended.
|
||||
|
||||
|
|
|
|||
|
|
@ -37,13 +37,15 @@ For more information on all of {% data variables.product.prodname_dotcom %}'s pl
|
|||
To ensure you can use all the features in your {% data variables.product.product_name %} plan, verify your email address after signing up for a new account. For more information, see "[Verifying your email address](/github/getting-started-with-github/signing-up-for-github/verifying-your-email-address)."
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
{% ifversion ghes or ghae %}
|
||||
### 1. Accessing your account
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghes %}
|
||||
The administrator of your {% data variables.product.product_name %} instance will notify you about how to authenticate and access your account. The process varies depending on the authentication mode they have configured for the instance.
|
||||
{% endif %}
|
||||
|
||||
{% ifversion ghae %}
|
||||
### 1. Accessing your account
|
||||
You will receive an email notification once your enterprise owner for {% data variables.product.product_name %} has set up your account, allowing you to authenticate with SAML single sign-on (SSO) and access your account.
|
||||
{% endif %}
|
||||
|
||||
|
|
@ -154,20 +156,20 @@ You can enable {% data variables.product.prodname_discussions %} for your reposi
|
|||
### {% ifversion fpt or ghec %}3.{% else %}2.{% endif %} Building {% data variables.product.prodname_actions %}
|
||||
{% data reusables.getting-started.actions %}
|
||||
|
||||
### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %}
|
||||
### {% ifversion fpt or ghec %}4.{% else %}3.{% endif %} Publishing and managing {% data variables.product.prodname_registry %}
|
||||
{% data reusables.getting-started.packages %}
|
||||
|
||||
## Part 5: Building securely on {% data variables.product.product_name %}
|
||||
{% data variables.product.product_name %} has a variety of security features that help keep code and secrets secure in repositories. Some features are available for all repositories, while others are only available for public repositories and repositories with a {% data variables.product.prodname_GH_advanced_security %} license. For an overview of {% data variables.product.product_name %} security features, see "[{% data variables.product.prodname_dotcom %} security features](/code-security/getting-started/github-security-features)."
|
||||
|
||||
### 1. Securing your repository
|
||||
As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed.
|
||||
As a repository administrator, you can secure your repositories by configuring repository security settings. These include managing access to your repository, setting a security policy, and managing dependencies. For public repositories, and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled, you can also configure code and secret scanning to automatically identify vulnerabilities and ensure tokens and keys are not exposed.
|
||||
|
||||
For more information on steps you can take to secure your repositories, see "[Securing your repository](/code-security/getting-started/securing-your-repository)."
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
### 2. Managing your dependencies
|
||||
A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies.
|
||||
A large part of building securely is maintaining your project's dependencies to ensure that all packages and applications you depend on are updated and secure. You can manage your repository's dependencies on {% data variables.product.product_name %} by exploring the dependency graph for your repository, using Dependabot to automatically raise pull requests to keep your dependencies up-to-date, and receiving Dependabot alerts and security updates for vulnerable dependencies.
|
||||
|
||||
For more information, see "[Securing your software supply chain](/code-security/supply-chain-security)."
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -55,12 +55,12 @@ If you already have a profile README, you can edit it from your profile page.
|
|||
|
||||
## Adding an image to suit your visitors
|
||||
|
||||
You can include images in your communication on {% data variables.product.prodname_dotcom %}. Here, you'll add a responsive image, such as a banner, to the top of your {% ifversion ghae %}gist{% else %}profile README{% endif %}.
|
||||
You can include images in your communication on {% data variables.product.prodname_dotcom %}. Here, you'll add a responsive image, such as a banner, to the top of your {% ifversion ghae %}gist{% else %}profile README{% endif %}.
|
||||
|
||||
By using the HTML `<picture>` element with the `prefers-color-scheme` media feature, you can add an image that changes depending on whether a visitor is using light or dark mode. For more information, see "[Managing your theme settings](/account-and-profile/setting-up-and-managing-your-personal-account-on-github/managing-personal-account-settings/managing-your-theme-settings)."
|
||||
|
||||
1. Copy and paste the following markup into your {% ifversion ghae %}`about-me.md`{% else %}`README.md`{% endif %} file.
|
||||
|
||||
|
||||
```HTML{:copy}
|
||||
<picture>
|
||||
<source media="(prefers-color-scheme: dark)" srcset="YOUR-DARKMODE-IMAGE">
|
||||
|
|
@ -78,11 +78,11 @@ By using the HTML `<picture>` element with the `prefers-color-scheme` media feat
|
|||
|
||||
For more information on using images in Markdown, see "[Basic writing and formatting syntax](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#images)."
|
||||
|
||||
### Example
|
||||
### Example of a responsive image
|
||||
|
||||
{% data reusables.getting-started.picture-element-example %}
|
||||
|
||||
### How it looks
|
||||
### How the image looks
|
||||
|
||||
|
||||
|
||||
|
|
@ -90,16 +90,16 @@ For more information on using images in Markdown, see "[Basic writing and format
|
|||
|
||||
You can use Markdown tables to organize information. Here, you'll use a table to introduce yourself by ranking something, such as your most-used programming languages or frameworks, the things you're spending your time learning, or your favorite hobbies. When a table column contains numbers, it's useful to right-align the column by using the syntax `--:` below the header row.
|
||||
|
||||
1. Return to the **Edit {% ifversion ghae %}new {% endif %}file** tab.
|
||||
1. Return to the **Edit {% ifversion ghae %}new {% endif %}file** tab.
|
||||
1. To introduce yourself, two lines below the `</picture>` tag, add an `## About me` header and a short paragraph about yourself, like the following.
|
||||
|
||||
|
||||
```Markdown
|
||||
## About me
|
||||
|
||||
Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotcom %}'s mascot.
|
||||
```
|
||||
1. Two lines below this paragraph, insert a table by copying and pasting the following markup.
|
||||
|
||||
|
||||
```Markdown{:copy}
|
||||
| Rank | THING-TO-RANK |
|
||||
|-----:|---------------|
|
||||
|
|
@ -112,7 +112,7 @@ You can use Markdown tables to organize information. Here, you'll use a table to
|
|||
|
||||
For more information, see "[Organizing information with tables](/get-started/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables)."
|
||||
|
||||
### Example
|
||||
### Example of a table
|
||||
|
||||
```Markdown
|
||||
## About me
|
||||
|
|
@ -126,16 +126,16 @@ Hi, I'm Mona. You might recognize me as {% data variables.product.prodname_dotco
|
|||
| 3| SQL |
|
||||
```
|
||||
|
||||
### How it looks
|
||||
### How the table looks
|
||||
|
||||
|
||||
|
||||
## Adding a collapsed section
|
||||
|
||||
To keep your content tidy, you can use the `<details>` tag to create an expandible collapsed section.
|
||||
To keep your content tidy, you can use the `<details>` tag to create an expandible collapsed section.
|
||||
|
||||
1. To create a collapsed section for the table you created, wrap your table in `<details>` tags like in the following example.
|
||||
|
||||
|
||||
```HTML{:copy}
|
||||
<details>
|
||||
<summary>My top THINGS-TO-RANK</summary>
|
||||
|
|
@ -152,7 +152,7 @@ To keep your content tidy, you can use the `<details>` tag to create an expandib
|
|||
```
|
||||
1. To check the collapsed section has rendered correctly, click the **Preview** tab.
|
||||
|
||||
### Example
|
||||
### Example of a collapsed section
|
||||
|
||||
```HTML
|
||||
<details>
|
||||
|
|
@ -163,11 +163,11 @@ To keep your content tidy, you can use the `<details>` tag to create an expandib
|
|||
| 1| Javascript|
|
||||
| 2| Python |
|
||||
| 3| SQL |
|
||||
|
||||
|
||||
</details>
|
||||
```
|
||||
|
||||
### How it looks
|
||||
### How the collapsed section looks
|
||||
|
||||
|
||||
|
||||
|
|
@ -181,7 +181,7 @@ Markdown has many other options for formatting your content. Here, you'll add a
|
|||
---
|
||||
```
|
||||
1. Below the `---` line, add a quote by typing markup like the following.
|
||||
|
||||
|
||||
```Markdown
|
||||
> QUOTE
|
||||
```
|
||||
|
|
@ -189,7 +189,7 @@ Markdown has many other options for formatting your content. Here, you'll add a
|
|||
Replace `QUOTE` with a quote of your choice. Alternatively, copy the quote from our example below.
|
||||
1. To check everything has rendered correctly, click the **Preview** tab.
|
||||
|
||||
### Example
|
||||
### Example of a quote
|
||||
|
||||
```Markdown
|
||||
---
|
||||
|
|
@ -198,7 +198,7 @@ Markdown has many other options for formatting your content. Here, you'll add a
|
|||
— Mona the Octocat
|
||||
```
|
||||
|
||||
### How it looks
|
||||
### How the quote looks
|
||||
|
||||
|
||||
|
||||
|
|
@ -211,11 +211,11 @@ You can use HTML comment syntax to add a comment that will be hidden in the outp
|
|||
<pre>
|
||||
<!-- COMMENT -->
|
||||
</pre>
|
||||
|
||||
|
||||
Replace `COMMENT` with a "to-do" item you remind yourself to do something later (for example, to add more items to the table).
|
||||
1. To check your comment is hidden in the output, click the **Preview** tab.
|
||||
|
||||
### Example
|
||||
### Example of a comment
|
||||
|
||||
<pre>
|
||||
## About me
|
||||
|
|
@ -225,12 +225,12 @@ You can use HTML comment syntax to add a comment that will be hidden in the outp
|
|||
|
||||
## Saving your work
|
||||
|
||||
When you're happy with your changes, save your {% ifversion ghae %}gist.
|
||||
When you're happy with your changes, save your {% ifversion ghae %}gist.
|
||||
|
||||
- To keep your gist hidden from search engines but visible to anyone you share the URL with, click **Create secret gist**
|
||||
- To keep your gist hidden from search engines but visible to anyone you share the URL with, click **Create secret gist**
|
||||
- If you're happy for your gist to be visible to anyone on {% data variables.location.product_location %}, click **Create internal gist**
|
||||
|
||||
{% else %}profile README by clicking **Commit changes**.
|
||||
{% else %}profile README by clicking **Commit changes**.
|
||||
|
||||
Committing directly to the `main` branch will make your changes visible to any visitor on your profile. If you want to save your work but aren't ready to make it visible on your profile, you can select **Create a new branch for this commit and start a pull request**.
|
||||
|
||||
|
|
|
|||
|
|
@ -41,8 +41,8 @@ shortTitle: Working with non-code files
|
|||
|
||||
{% note %}
|
||||
|
||||
**Note:**
|
||||
- {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files.
|
||||
**Note:**
|
||||
- {% data variables.product.prodname_dotcom %} does not support comparing the differences between PSD files.
|
||||
- If you are using the Firefox browser, SVGs on {% data variables.product.prodname_dotcom %} may not render.
|
||||
|
||||
{% endnote %}
|
||||
|
|
@ -301,7 +301,7 @@ If your map contains a large number of markers (roughly over 750), GitHub will a
|
|||
|
||||
The underlying map data (street names, roads, etc.) are driven by [OpenStreetMap](http://www.openstreetmap.org/), a collaborative project to create a free editable map of the world. If you notice something's not quite right, since it's open source, simply [sign up](https://www.openstreetmap.org/user/new) and submit a fix.
|
||||
|
||||
### Troubleshooting
|
||||
### Troubleshooting GeoJSON/TopoJSON files
|
||||
|
||||
If you're having trouble rendering GeoJSON files, ensure you have a valid GeoJSON file by running it through a [GeoJSON linter](http://geojsonlint.com/). If your points aren't appearing where you'd expect (<em>e.g.</em>, in the middle of the ocean), it's likely that the data is in a projection which is currently unsupported. Currently, {% data variables.product.product_name %} only supports the `urn:ogc:def:crs:OGC:1.3:CRS84` projection.
|
||||
|
||||
|
|
@ -311,7 +311,7 @@ Additionally, if your `.geojson` file is especially large (over 10 MB), it is no
|
|||
|
||||
It may still be possible to render the data by converting the `.geojson` file to [TopoJSON](https://github.com/mbostock/topojson), a compression format that, in some cases, can reduce filesize by up to 80%. Of course, you can always break the file into smaller chunks (such as by state or by year), and store the data as multiple files within the repository.
|
||||
|
||||
### Further reading
|
||||
### Further reading about GeoJSON/TopoJSON
|
||||
|
||||
{% ifversion geoJSON-with-MapBox %}
|
||||
* [Leaflet.js documentation](https://leafletjs.com/)
|
||||
|
|
@ -331,7 +331,7 @@ To view your Jupyter notebook with JavaScript content rendered or to share your
|
|||
|
||||
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).
|
||||
|
||||
### Troubleshooting
|
||||
### Troubleshooting Jupyter Notebook files
|
||||
|
||||
If you're having trouble rendering Jupyter Notebook files in static HTML, you can convert the file locally on the command line by using the [`nbconvert` command](https://github.com/jupyter/nbconvert):
|
||||
|
||||
|
|
@ -339,7 +339,7 @@ If you're having trouble rendering Jupyter Notebook files in static HTML, you ca
|
|||
$ jupyter nbconvert --to html NOTEBOOK-NAME.ipynb
|
||||
```
|
||||
|
||||
### Further reading
|
||||
### Further reading about Jupyter Notebook
|
||||
|
||||
- [Jupyter Notebook's GitHub repository](https://github.com/jupyter/jupyter_notebook)
|
||||
- [Gallery of Jupyter Notebooks](https://github.com/jupyter/jupyter/wiki)
|
||||
|
|
@ -363,11 +363,11 @@ graph TD
|
|||
When you view the file in the repository, it is rendered as a flow chart.
|
||||
|
||||
|
||||
### Troubleshooting
|
||||
### Troubleshooting Mermaid files
|
||||
|
||||
If your chart does not render at all, verify that it contains valid Mermaid Markdown syntax by checking your chart with the [Mermaid live editor](https://mermaid.live/edit).
|
||||
|
||||
If the chart displays, but does not appear as you'd expect, you can create a new [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/general), and add the `Mermaid` label.
|
||||
If the chart displays, but does not appear as you'd expect, you can create a new [{% data variables.product.prodname_github_community %} discussion](https://github.com/orgs/community/discussions/categories/general), and add the `Mermaid` label.
|
||||
|
||||
#### Known issues
|
||||
|
||||
|
|
@ -379,9 +379,8 @@ If the chart displays, but does not appear as you'd expect, you can create a new
|
|||
|
||||
You can embed Mermaid syntax directly in Markdown. For more information, see "[Creating diagrams](/get-started/writing-on-github/working-with-advanced-formatting/creating-diagrams#creating-mermaid-diagrams)."
|
||||
|
||||
### Further reading
|
||||
### Further reading about Mermaid
|
||||
|
||||
* [Mermaid.js documentation](https://mermaid-js.github.io/mermaid/#/)
|
||||
* [Mermaid.js live editor](https://mermaid.live/edit)
|
||||
{% endif %}
|
||||
|
||||
|
|
|
|||
|
|
@ -1 +1 @@
|
|||
Only organization members with the [*owner*](/articles/permission-levels-for-an-organization) or [*billing manager*](/articles/adding-a-billing-manager-to-your-organization) role can access or change billing settings for your organization.
|
||||
Only organization members with the [owner](/articles/permission-levels-for-an-organization) or [billing manager](/articles/adding-a-billing-manager-to-your-organization) role can access or change billing settings for your organization.
|
||||
|
|
|
|||
|
|
@ -873,9 +873,9 @@ describe('extended Markdown', () => {
|
|||
test('renders expected mini TOC headings in platform-specific content', async () => {
|
||||
const $ = await getDOM('/en/github/using-git/associating-text-editors-with-git')
|
||||
expect($('h2#in-this-article').length).toBe(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.mac').length).toBeGreaterThan(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.windows').length).toBeGreaterThan(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.linux').length).toBeGreaterThan(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.mac').length).toBe(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.windows').length).toBe(1)
|
||||
expect($('h2#in-this-article + nav ul div.extended-markdown.linux').length).toBe(0)
|
||||
})
|
||||
})
|
||||
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче