Skip to content

Commit 66d25ca

Browse files
authored
Merge pull request #40800 from github/repo-sync
Repo sync
2 parents 82151c7 + 9fc9f5f commit 66d25ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+1234
-118
lines changed

.github/actions/get-changed-files/action.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@ runs:
3333
- name: Gather changed files
3434
id: get_changes
3535
env:
36+
INPUT_FILES: ${{ inputs.files }}
3637
INPUT_HEAD: ${{ inputs.head || github.event.pull_request.head.ref || github.event.merge_group.head_ref || github.ref_name }}
3738
INPUT_OUTPUT_FILE: ${{ inputs.output_file }}
3839
shell: bash
212 KB
Loading
167 KB
Loading
196 KB
Loading
207 KB
Loading
198 KB
Loading

content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ This table lists the secrets supported by {% data variables.product.prodname_sec
5353

5454
| Provider | Token |
5555
|----------|:--------------------|
56+
| Generic | ec_private_key |
5657
| Generic | http_basic_authentication_header |
5758
| Generic | http_bearer_authentication_header |
5859
| Generic | mongodb_connection_string |

content/contributing/style-guide-and-content-model/style-guide.md

Lines changed: 24 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,16 +151,34 @@ A CTA is an explicit direction to the user to take an immediate action, such as
151151

152152
For example, the CTA on [AUTOTITLE](/enterprise-cloud@latest/admin/overview/setting-up-a-trial-of-github-enterprise-cloud) links to [an enterprise sales page](https://github.com/account/enterprises/new?ref_product=ghec&ref_type=trial&ref_style=text&ref_plan=enterprise) on {% data variables.product.prodname_dotcom_the_website %}.
153153

154-
Style a CTA using the following format.
154+
### Required CTA parameters
155+
156+
* `ref_product`:
157+
* **Purpose**: The GitHub product the CTA leads users to.
158+
* **Allowed values**: `copilot`, `ghec`, `desktop`
159+
* **Example**: `ref_product=copilot`
160+
* `ref_type`:
161+
* **Purpose**: The type of action the CTA encourages users to take.
162+
* **Allowed values**: `trial`, `purchase`, `engagement`
163+
* **Example**: `ref_type=purchase`
164+
* `ref_style`:
165+
* **Purpose**: The way we are formatting the CTA in the docs.
166+
* **Allowed values**: `button` or `text`
167+
* **Example**: `ref_style=button`
168+
* `ref_plan` (_optional_):
169+
* **Purpose**: For links to sign up for or trial a plan, the specific plan we link to.
170+
* **Allowed values**: `enterprise`, `business`, `pro`, `free`
171+
* **Example**: `ref_plan=business`
172+
173+
Replace the placeholders with the relevant information for your CTA, where `DESTINATION/URL` is the URL that the button should navigate to:
155174

156175
```html
157-
{% raw %}<a href="https://github.com/DESTINATION/URL?ref_cta=CTA+NAME&ref_loc=LOCATION&ref_page=docs" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Try PRODUCT NAME</span> {% octicon "link-external" height:16 %}</a>{% endraw %}
176+
{% raw %}<a href="https://github.com/DESTINATION/URL?ref_product=PRODUCT&ref_type=TYPE&ref_style=STYLE&ref_plan=PLAN" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Try PRODUCT NAME</span> {% octicon "link-external" height:16 %}</a>{% endraw %}
158177
```
159178

160-
Replace the placeholders with the relevant information for your CTA.
161-
* `DESTINATION/URL`: The URL that the button should navigate to.
162-
* `CTA+NAME`: The name of the CTA. For example, `GHEC+trial` or `Copilot+Business+Trial`.
163-
* `LOCATION`: The location in {% data variables.product.prodname_docs %} of the CTA. For example, `Setting+up+a+trial+of+GitHub+Enterprise+Cloud`.
179+
### Getting help with CTAs
180+
181+
For help building a valid CTA URL, you can enter the command `npm run cta-builder` in your docs repo checkout. Answer each question and at the end you'll see your valid CTA.
164182

165183
## Code
166184

data/reusables/contributing/content-linter-rules.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,7 @@
7272
| GHD054 | third-party-actions-reusable | Code examples with third-party actions must include disclaimer reusable | warning | actions, reusable, third-party |
7373
| GHD055 | frontmatter-validation | Frontmatter properties must meet character limits and required property requirements | warning | frontmatter, character-limits, required-properties |
7474
| GHD056 | frontmatter-landing-recommended | Only landing pages can have recommended articles, there should be no duplicate recommended articles, and all recommended articles must exist | error | frontmatter, landing, recommended |
75+
| GHD057 | ctas-schema | CTA URLs must conform to the schema | error | ctas, schema, urls |
7576
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: octicon-<icon-name> | The octicon liquid syntax used is deprecated. Use this format instead `octicon "<octicon-name>" aria-label="<Octicon aria label>"` | error | |
7677
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | deprecated liquid syntax: site.data | Catch occurrences of deprecated liquid data syntax. | error | |
7778
| [search-replace](https://github.com/OnkarRuikar/markdownlint-rule-search-replace) | developer-domain | Catch occurrences of developer.github.com domain. | error | |

data/tables/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Data-driven tables
1+
# YAML-powered tables
22

33
## Overview
44

@@ -34,7 +34,7 @@ Every data-driven table needs **three files** that work together:
3434
|-----------|----------|---------|
3535
| **Data file** | `data/tables/` | Stores the table content in YAML format |
3636
| **Content file** | `content/` | Displays the table using Liquid templating |
37-
| **Schema file** | `src/data-directory/lib/data-schemas/` | Validates the YAML structure |
37+
| **Schema file** | `src/data-directory/lib/data-schemas/tables/` | Validates the YAML structure |
3838

3939
**Estimated time**: 30-60 minutes for a new table
4040

@@ -49,7 +49,7 @@ Create a new `.yml` file in `data/tables/` with a descriptive name.
4949
Create a YAML structure that will allow me to generate a table that looks like:
5050
[describe your table headers, rows, and columns OR attach an example]
5151
52-
See src/secret-scanning/data/public-docs.yml for an example.
52+
See data/tables/supported-code-languages.yml for an example.
5353
```
5454

5555
### Step 2: Create the content display
@@ -62,22 +62,22 @@ Create a Markdown table that is dynamically rendered using Liquid code.
6262
Pull data from data/tables/TABLE_NAME.yml.
6363
The table should look like: [describe your desired output OR attach an example]
6464
65-
See content/code-security/secret-scanning/introduction/supported-secret-scanning-patterns.md for an example.
65+
See content/get-started/learning-about-github/github-language-support.md for an example.
6666
Liquid docs: https://shopify.github.io/liquid
6767
```
6868

6969
**💡 Tip**: Iterate between Steps 1 and 2 until the table renders correctly.
7070

7171
### Step 3: Create the schema file
7272

73-
Create a `.ts` file in `src/data-directory/lib/data-schemas/` with the same name as your YAML file.
73+
Create a `.ts` file in `src/data-directory/lib/data-schemas/tables/` with the same name as your YAML file.
7474

7575
**Copilot prompt template:**
7676
```
7777
Create a TypeScript schema following prior art under data-schemas that enforces
7878
the structure of the data/TABLE_NAME.yml file.
7979
80-
See src/data-directory/lib/data-schemas/learning-tracks.ts for an example.
80+
See src/data-directory/lib/data-schemas/tables/supported-code-languages.ts for an example.
8181
```
8282

8383
## Testing and validation

0 commit comments

Comments
 (0)