Skip to content

[GHEC version] Replace dotcom-only class with version in path #16158

Closed
@docs-bot

Description

@docs-bot

This issue is reserved for MLH fellowship

Audit uses of the dotcom-only class and replace them with relative URLs that start with a version ("plan").

For example, for a given link that uses the dotcom-only class, you'll need to determine whether the link should be to Free, Pro, and Team (fpt) documentation or GitHub Enterprise Cloud (ghec) documentation. Then, you'll need to version the prose so that it reads naturally in any versions of the article.

  • This is an example of a link between documentation sets where the entire sentence with the link is only versioned for GitHub Enterprise Server, so only one format is required.

  • If the sentence is versioned for multiple products, update the versions of the link that are different than the destination version, only, to include the version in the path and "in the X documentation" after the link.

    For more information, see "[ARTICLE]({% ifversion not ghec %}/enterprise-cloud@latest{% endif %}/...){% ifversion ghec %}."{% else %}" in the {% data variables.product.prodname_ghe_cloud %} documentation.{% endif %}
    

If a link should go to the fpt version instead of the ghec version, you can say "...in the GitHub.com documentation", and you can use {% data variables.product.prodname_dotcom_the_website %} for GitHub.com.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    MLH fellowshipThis issue is reserved for the MLH Fellowship programcontentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    • Status

      Weeks 4-6

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions