You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/contributing/style-guide-and-content-model/style-guide.md
+19-25Lines changed: 19 additions & 25 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -151,34 +151,28 @@ A CTA is an explicit direction to the user to take an immediate action, such as
151
151
152
152
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 %}.
153
153
154
-
### Required CTA parameters
155
-
156
-
*`ref_product`:
157
-
***Purpose**: The GitHub product the CTA leads users to.
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
177
160
```
178
161
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.
180
170
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:
0 commit comments