Skip to content

Commit a1408f0

Browse files
authored
Add 'cli' to allowed values for ref_product (#58679)
1 parent 4ffdce6 commit a1408f0

File tree

1 file changed

+19
-25
lines changed

1 file changed

+19
-25
lines changed

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

Lines changed: 19 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -151,34 +151,28 @@ 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-
### Required CTA parameters
155-
156-
* `ref_product`:
157-
* **Purpose**: The GitHub product the CTA leads users to.
158-
* **Allowed values**: `copilot`, `ghec`, `desktop`, `code-quality`
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:
174-
175-
```html
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 %}
154+
### Building CTAs
155+
156+
To build a valid CTA URL with the correct parameters, use the CTA builder script in your docs repository checkout:
157+
158+
```shell
159+
npm run cta-builder
177160
```
178161

179-
### Getting help with CTAs
162+
The script will guide you through an interactive process to:
163+
* Select the appropriate {% data variables.product.company_short %} product (`ref_product`)
164+
* Use `github` as the default when the link is not specific to a particular feature or product
165+
* Choose the type of action (`ref_type`)
166+
* Specify the formatting style (`ref_style`)
167+
* Optionally select a specific plan (`ref_plan`)
168+
169+
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.
180170

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.
171+
For example, the script might generate a URL like:
172+
173+
```
174+
https://github.com/account/enterprises/new?ref_product=ghec&ref_type=trial&ref_style=button&ref_plan=enterprise
175+
```
182176

183177
## Code
184178

0 commit comments

Comments
 (0)