Skip to content

Commit

Permalink
content strategy bug fixes 4-19-2024 (#50245)
Browse files Browse the repository at this point in the history
  • Loading branch information
ethanpalm authored Apr 24, 2024
1 parent ad6435c commit 452c13f
Showing 1 changed file with 12 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -141,9 +141,14 @@ Only include a CTA button if navigating to the link supports user needs. Do not
Style your CTAs using the following format.

```html
{% raw %}<a href="https://github.com/DESTINATION/URL" target="_blank" class="btn btn-primary mt-3 mr-3 no-underline"><span>Try PRODUCT NAME</span> {% octicon "link-external" height:16 %}</a>{% endraw %}
{% 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 %}
```

Replace the placeholders with the relevant information for your CTA.
- `DESTINATION/URL`: The URL that the button should navigate to.
- `CTA+NAME`: The name of the CTA. For example, `GHEC+trial` or `Copilot+Business+Trial`.
- `LOCATION`: The location in {% data variables.product.prodname_docs %} of the CTA. For example, `Setting+up+a+trial+of+GitHub+Enterprise+Cloud`.

## Code

### Code blocks
Expand Down Expand Up @@ -289,6 +294,12 @@ When you include the text of an error message from a {% data variables.product.c

- If the message appears in a command-line interface, log output, or a response from an API, reproduce the text exactly and use backticks to format the message using a monospaced font.

## Expiring content

In general, do not document content that will expire. Anyone who visits {% data variables.product.prodname_docs %} should be confident that the information is accurate and up to date.

If you must document content that you know will expire, you can use the content linter to tag and track the content's expiration date. This will flag the content as outdated and avoids tracking expiration dates outside of the content itself. See "[AUTOTITLE](/contributing/collaborating-on-github-docs/using-the-content-linter#syntax-for-expiring-and-expired-content)" for information on how to format expiring content tags.
## Footnotes
Avoid using footnotes where possible. Consider instead whether you could use a [callout](#callouts) or present the information in another way. See some [examples of alternatives to footnotes from NICE.org.uk](https://www.nice.org.uk/corporate/ecd6/chapter/footnotes).
Expand Down

0 comments on commit 452c13f

Please sign in to comment.