Skip to content

Commit 29ac867

Browse files
sarahsjc-clark
andauthored
Update style guide with new CTA params (#57922)
Co-authored-by: Joe Clark <[email protected]>
1 parent 530a0d5 commit 29ac867

File tree

1 file changed

+24
-6
lines changed

1 file changed

+24
-6
lines changed

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

0 commit comments

Comments
 (0)