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/README.md
+10-3Lines changed: 10 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -24,6 +24,7 @@ See the [contributing docs](/CONTRIBUTING.md) for general information about work
24
24
-[Escaping single quotes](#escaping-single-quotes)
25
25
-[Autogenerated mini TOCs](#autogenerated-mini-tocs)
26
26
-[Versioning](#versioning)
27
+
-[Free-pro-team vs. GitHub.com versioning](#free-pro-team-vs.-github.com-versioning)
27
28
-[Filenames](#filenames)
28
29
-[Whitespace control](#whitespace-control)
29
30
-[Links and image paths](#links-and-image-paths)
@@ -213,6 +214,12 @@ A content file can have **two** types of versioning:
213
214
* Liquid statements in content (**optional**)
214
215
* Conditionally render content depending on the current version being viewed. See [contributing/liquid-helpers](../contributing/liquid-helpers.md) for more info. Note Liquid conditionals can also appear in `data` and `include` files.
215
216
217
+
### Free-pro-team vs. GitHub.com versioning
218
+
219
+
As of early 2021, the `free-pro-team@latest` version is **only** supported in content files (in both frontmatter and Liquid versioning) and throughout the docs site backend. It is **not** user facing. A helper function called `lib/remove-fpt-from-path.js` removes the version from URLs. Users now select `GitHub.com` in the Article Versions dropdown instead of `Free, Pro, Team`.
220
+
221
+
The convenience function allows us to continue supporting a consistent versioning structure under-the-hood while not displaying plan information to users that may be potentially confusing.
222
+
216
223
## Filenames
217
224
218
225
When adding a new article, make sure the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the title you use in the article's [`title`](#title) frontmatter. This can get tricky when a title has punctuation (such as "GitHub's Billing Plans"). A test will flag any discrepancies between title and filename. To override this requirement for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) frontmatter.
@@ -224,7 +231,7 @@ When using Liquid conditionals in lists or tables, you can use [whitespace contr
224
231
Just add a hyphen on either the left, right, or both sides to indicate that there should be no newline on that side. For example, this statement removes a newline on the left side:
225
232
226
233
```
227
-
{%- if page.version == 'dotcom' %}
234
+
{%- if currentVersion == 'free-pro-team@latest' %}
228
235
```
229
236
230
237
These characters are especially important in [index pages](#index-pages) comprised of list items.
@@ -238,9 +245,9 @@ For example, if you include the following link in a content file:
238
245
```
239
246
/github/writing-on-github/creating-a-saved-reply
240
247
```
241
-
When viewed on GitHub.com docs, the link gets rendered with the language code and version:
248
+
When viewed on GitHub.com docs, the link gets rendered with the language code:
0 commit comments