Project Visby site-policy updates (change date + hide from GitHub Docs) (#17139)

and support site policy hidden articles
This commit is contained in:
Abby Vollmer 2021-01-07 14:44:34 -08:00 коммит произвёл GitHub
Родитель 3b57913f90
Коммит f5a2c56de6
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
15 изменённых файлов: 63 добавлений и 21 удалений

Просмотреть файл

@ -1,5 +1,6 @@
---
title: Amendment to GitHub Terms of Service Applicable to U.S. Federal Government Users
hidden: true
redirect_from:
- /articles/amendment-to-github-terms-of-service-applicable-to-government-users/
- /articles/proposed-amendment-to-github-terms-of-service-applicable-to-u-s-federal-government-users/
@ -9,6 +10,8 @@ versions:
free-pro-team: '*'
---
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
{% tip %}
This Amendment to GitHub's [Terms of Service](/articles/github-terms-of-service) applies only to users that are using GitHub on behalf of the United States federal government. If you are not using GitHub on behalf of the U.S. federal government, the standard [GitHub Terms of Service](/articles/github-terms-of-service) apply to you.

Просмотреть файл

@ -1,12 +1,13 @@
---
title: GitHub AE Data Protection Agreement
hidden: true
versions:
free-pro-team: '*'
redirect_from:
- /github/site-policy/ghem-data-protection-addendum
---
Version Effective Date: November 1, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
## INTRODUCTION

Просмотреть файл

@ -1,12 +1,13 @@
---
title: GitHub AE Product Specific Terms
hidden: true
versions:
free-pro-team: '*'
redirect_from:
- /github/site-policy/ghem-supplemental-terms-for-microsoft-volume-licensing
---
Version Effective Date: November 1, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
The Agreement consists of these GitHub AE Product Specific Terms, the General Terms that Customer accepted, and any additional terms GitHub or its Affiliates present when an order is placed.

Просмотреть файл

@ -1,11 +1,15 @@
---
title: GitHub Connect Addendum to the GitHub Enterprise License Agreement
hidden: true
redirect_from:
- /articles/github-com-connection-addendum-to-the-github-enterprise-license-agreement/
- /articles/github-connect-addendum-to-the-github-enterprise-license-agreement
versions:
free-pro-team: '*'
---
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
PLEASE READ THIS ADDENDUM CAREFULLY AS IT AMENDS THE TERMS OF YOUR ENTERPRISE LICENSE AGREEMENT WITH US AND SPECIFICALLY GOVERNS YOUR USE OF GITHUB CONNECT (AS DEFINED BELOW), UNLESS GITHUB (“WE” OR “US”) HAS EXECUTED A SEPARATE WRITTEN ADDENDUM WITH YOU FOR THAT PURPOSE.
BY ACCESSING GITHUB CONNECT, YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS ADDENDUM. IF YOU ARE ENTERING INTO THIS ADDENDUM ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY (“CUSTOMER”), YOU REPRESENT THAT YOU HAVE THE LEGAL AUTHORITY TO BIND CUSTOMER TO THIS AGREEMENT.

Просмотреть файл

@ -1,10 +1,11 @@
---
title: GitHub Data Protection Addendum
hidden: true
versions:
free-pro-team: '*'
---
Version Effective Date: September 9, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
## INTRODUCTION

Просмотреть файл

@ -1,11 +1,14 @@
---
title: GitHub Enterprise Cloud Evaluation Agreement
hidden: true
redirect_from:
- /articles/github-enterprise-cloud-evaluation-agreement
versions:
free-pro-team: '*'
---
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
THANK YOU FOR CHOOSING GITHUB FOR YOUR COMPANY'S BUSINESS NEEDS. PLEASE READ THESE TERMS CAREFULLY AS IT GOVERNS YOUR EVALUATION USE OF THE SERVICE, UNLESS GITHUB HAS EXECUTED A SEPARATE WRITTEN AGREEMENT WITH YOU FOR THAT PURPOSE. BY CLICKING ON THE "I AGREE" OR SIMILAR BUTTON OR BY ACCESSING THE SERVICE ON A TRIAL BASIS, YOU ACCEPT ALL THE TERMS AND CONDITIONS OF THIS EVALUATION AGREEMENT. IF YOU ARE ENTERING INTO THIS EVALUATION AGREEMENT ON BEHALF OF A COMPANY OR OTHER LEGAL ENTITY (HEREINAFTER REFERRED TO AS "**CUSTOMER**"), CUSTOMER REPRESENTS THAT IT HAS THE LEGAL AUTHORITY TO BIND THE COMPANY OR OTHER LEGAL ENTITY TO THIS EVALUATION AGREEMENT. ALSO, BY ACCEPTING THESE TERMS, CUSTOMER AGREES THAT IT HAS READ GITHUB'S PRIVACY STATEMENT.
### 1. Corporate Terms of Service

Просмотреть файл

@ -1,12 +1,13 @@
---
title: GitHub Enterprise Server License Agreement
hidden: true
redirect_from:
- /articles/github-enterprise-server-license-agreement
versions:
free-pro-team: '*'
---
Effective Date: April 1, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
PLEASE READ THIS AGREEMENT CAREFULLY AS IT GOVERNS YOUR USE OF THE PRODUCTS (AS DEFINED BELOW), UNLESS WE HAVE EXECUTED A SEPARATE WRITTEN AGREEMENT WITH YOU FOR THAT PURPOSE.

Просмотреть файл

@ -1,5 +1,6 @@
---
title: GitHub Enterprise Service Level Agreement
hidden: true
redirect_from:
- /github-enterprise-cloud-addendum/
- /github-business-cloud-addendum/
@ -7,6 +8,9 @@ redirect_from:
versions:
free-pro-team: '*'
---
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
**Short version:** GitHub guarantees a 99.9% quarterly uptime commitment for the applicable GitHub service (the “**Service Level**” or “**SLA**”). If GitHub does not meet the SLA, then Customer will be entitled to a service credit to Customers account (“**Service Credits**”).
For definitions of each Service feature (“**Service Feature**”) and to review historical and current Uptime, visit the [GitHub Status Page](https://www.githubstatus.com/). Capitalized terms used but not defined in this SLA have the meaning assigned in Customers applicable agreement.

Просмотреть файл

@ -1,5 +1,6 @@
---
title: GitHub Enterprise Subscription Agreement
hidden: true
redirect_from:
- /articles/github-enterprise-agreement/
- /articles/github-enterprise-subscription-agreement
@ -7,7 +8,7 @@ versions:
free-pro-team: '*'
---
Version Effective Date: November 16, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
BY CLICKING THE "I AGREE" OR SIMILAR BUTTON OR BY USING ANY OF THE PRODUCTS (DEFINED BELOW), CUSTOMER ACCEPTS THE TERMS AND CONDITIONS OF THIS AGREEMENT. IF CUSTOMER IS ENTERING INTO THIS AGREEMENT ON BEHALF OF A LEGAL ENTITY, CUSTOMER REPRESENTS THAT IT HAS THE LEGAL AUTHORITY TO BIND THE LEGAL ENTITY TO THIS AGREEMENT.

Просмотреть файл

@ -1,5 +1,6 @@
---
title: GitHub Supplemental Terms for Microsoft Volume Licensing
hidden: true
redirect_from:
- /articles/GitHub-Supplemental-Terms-for-Microsoft-Volume-Licensing/
- /articles/github-supplemental-terms-for-microsoft-volume-licensing
@ -7,7 +8,7 @@ versions:
free-pro-team: '*'
---
Version Effective Date: July 20, 2020
_These terms apply to Customers who licensed the Products prior to January 4, 2021._
The following GitHub Supplemental Terms (including any applicable Order Forms) supplement Customer's Microsoft volume licensing agreement ("**Microsoft Customer Agreement**") and, together with the Microsoft Customer Agreement, govern Customer's use of the Products (as defined below). The Microsoft Customer Agreement is incorporated herein by this reference. Capitalized terms used but not defined in these supplemental terms have the meanings assigned to them in the Microsoft Customer Agreement.

Просмотреть файл

@ -4,6 +4,16 @@ files:
ignore:
- '/content/README.md'
- '/content/early-access'
- '/content/github/site-policy/github-enterprise-cloud-evaluation-agreement.md'
- '/content/github/site-policy/github-enterprise-service-level-agreement.md'
- '/content/github/site-policy/github-enterprise-server-license-agreement.md'
- '/content/github/site-policy/github-supplemental-terms-for-microsoft-volume-licensing.md'
- '/content/github/site-policy/github-ae-product-specific-terms.md'
- '/content/github/site-policy/amendment-to-github-terms-of-service-applicable-to-us-federal-government-users.md'
- '/content/github/site-policy/github-enterprise-subscription-agreement.md'
- '/content/github/site-policy/github-data-protection-addendum.md'
- '/content/github/site-policy/github-connect-addendum-to-the-github-enterprise-license-agreement.md'
- '/content/github/site-policy/github-ae-data-protection-agreement.md'
- source: /data/**/*.yml
translation: /translations/%locale%/%original_path%/%original_file_name%
- source: /data/**/*.md

Просмотреть файл

@ -1,18 +1,20 @@
<!-- START TRANSLATIONS NOTICES -->
<!-- Site policy translations notice -->
{% if currentLanguage != 'en' and page.relativePath contains '/site-policy/' %}
{% if currentLanguage != 'en' %}
{% assign translation_notification_type = "true" %}
{% assign translation_notification = site.data.reusables.policies.translation %}
<!-- Completed translations notice -->
{% elsif currentLanguage != 'en' && !languages[currentLanguage].wip %}
{% assign translation_notification_type = "true" %}
{% assign translation_notification = site.data.ui.header.notices.localization_complete %}
<!-- Site policy translations notice -->
{% if page.relativePath contains '/site-policy/' %}
{% assign translation_notification = site.data.reusables.policies.translation %}
<!-- Completed translations notice -->
{% elsif languages[currentLanguage].wip != true %}
{% assign translation_notification = site.data.ui.header.notices.localization_complete %}
<!-- In-progress translations notice -->
{% elsif languages[currentLanguage].wip %}
{% assign translation_notification = site.data.ui.header.notices.localization_in_progress %}
{% endif %}
<!-- In-progress translations notice -->
{% elsif currentLanguage != 'en' && languages[currentLanguage].wip %}
{% assign translation_notification_type = "true" %}
{% assign translation_notification = site.data.ui.header.notices.localization_in_progress %}
{% endif %}
<!-- END TRANSLATIONS NOTICES -->
@ -30,7 +32,7 @@
<!-- END RELEASE NOTICES -->
<!-- ONEOFF EARLY ACCESS NOTICE -->
{% if page.hidden %}
{% if page.hidden and page.relativePath contains "early-access/" %}
{% assign early_access_notification_type = true %}
{% assign early_access_notification = site.data.ui.header.notices.early_access %}
{% endif %}
@ -38,6 +40,7 @@
{% if translation_notification_type %}
<div class="header-notifications text-center f5 bg-blue-1 text-gray-dark py-4 px-6 translation_notice{% if release_notification_type %} border-bottom border-black-fade{% endif %}">
{{ currentLanguage }}
{{ translation_notification }}
</div>
{% endif %}

Просмотреть файл

@ -43,11 +43,13 @@
<a href="{{fullPathToMaptopic}}" class="pl-4 pr-5 py-2">{{ maptopic[1].title }}</a>
<ul class="sidebar-articles my-2">
{% for article in maptopic[1].articles %}
{% unless article[1].hidden %}
{% capture fullPathToArticle %}{{article[1].href}}{% endcapture %}
<li class="sidebar-article {% if breadcrumbs.article.href == article[1].href %}active {% if currentPath == fullPathToArticle %}is-current-page{% endif %}{% endif %}">
<a href="{{fullPathToArticle}}" class="pl-6 pr-5 py-1{% if forloop.last %} pb-2{% endif %}">{{ article[1].title }}</a>
</li>
{% endunless %}
{% endfor %}
</ul>
</li>
@ -58,10 +60,12 @@
{% else %}
<ul class="sidebar-articles list-style-none">
{% for article in category[1].articles %}
{% unless article[1].hidden %}
{% capture fullPathToArticle %}{{article[1].href}}{% endcapture %}
<li class="sidebar-article {% if breadcrumbs.article.href == article[1].href %}active {% if currentPath == fullPathToArticle %}is-current-page{% endif %}{% endif %}">
<a href="{{fullPathToArticle}}" class="pl-4 pr-5 py-1{% if forloop.last %} pb-2{% endif %}">{{ article[1].title }}</a>
</li>
{% endunless %}
{% endfor %}
</ul>
{% endif %}

Просмотреть файл

@ -158,6 +158,7 @@ function buildArticlesTree (tocItems, versionedCategoryHref, pageMap, redirects,
if (!page) return
article.title = page.shortTitle || page.title
article.hidden = page.hidden
articleTree[versionedArticleHref] = article
})

Просмотреть файл

@ -164,7 +164,7 @@ describe('lint-files', () => {
describe.each([...contentMarkdownTuples, ...reusableMarkdownTuples])(
'in "%s"',
(markdownRelPath, markdownAbsPath) => {
let content, isHidden, isEarlyAccess
let content, isHidden, isEarlyAccess, isSitePolicy
beforeAll(async () => {
const fileContents = await fs.promises.readFile(markdownAbsPath, 'utf8')
@ -173,10 +173,14 @@ describe('lint-files', () => {
content = bodyContent
isHidden = data.hidden === true
isEarlyAccess = markdownRelPath.split('/').includes('early-access')
isSitePolicy = markdownRelPath.split('/').includes('site-policy')
})
test('hidden docs must be Early Access', async () => {
expect(isHidden).toBe(isEarlyAccess)
// We need to support some non-Early Access hidden docs in Site Policy
test('hidden docs must be Early Access or Site Policy', async () => {
if (isHidden) {
expect(isEarlyAccess || isSitePolicy).toBe(true)
}
})
test('relative URLs must start with "/"', async () => {