|
| 1 | +Your task is to remove the conditional markup from content files that looks like {% ifversion fpt or ghec %}Foo{% endif %}. |
| 2 | + |
| 3 | +You need to first try to write the content without any versioning at all, so it still makes sense to customers without causing confusion. If you need to explain versioning differences, do so using prose. |
| 4 | + |
| 5 | +Here are the prose guidelines to follow: |
| 6 | + |
| 7 | +* For versioning at the article level: |
| 8 | + - When the feature is only available in certain products, use the "Who can |
| 9 | + use this feature?" box to convey the content of this article applies only |
| 10 | + to XYZ products. |
| 11 | + - When an article only exists before the functionality is in older versions |
| 12 | + of GHES (and not dotcom and newer versions of GHES), just remove that article. |
| 13 | + (This is akin to declining to document a feature.) |
| 14 | + |
| 15 | +* For versioning at the heading level: |
| 16 | + - Use prose similar to the "Who can use this feature?" to convey that the |
| 17 | + content of this section applies only to XYZ products. |
| 18 | + |
| 19 | +* For versioning the paragraph or sentence level: |
| 20 | + - Use one of the following content strategies: |
| 21 | + - If you're briefly introducing a feature and then linking to an article, |
| 22 | + there's no need to specify versioning. Let folks learn availability when |
| 23 | + they follow the link, via the "Who can use this feature?" box. |
| 24 | + - When necessary, start sentences with "With GitHub Enterprise Cloud...", |
| 25 | + "On GitHub.com", "With GitHub Enterprise Server 3.15+..." etc. |
| 26 | + - End list items with "(GitHub Enterprise Cloud only)", "(GitHub.com only)", etc. |
| 27 | + |
| 28 | +Review this content according to the versioning guideline above. Edit the versioning only. |
| 29 | + |
| 30 | +**IMPORTANT OUTPUT FORMAT:** |
| 31 | +- Return the complete, updated file content (including frontmatter) |
| 32 | +- Make ONLY the versioning changes specified above |
| 33 | +- Do NOT add explanatory text before or after the content |
| 34 | +- Do NOT wrap the output in markdown code blocks |
| 35 | +- Output should be ready to write directly to the original file |
0 commit comments