jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-19 18:10:59 -05:00
Code Issues Projects Releases Wiki Activity

Add 'cli' to allowed values for ref_product (#58679)

Browse Source
This commit is contained in:
Joe Clark
2025-12-02 11:06:04 -08:00
committed by GitHub
parent 4ffdce6b8e
commit a1408f067f
1 changed files with 17 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
content/contributing/style-guide-and-content-model/style-guide.md
View File

@@ -151,34 +151,28 @@ A CTA is an explicit direction to the user to take an immediate action, such as
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 %}.
### Required CTA parameters
### Building CTAs
* `ref_product`:
* **Purpose**: The GitHub product the CTA leads users to.
* **Allowed values**: `copilot`, `ghec`, `desktop`, `code-quality`
* **Example**: `ref_product=copilot`
* `ref_type`:
* **Purpose**: The type of action the CTA encourages users to take.
* **Allowed values**: `trial`, `purchase`, `engagement`
* **Example**: `ref_type=purchase`
* `ref_style`:
* **Purpose**: The way we are formatting the CTA in the docs.
* **Allowed values**: `button` or `text`
* **Example**: `ref_style=button`
* `ref_plan` (_optional_):
* **Purpose**: For links to sign up for or trial a plan, the specific plan we link to.
* **Allowed values**: `enterprise`, `business`, `pro`, `free`
* **Example**: `ref_plan=business`
To build a valid CTA URL with the correct parameters, use the CTA builder script in your docs repository checkout:
Replace the placeholders with the relevant information for your CTA, where `DESTINATION/URL` is the URL that the button should navigate to:
```html
{% 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 %}
```shell
npm run cta-builder
```
### Getting help with CTAs
The script will guide you through an interactive process to:
* Select the appropriate {% data variables.product.company_short %} product (`ref_product`)
* Use `github` as the default when the link is not specific to a particular feature or product
* Choose the type of action (`ref_type`)
* Specify the formatting style (`ref_style`)
* Optionally select a specific plan (`ref_plan`)
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.
The script provides all available options for each parameter and generates a complete, valid CTA URL at the end. Use this tool to ensure you're using current, approved values for CTA parameters.
For example, the script might generate a URL like:
```
https://github.com/account/enterprises/new?ref_product=ghec&ref_type=trial&ref_style=button&ref_plan=enterprise
```
## Code