Skip to content

Commit

Permalink
Merge branch 'main' of github.com:github/docs-internal into build-ind…
Browse files Browse the repository at this point in the history
…ices-for-given-version
  • Loading branch information
sarahs committed Nov 20, 2020
2 parents 6041ffc + 912ac50 commit 642e669
Show file tree
Hide file tree
Showing 25 changed files with 408 additions and 74 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion content/admin/configuration/command-line-utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Allows you to find the uuid of your node in `cluster.conf`.
Allows you to exempt a list of users from API rate limits. For more information, see "[Resources in the REST API](/rest/overview/resources-in-the-rest-api#rate-limiting)."

``` shell
$ ghe-config app.github.rate_limiting_exempt_users "<em>hubot</em> <em>github-actions</em>"
$ ghe-config app.github.rate-limiting-exempt-users "<em>hubot</em> <em>github-actions</em>"
# Exempts the users hubot and github-actions from rate limits
```
{% endif %}
Expand Down
7 changes: 7 additions & 0 deletions content/admin/release-notes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Release notes
intro: The release notes for {{ allVersions[currentVersion].versionTitle }}.
layout: release-notes
versions:
enterprise-server: '*'
---
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ versions:
free-pro-team: '*'
---

Welcome to GitHub Marketplace ("Marketplace")! We're happy you're here. Please read these Terms of Service ("Marketplace Terms") carefully before accessing or using GitHub Marketplace. GitHub Marketplace is a platform that allows you to purchase developer products (for free or for a charge) that can be used with your GitHub.com account ("Developer Products"). Although sold by GitHub, Inc. ("GitHub", "we", "us"), Developer Products may be developed and maintained by either GitHub or by third-party software providers, and may require you to agree to a separate terms of service. Your use and/or purchase of Developer Products is subject to these Marketplace Terms and to the applicable fees and may also be subject to additional terms as provided by the third party licensor of that Developer Product (the "Product Provider").
Welcome to GitHub Marketplace ("Marketplace")! We're happy you're here. Please read these Terms of Service ("Marketplace Terms") carefully before accessing or using GitHub Marketplace. GitHub Marketplace is a platform that allows you to select developer apps or actions (for free or for a charge) that can be used with your GitHub.com account ("Developer Products"). Although offered by GitHub, Inc. ("GitHub", "we", "us"), Developer Products may be developed and maintained by either GitHub or by third-party software providers. Your selection or use of Developer Products is subject to these Marketplace Terms and any applicable fees, and may require you to agree to additional terms as provided by the third party licensor of that Developer Product (the "Product Provider").

By using Marketplace, you are agreeing to be bound by these Marketplace Terms.

Effective Date: October 11, 2017
Effective Date: November 20, 2020

### A. GitHub.com's Terms of Service

Expand Down Expand Up @@ -40,11 +40,11 @@ If you would have a question, concern, or dispute regarding your billing, please

### E. Your Data and GitHub's Privacy Policy

**Privacy.** When you purchase or subscribe to a Developer Product, GitHub must share certain Personal Information (as defined in the [GitHub Privacy Statement](/articles/github-privacy-statement/)) with the Product Provider in order to provide you with the Developer Product, regardless of your privacy settings. Depending on the requirements of the Developer Product you choose, GitHub may share as little as your user account name, ID, and primary email address or as much as access to the content in your repositories, including the ability to read and modify your private data. You will be able to view the scope of the permissions the Developer Product is requesting, and accept or deny them, when you grant it authorization via OAuth. In line with [GitHub's Privacy Statement](/articles/github-privacy-statement/), we will only provide the Product Provider with the minimum amount of information necessary for the purpose of the transaction.
**Privacy.** When you select or use a Developer Product, GitHub may share certain Personal Information (as defined in the [GitHub Privacy Statement](/articles/github-privacy-statement/)) with the Product Provider (if any such Personal Information is received from you) in order to provide you with the Developer Product, regardless of your privacy settings. Depending on the requirements of the Developer Product you choose, GitHub may share as little as your user account name, ID, and primary email address or as much as access to the content in your repositories, including the ability to read and modify your private data. You will be able to view the scope of the permissions the Developer Product is requesting, and accept or deny them, when you grant it authorization via OAuth.

If you cancel your Developer Product services and revoke access through your account settings, the Product Provider will no longer be able to access your account. The Product Provider is responsible for deleting your Personal Information from its systems within its defined window. Please contact the Product Provider to ensure that your account has been properly terminated.
If you cease using the Developer Product and revoke access through your account settings, the Product Provider will no longer be able to access your account. The Product Provider is responsible for deleting your Personal Information from its systems within its defined window. Please contact the Product Provider to ensure that your account has been properly terminated.

**Data Security Disclaimer.** When you purchase or subscribe to a Developer Product, the Developer Product security and their custodianship of your data is the responsibility of the Product Provider. You are responsible for understanding the security considerations of the purchase and use of the Developer Product for your own security, risk and compliance considerations.
**Data Security and Privacy Disclaimer.** When you select or use a Developer Product, the security of the Developer Product and the custodianship of your data, including your Personal Information (if any), is the responsibility of the Product Provider. You are responsible for understanding the security and privacy considerations of the selection or use of the Developer Product for your own security and privacy risk and compliance considerations.

### F. Rights to Developer Products

Expand Down
Empty file added data/release-notes/.gitkeep
Empty file.
2 changes: 1 addition & 1 deletion data/reusables/ssh/add-ssh-key-to-ssh-agent-commandline.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
```shell
$ ssh-add ~/.ssh/id_rsa
$ ssh-add ~/.ssh/id_ed25519
```
2 changes: 1 addition & 1 deletion data/reusables/ssh/add-ssh-key-to-ssh-agent.md
Original file line number Diff line number Diff line change
@@ -1 +1 @@
If you created your key with a different name, or if you are adding an existing key that has a different name, replace *id_rsa* in the command with the name of your private key file.
If you created your key with a different name, or if you are adding an existing key that has a different name, replace *id_ed25519* in the command with the name of your private key file.
8 changes: 1 addition & 7 deletions includes/article.html
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,6 @@ <h3 id="in-this-article" class="f5 mb-2"><a class="link-gray-dark" href="#in-thi
{% endfor %}
</ul>
{% endif %}
<div class="d-none d-xl-block{% if miniTocItems.size > 1 %} border-top border-gray-light mt-4{% endif %}">
{% assign helpId = 'xl' %}
{% include helpfulness %}
{% include contribution %}
</div>
</div>
</div>
<div id="article-contents" class="article-grid-body">
Expand All @@ -70,8 +65,7 @@ <h3 id="in-this-article" class="f5 mb-2"><a class="link-gray-dark" href="#in-thi
</div>
</div>

<div class="d-block d-xl-none border-top border-gray-light mt-4 markdown-body">
{% assign helpId = 'sm' %}
<div class="d-block border-top border-gray-light mt-4 markdown-body">
{% include helpfulness %}
{% include contribution %}
</div>
Expand Down
24 changes: 12 additions & 12 deletions includes/helpfulness.html
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{% unless enterpriseServerReleases.isOldestReleaseDeprecated and currentVersion contains enterpriseServerReleases.oldestSupported %}
<form class="js-helpfulness mt-4 f5" id="helpfulness-{{ helpId }}">
<form class="js-helpfulness mt-4 f5">
<h4
data-help-start
data-help-yes
Expand All @@ -19,24 +19,24 @@
>
<input
hidden
id="helpfulness-yes-{{ helpId }}"
id="helpfulness-yes"
type="radio"
name="helpfulness-vote"
value="Yes"
aria-label="{% data ui.helpfulness.yes %}"
/>
<label class="btn x-radio-label" for="helpfulness-yes-{{ helpId }}">
<label class="btn x-radio-label" for="helpfulness-yes">
{% octicon "thumbsup" height="24" %}
</label>
<input
hidden
id="helpfulness-no-{{ helpId }}"
id="helpfulness-no"
type="radio"
name="helpfulness-vote"
value="No"
aria-label="{% data ui.helpfulness.no %}"
/>
<label class="btn x-radio-label" for="helpfulness-no-{{ helpId }}">
<label class="btn x-radio-label" for="helpfulness-no">
{% octicon "thumbsdown" height="24" %}
</label>
</p>
Expand All @@ -55,7 +55,7 @@
<p hidden data-help-no>
<label
class="d-block mb-1 f6"
for="helpfulness-category-{{ helpId }}"
for="helpfulness-category"
>
{% data ui.helpfulness.category_label %}
<span class="text-normal text-gray-light float-right ml-1">
Expand All @@ -65,7 +65,7 @@
<select
class="form-control select-sm width-full"
name="helpfulness-category"
id="helpfulness-category-{{ helpId }}"
id="helpfulness-category"
>
<option value="">
{% data ui.helpfulness.category_default %}
Expand All @@ -87,7 +87,7 @@
<p hidden data-help-no>
<label
class="d-block mb-1 f6"
for="helpfulness-comment-{{ helpId }}"
for="helpfulness-comment"
>
<span>{% data ui.helpfulness.comment_label %}</span>
<span class="text-normal text-gray-light float-right ml-1">
Expand All @@ -97,13 +97,13 @@
<textarea
class="form-control input-sm width-full"
name="helpfulness-comment"
id="helpfulness-comment-{{ helpId }}"
id="helpfulness-comment"
></textarea>
</p>
<p>
<label
class="d-block mb-1 f6"
for="helpfulness-email-{{ helpId }}"
for="helpfulness-email"
hidden
data-help-no
>
Expand All @@ -116,7 +116,7 @@
type="email"
class="form-control input-sm width-full"
name="helpfulness-email"
id="helpfulness-email-{{ helpId }}"
id="helpfulness-email"
placeholder="{% data ui.helpfulness.email_placeholder %}"
hidden
data-help-yes
Expand All @@ -137,4 +137,4 @@
{% data ui.helpfulness.feedback %}
</p>
</form>
{% endunless %}
{% endunless %}
12 changes: 12 additions & 0 deletions includes/release-notes-category-label.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{% assign sectionTitle = section.title | default: 'Misc' %}

{% case sectionTitle %}
{% when "New Feature" %}
{% assign colors = "bg-orange text-white" %}
{% when "Bugs" %}
{% assign colors = "bg-purple text-white" %}
{% else %}
{% assign colors = "bg-blue text-white" %}
{% endcase %}

<span class="{{ colors }} px-3 py-2 f5 text-uppercase text-mono">{{ sectionTitle }}</span>
24 changes: 0 additions & 24 deletions javascripts/experiment.js
Original file line number Diff line number Diff line change
Expand Up @@ -41,28 +41,4 @@ export default function () {
// const xbucket = bucket(testName)
// if (xbucket === TREATMENT) { ... }
// x.addEventListener('click', () => { sendSuccess(testName) })

const testName = 'helpfulness-prompt-to-bottom'
const xbucket = bucket(testName)

if (xbucket === TREATMENT) {
const bigHelpfulness = document.querySelector('#helpfulness-xl')
const smallHelpfulness = document.querySelector('#helpfulness-sm')

// Check that helpfulness prompt is present on this page
if (!(bigHelpfulness && smallHelpfulness)) {
return
}

// Remove the -xl prompts
bigHelpfulness.parentElement.parentElement.removeChild(bigHelpfulness.parentElement)

// Always show the -sm prompt
smallHelpfulness.parentElement.classList.remove('d-xl-none')
}

const votes = Array.from(document.querySelectorAll('.js-helpfulness [type=radio]'))
votes.forEach(voteEl => {
voteEl.addEventListener('change', () => { sendSuccess(testName) })
})
}
14 changes: 6 additions & 8 deletions javascripts/helpfulness.js
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
import { sendEvent } from './events'

export default function helpfulness () {
const forms = Array.from(document.querySelectorAll('.js-helpfulness'))
const form = document.querySelector('.js-helpfulness')
const texts = Array.from(document.querySelectorAll('.js-helpfulness input, .js-helpfulness textarea'))
const votes = Array.from(document.querySelectorAll('.js-helpfulness [type=radio]'))
if (!forms.length || !texts.length || !votes.length) return
if (!form || !texts.length || !votes.length) return

forms.forEach(form => {
form.addEventListener('submit', async evt => {
evt.preventDefault()
await submitForm(evt.target)
updateDisplay(form, 'end')
})
form.addEventListener('submit', async evt => {
evt.preventDefault()
await submitForm(evt.target)
updateDisplay(form, 'end')
})

votes.forEach(voteEl => {
Expand Down
93 changes: 93 additions & 0 deletions layouts/release-notes.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
{% assign product = siteTree[currentLanguage][currentVersion].products[currentProduct] %}

<!doctype html>
<html lang="{{currentLanguage}}">
{% include head %}

<body class="d-lg-flex">
{% include sidebar %}

<main class="width-full">
{% include header %}
{% include deprecation-banner %}

<div class="container-xl px-3 px-md-6 my-4 my-lg-4 markdown-body">
<div class="d-lg-flex flex-justify-between">
<div class="d-block d-lg-none">{% include article-version-switcher %}</div>
<div class="d-flex flex-items-center" style="height: 39px;">
{% include breadcrumbs %}
</div>
<div class="d-none d-lg-block">{% include article-version-switcher %}</div>
</div>

<article class="mt-2 d-flex gutter">
<div class="col-12 col-md-10">
<header>
<h1>{{ allVersions[currentVersion].versionTitle }}</h1>
</header>

{% for patch in releaseNotes %}
<details id="{{ patch.version }}" class="details-reset mb-3" {% if forloop.first %}open{% endif %}>
<summary class="position-sticky top-0 bg-white pb-2 d-flex flex-items-center flex-justify-between border-bottom">
<h2 class="d-flex flex-items-center border-bottom-0">
{{ patch.version }}

{% if patch.release_candidate %}
<span class="IssueLabel bg-orange text-white mx-2">Release Candidate</span>
{% endif %}
</h2>

<div>
<span class="text-gray-light text-mono text-small" style="margin-left: auto">{{ patch.date | date: "%B %d, %Y" }}</span>

<div class="mt-1 d-flex flex-items-center f5">
<a href="https://enterprise.github.com/releases/{{ patch.version }}/download">
Download GHES {{ patch.version }}
</a>

<button class="js-print btn-link ml-6">
Print
</button>
</div>
</div>
</summary>

<p>{{ patch.intro }}</p>

{% for section in patch.sortedNotes %}
<div class="py-6 border-bottom d-block d-md-flex flex-items-baseline">
<div class="mr-2 flex-shrink-0 mb-3">
{% include 'release-notes-category-label' %}
</div>

<ul class="flex-auto container-xl">
{% for note in section.notes %}
{% if note.note and note.note != '<p>n/a</p>' %}
<li>
{{ note.note }}
</li>
{% endif %}
{% endfor %}
</ul>
</div>
{% endfor %}
</details>
{% endfor %}
</div>

<aside class="col-2 d-none d-md-block no-print">
<h3 class="f5">Patch versions</h3>
<ul>
{% for patch in releaseNotes %}
<li><a href="#{{ patch.version }}">{{ patch.version }}</a></li>
{% endfor %}
</ul>
</aside>
</article>
</div>

{% include support %}
{% include small-footer %}
</main>
</body>
</html>
2 changes: 1 addition & 1 deletion lib/liquid-tags/extended-markdown.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ const tags = {
danger: 'border rounded-1 mb-4 p-3 border-red bg-red-light f5'
}

const template = '<div class="extended-markdown {{ tagName }} {{ classes }}">{{ output }}</div>'
const template = '<div class="extended-markdown {{ tagName }} {{ classes }}">\n{{ output }}\n</div>'

class ExtendedMarkdown extends Liquid.Block {
async render (context) {
Expand Down
34 changes: 34 additions & 0 deletions lib/release-notes-schema.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
module.exports = {
properties: {
intro: {
type: 'string',
required: true
},
date: {
type: 'string',
format: 'date',
required: true
},
release_candidate: {
type: 'boolean',
default: false
},
notes: {
required: true,
type: 'array',
items: {
type: 'object',
properties: {
note: {
type: 'string',
required: true
},
type: {
type: 'string',
required: true
}
}
}
}
}
}
7 changes: 7 additions & 0 deletions lib/render-content.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,13 @@ renderContent.liquid.registerFilters({
obj_size: (input) => {
if (!input) return 0
return Object.keys(input).length
},
/**
* Returns the version number of a GHES version string
* ex: [email protected] => 2.22
*/
version_num: (input) => {
return input.split('@')[1]
}
})

Expand Down
Loading

0 comments on commit 642e669

Please sign in to comment.