Skip to content

Commit f99da59

Browse files
authoredFeb 7, 2023
Removes duplicate headers for accessibility audit (github#34474)
1 parent 08c4f8b commit f99da59

File tree

3 files changed

+18
-18
lines changed

3 files changed

+18
-18
lines changed
 

‎content/developers/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Direct the user to the following URL in their browser:
4444

4545
When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app.
4646

47-
#### Parameters
47+
#### Input parameters for `GET {% data variables.product.oauth_host_code %}/login/oauth/authorize`
4848

4949
Name | Type | Description
5050
-----|------|------------
@@ -78,7 +78,7 @@ Make a request to the following endpoint to receive an access token:
7878

7979
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
8080

81-
#### Parameters
81+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
8282

8383
Name | Type | Description
8484
-----|------|------------
@@ -87,7 +87,7 @@ Name | Type | Description
8787
`code` | `string` | **Required.** The code you received as a response to Step 1.
8888
`redirect_uri` | `string` | The URL in your application where users will be sent after authorization. This must be an exact match to {% ifversion fpt or ghes or ghec %} one of the URLs you provided as a **Callback URL** {% else %} the URL you provided in the **User authorization callback URL** field{% endif %} when setting up your GitHub App and can't contain any additional parameters.
8989

90-
#### Response
90+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
9191

9292
By default, the response takes the following form. The response parameters `expires_in`, `refresh_token`, and `refresh_token_expires_in` are only returned when you enable expiring user-to-server access tokens.
9393

‎content/developers/apps/building-oauth-apps/authorizing-oauth-apps.md

+8-8
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The web application flow to authorize users for your app is:
4646

4747
When your GitHub App specifies a `login` parameter, it prompts users with a specific account they can use for signing in and authorizing your app.
4848

49-
#### Parameters
49+
#### Input parameters for `GET {% data variables.product.oauth_host_code %}/login/oauth/authorize`
5050

5151
Name | Type | Description
5252
-----|------|--------------
@@ -65,7 +65,7 @@ Exchange this `code` for an access token:
6565

6666
POST {% data variables.product.oauth_host_code %}/login/oauth/access_token
6767

68-
#### Parameters
68+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
6969

7070
Name | Type | Description
7171
-----|------|--------------
@@ -74,7 +74,7 @@ Name | Type | Description
7474
`code` | `string` | **Required.** The code you received as a response to Step 1.
7575
`redirect_uri` | `string` | The URL in your application where users are sent after authorization.
7676

77-
#### Response
77+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
7878

7979
By default, the response takes the following form:
8080

@@ -143,14 +143,14 @@ Before you can use the device flow to authorize and identify users, you must fir
143143

144144
Your app must request a user verification code and verification URL that the app will use to prompt the user to authenticate in the next step. This request also returns a device verification code that the app must use to receive an access token and check the status of user authentication.
145145

146-
#### Input Parameters
146+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/device/code`
147147

148148
Name | Type | Description
149149
-----|------|--------------
150150
`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your app.
151151
`scope` | `string` | The scope that your app is requesting access to.
152152

153-
#### Response
153+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/device/code`
154154

155155
By default, the response takes the following form:
156156

@@ -182,7 +182,7 @@ Accept: application/xml
182182
</OAuth>
183183
```
184184

185-
#### Response parameters
185+
#### Response parameters for `POST {% data variables.product.oauth_host_code %}/login/device/code`
186186

187187
Name | Type | Description
188188
-----|------|--------------
@@ -208,15 +208,15 @@ The user must enter a valid code within 15 minutes (or 900 seconds). After 15 mi
208208

209209
Once the user has authorized, the app will receive an access token that can be used to make requests to the API on behalf of a user.
210210

211-
#### Input parameters
211+
#### Input parameters for `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
212212

213213
Name | Type | Description
214214
-----|------|--------------
215215
`client_id` | `string` | **Required.** The client ID you received from {% data variables.product.product_name %} for your {% data variables.product.prodname_oauth_app %}.
216216
`device_code` | `string` | **Required.** The device verification code you received from the `POST {% data variables.product.oauth_host_code %}/login/device/code` request.
217217
`grant_type` | `string` | **Required.** The grant type must be `urn:ietf:params:oauth:grant-type:device_code`.
218218

219-
#### Response
219+
#### Response from `POST {% data variables.product.oauth_host_code %}/login/oauth/access_token`
220220

221221
By default, the response takes the following form:
222222

‎content/developers/github-marketplace/listing-an-app-on-github-marketplace/writing-a-listing-description-for-your-app.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,17 @@ Here are guidelines about the fields you'll need to fill out in the **Listing de
2626

2727
Your listing's name will appear on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace). The name is limited to 255 characters and can be different from your app's name. Your listing cannot have the same name as an existing account on {% data variables.location.product_location %}, unless the name is your own user or organization name.
2828

29-
### Very short description
29+
### Very short description of listing
3030

3131
The community will see the "very short" description under your app's name on the [{% data variables.product.prodname_marketplace %} homepage](https://github.com/marketplace).
3232

3333
![{% data variables.product.prodname_marketplace %} app short description](/assets/images/marketplace/marketplace_short_description.png)
3434

35-
#### Length
35+
#### Length of "Very short description"
3636

3737
We recommend keeping short descriptions to 40-80 characters. Although you are allowed to use more characters, concise descriptions are easier for customers to read and understand quickly.
3838

39-
#### Content
39+
#### Content of "Very short description"
4040

4141
- Describe the app’s functionality. Don't use this space for a call to action. For example:
4242

@@ -52,7 +52,7 @@ We recommend keeping short descriptions to 40-80 characters. Although you are al
5252

5353
**DON'T:** Skycap is a container-native continuous integration tool
5454

55-
#### Formatting
55+
#### Formatting of "Very short description"
5656

5757
- Always use sentence-case capitalization. Only capitalize the first letter and proper nouns.
5858

@@ -142,19 +142,19 @@ Clicking **Read more...**, displays the "Detailed description."
142142

143143
Follow these guidelines for writing these descriptions.
144144

145-
### Length
145+
### Length of "Introductory description" and "Detailed description"
146146

147147
We recommend writing a 1-2 sentence high-level summary between 150-250 characters in the required "Introductory description" field when [listing your app](/marketplace/listing-on-github-marketplace/). Although you are allowed to use more characters, concise summaries are easier for customers to read and understand quickly.
148148

149149
You can add more information in the optional "Detailed description" field. You see this description when you click **Read more...** below the introductory description on your app's landing page. A detailed description consists of 3-5 [value propositions](https://en.wikipedia.org/wiki/Value_proposition), with 1-2 sentences describing each one. You can use up to 1,000 characters for this description.
150150

151-
### Content
151+
### Content of "Introductory description" and "Detailed description"
152152

153153
- Always begin introductory descriptions with your app's name.
154154

155155
- Always write descriptions and value propositions using the active voice.
156156

157-
### Formatting
157+
### Formatting of "Introductory description" and "Detailed description"
158158

159159
- Always use sentence-case capitalization in value proposition titles. Only capitalize the first letter and proper nouns.
160160

0 commit comments

Comments
 (0)
Please sign in to comment.