Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Closed
docs-bot opened this issue Mar 9, 2022 · 0 comments
Closed

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

docs-bot opened this issue Mar 9, 2022 · 0 comments
Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program

Comments

@docs-bot
Copy link
Collaborator

docs-bot commented Mar 9, 2022

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.

@docs-bot docs-bot added the help wanted Anyone is welcome to open a pull request to fix this issue label Mar 9, 2022
@ramyaparimi ramyaparimi added the MLH fellowship This issue is reserved for the MLH Fellowship program label Mar 9, 2022
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Mar 9, 2022
@ramyaparimi ramyaparimi removed the triage Do not begin working on this issue until triaged by the team label Mar 9, 2022
@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team and removed help wanted Anyone is welcome to open a pull request to fix this issue labels Mar 17, 2022
@github-project-automation github-project-automation bot moved this to Weeks 4-6 in MLH Fellowship Aug 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team MLH fellowship This issue is reserved for the MLH Fellowship program
Projects
Status: Weeks 4-6
Development

No branches or pull requests

6 participants
@janiceilene @lecoursen @ramyaparimi @docs-bot and others