Skip to content

Latest commit

 

History

History
164 lines (107 loc) · 8.74 KB

liquid-helpers.md

File metadata and controls

164 lines (107 loc) · 8.74 KB
Raw

Liquid helpers

We use the liquid template language (specifically, this Node.js port) to create different versions of our content.

Note: If you are an open source contributor, you should not worry about versioning content. This document is only here as reference.

Versioning documentation for GitHub Enterprise

In this guide

Versioned documentation types for GitHub Enterprise

We provide versioned documentation for GitHub Enterprise users. This means the material on docs.github.com is scoped to specific product offerings.

Documentation for GitHub Enterprise can generally be divided into three types: documentation for the latest release, documentation for any previous supported release, and documentation for a deprecated release.

Liquid conditional operators

Comparison operators

Operator Meaning
ver_gt Greater than
ver_lt Less than
== Equal to
!= Not equal to**

Logical operators

Note: The below examples are only intended to show Liquid syntax and operators. The variables may not reflect what's currently in the content files.

In statements where all operands must be true for the condition to be true, use the operator and:

{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}

In statements where at least one operand must be true for the condition to be true, use the operator or:

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}

Do not use the operators && or ||. If you do, the content will not render in the intended versions. Only use and or or.

Liquid conditional statements for GitHub Enterprise

Use the custom ver_gt and ver_lt Liquid operators to conditionally include or exclude GitHub Enterprise content.

  • ver_lt stands for "version less than"
  • ver_gt stands for "version" greater than"

See the Semantic Versioning specification for more details on version precedence.

Including content in all supported versions

If your content is included in all versions of Enterprise, you need not include any Liquid logic at all. The Markdown source will automatically generate the HTML content for all supported versions.

Including content that only applies to Dotcom

If your content only applies to GitHub.com, such as billing information, use this logic:

{% if currentVersion == "free-pro-team@latest" %}This is how you pay for your personal account, which is something you wouldn't do in Enterprise.{% endif %}

In this example:

  • if currentVersion == "free-pro-team@latest" will include the content for Dotcom output and only Dotcom.
  • {% endif %} ends the statement.

Including content for new Dotcom features that will be included in Enterprise

If your content is describing a new feature that was added to GitHub.com and will be automatically included in the next release of GitHub Enterprise, use this logic:

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}This is a brand new feature, the likes of which have never been seen at this company before!{% endif %}

In this example:

  • if currentVersion == "free-pro-team@latest" will include the content for GitHub.com output.
  • or currentVersion ver_gt "enterprise-server@2.21" will include the content for releases after Enterprise 2.21, which means the content will be included for 2.7+.
  • {% endif %} ends the statement.

Including content for changed Dotcom features that will also change in Enterprise

If your content is describing a change to existing functionality in Dotcom, such as changed UI text or a more simple means of completing a task, use this logic:

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "2.20" %}This is the new way of doing things {% else %}This is the old way of doing things {% endif %}

In this example:

  • if currentVersion == "free-pro-team@latest" will include the content for GitHub.com output.
  • or currentVersion ver_gt "enterprise-server@2.21" will include the content for releases after Enterprise 2.21, which means the content will be included for 2.22+.
  • {% else %} means if the above is NOT true, then display the content that follows, This is the old way of doing things.
  • {% endif %} ends the statement.

Including content for changed Dotcom features that will also change in Enterprise but don't exist in some older versions

If your content is describing a change to existing functionality in Dotcom, and that functionality doesn't exist in all older Enterprise versions, use logic like this:

{% if currentVersion == 'dotcom' or currentVersion ver_gt "2.20" %}

This is the new way of doing things.

{% endif %}
{% if currentVersion ver_gt "enterprise-server@2.19" and currentVersion ver_lt "2.21" %}

This is the old way of doing things (which did not exist before 2.20).

{% endif %}

In this example:

  • if currentVersion == "free-pro-team@latest" will include the content for GitHub.com output.
  • or currentVersion ver_gt "2.20" will include the content for releases after Enterprise 2.20, which means the content will be included for 2.21+.
  • elsif currentVersion ver_gt "enterprise-server@2.19" and currentVersion ver_lt "2.21" means if the above is NOT true, and the version is 2.20, then display the content that follows, This is the old way of doing things. No content will be displayed for versions older than 2.20.
  • {% endif %} ends the statement.

Including content for new Enterprise features that don't exist on Dotcom

If your content is describing a new feature that was added to GitHub Enterprise but not GitHub, such as LDAP support, use this logic:

{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}This is a brand new feature, admin-type people!{% endif %}

In this example:

  • if currentVersion != "free-pro-team@latest" will exclude the content for GitHub.com output.
  • and currentVersion ver_gt "enterprise-server@2.21" will additionally include the content for releases after Enterprise 2.21, which means the content will be included for 2.22+.
  • {% endif %} ends the statement.

Including content for changed Enterprise features that don't exist on Dotcom

If your content is describing a change to existing functionality in GitHub Enterprise, such as changed UI text or a more simple means of completing a task in the Management Console, use this logic:

{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}This is the new way of doing things, admins! {% else %}This is the old way of doing things, admins! {% endif %}

In this example:

  • if currentVersion != "free-pro-team@latest" will exclude the content for GitHub.com output.
  • and currentVersion ver_gt "enterprise-server@2.21" will additionally include the content for releases after Enterprise 2.21, which means the content will be included for 2.22+.
  • {% else %} means if the above is NOT true, then display the content that follows, This is the old way of doing things, admins!.
  • {% endif %} ends the statement.