Merge branch 'main' into sublanding-fixes

sarahs · web-flow · commit 36599fa9c6ae · 2021-04-27T20:44:52.000-04:00
diff --git a/assets/images/help/repository/readme-automatic-toc-setting.png b/assets/images/help/repository/readme-automatic-toc-setting.png
diff --git a/assets/images/help/repository/readme-automatic-toc.png b/assets/images/help/repository/readme-automatic-toc.png
diff --git a/content/admin/all-releases.md b/content/admin/all-releases.md
@@ -0,0 +1,37 @@
+---
+title: GitHub Enterprise Server releases
+intro: Documentation for the currently supported and previously deprecated versions of {{ site.data.variables.product.prodname_ghe_server }}.
+allowTitleToDifferFromFilename: true
+versions:
+  enterprise-server: '*'
+topics:
+  - enterprise
+---
+
+## Currently supported
+
+See [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise) for information about the latest release.
+
+{% for supportedRelease in enterpriseServerReleases.supported %}
+- [{% data variables.product.prodname_ghe_server %} {{supportedRelease}}](/enterprise-server@{{supportedRelease}})
+{% endfor %}
+
+## Deprecated
+
+Documentation for deprecated versions remains available but is no longer maintained.
+
+{% for deprecatedRelease in enterpriseServerReleases.deprecatedReleasesWithNewFormat %}
+- [Enterprise Server {{deprecatedRelease}}](/enterprise-server@{{deprecatedRelease}})
+{% endfor %}
+
+{% for deprecatedReleaseLegacyFormat in enterpriseServerReleases.deprecatedReleasesWithLegacyFormat %}
+- [Enterprise Server {{deprecatedReleaseLegacyFormat}}](/enterprise/{{deprecatedReleaseLegacyFormat}})
+{% endfor %}
+
+## Deprecated developer documentation
+
+Developer documentation for deprecated versions remains available but is no longer maintained.
+
+{% for deprecatedDevRelease in enterpriseServerReleases.deprecatedReleasesOnDeveloperSite %}
+- [Enterprise Server {{deprecatedDevRelease}}](https://developer.github.com/enterprise/{{deprecatedDevRelease}})
+{% endfor %}
diff --git a/content/admin/index.md b/content/admin/index.md
@@ -30,3 +30,5 @@ versions:
 {% link_with_intro /enterprise-support %}
 
 {% link_with_intro /release-notes %}
+
+{% link_with_intro /all-releases %}
diff --git a/content/github/creating-cloning-and-archiving-repositories/about-readmes.md b/content/github/creating-cloning-and-archiving-repositories/about-readmes.md
@@ -42,9 +42,22 @@ If you put your README file in your repository's root, `docs`, or hidden `.githu
 
 {% endif %}
 
+### Auto-generated table of contents for README files
+
+For the rendered view of any Markdown file in a repository, including README files, {% data variables.product.product_name %} will automatically generate a table of contents based on section headings. You can view the table of contents for a README file by clicking the {% octicon "list-unordered" aria-label="The unordered list icon" %}  menu icon at the top left of the rendered page.
+
+![README with automatically generated TOC](/assets/images/help/repository/readme-automatic-toc.png)
+
+The auto-generated table of contents is enabled by default for all Markdown files in a repository, but you can disable this feature for your repository.
+
+{% data reusables.repositories.navigate-to-repo %}
+{% data reusables.repositories.sidebar-settings %}
+1. Under "Features", deselect **Table of contents**.
+![Automatic TOC setting for repositories](/assets/images/help/repository/readme-automatic-toc-setting.png)
+
 ### Section links in README files and blob pages
 
-Many projects use a table of contents at the start of a README to direct users to different sections of the file. {% data reusables.repositories.section-links %}
+{% data reusables.repositories.section-links %}
 
 ### Relative links and image paths in README files
 
diff --git a/data/ui.yml b/data/ui.yml
@@ -64,14 +64,6 @@ contribution_cta:
   button: Make a contribution
   or: Or,
   to_guidelines: learn how to contribute.
-enterprise_releases_list:
-  title: Enterprise Server Releases
-  currently_supported: Currently supported
-  currently_supported_message: See <a href="https://github.com/enterprise">GitHub Enterprise</a> for information about the latest release.
-  deprecated: Deprecated
-  deprecated_message: 'These docs remain available but are no longer maintained:'
-  deprecated_developer: Deprecated on developer.github.com
-  deprecated_developer_message: 'These docs remain available on the legacy <a href="https://developer.github.com">developer site</a> but are no longer maintained:'
 products:
   graphql:
     reference:
diff --git a/includes/all-enterprise-releases-link.html b/includes/all-enterprise-releases-link.html
@@ -0,0 +1 @@
+<a class="f6 no-underline color-text-tertiary pt-1" href="/{{currentLanguage}}/{{enterpriseServerVersions[0]}}/admin/all-releases">See all Enterprise releases</a>
diff --git a/includes/article-version-switcher.html b/includes/article-version-switcher.html
@@ -14,7 +14,7 @@
       >
       {{ allVersions[permalink.pageVersion].versionTitle }}</a>
       {% endfor %}
-      <a class="f6 no-underline color-text-tertiary pt-1" href="/enterprise-server-releases">See all Enterprise releases</a>
+      {% include all-enterprise-releases-link %}
     </div>
   </details>
 {% endif %}
diff --git a/includes/header-notification.html b/includes/header-notification.html
@@ -39,7 +39,7 @@
 <!-- END ONEOFF EARLY ACCESS NOTICE -->
 
 {% if translation_notification_type %}
-  <div class="header-notifications text-center f5 color-bg-info-inverse color-text-primary py-4 px-6 translation_notice{% if release_notification_type %} border-bottom color-border-tertiary{% endif %}">
+  <div class="header-notifications text-center f5 color-bg-info color-text-primary py-4 px-6 translation_notice{% if release_notification_type %} border-bottom color-border-tertiary{% endif %}">
     {{ translation_notification }}
   </div>
 {% endif %}
diff --git a/includes/header-version-switcher.html b/includes/header-version-switcher.html
@@ -24,6 +24,7 @@
       >{{ allVersions[permalink.pageVersion].versionTitle }}</a>
       {% endunless %}
       {% endfor %}
+      {% include all-enterprise-releases-link %}
       </div>
     </details>
   </div>
diff --git a/layouts/enterprise-server-releases.html b/layouts/enterprise-server-releases.html
diff --git a/lib/redirects/get-old-paths-from-permalink.js b/lib/redirects/get-old-paths-from-permalink.js
@@ -99,6 +99,15 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren
   }
   // ------ END MODERN VERSION FORMAT REPLACEMENTS ------//
 
+  // ------ BEGIN ONEOFF REPLACEMENTS ------//
+
+  // create special old path /enterprise-server-releases from current path /enterprise-server@<release>/admin/all-releases
+  if (versionSatisfiesRange(currentVersion, `=${latest}`) && currentPath.endsWith('/admin/all-releases')) {
+    oldPaths.add('/enterprise-server-releases')
+  }
+
+  // ------ END ONEOFF REPLACEMENTS ------//
+
   // For each old path added to the set above, do the following...
   (new Set(oldPaths)).forEach(oldPath => {
     // for English only, remove language code
diff --git a/lib/render-content/plugins/rewrite-local-links.js b/lib/render-content/plugins/rewrite-local-links.js
@@ -50,7 +50,7 @@ function getNewHref (node, languageCode, version) {
   // /enterprise-server/rest/reference/oauth-authorizations (this redirects to the latest version)
   // /enterprise-server@latest/rest/reference/oauth-authorizations (this redirects to the latest version)
   const firstLinkSegment = href.split('/')[1]
-  if ([...supportedPlans, ...supportedVersions, 'enterprise-server@latest'].includes(firstLinkSegment)) {
+  if ([...supportedPlans, ...supportedVersions, 'enterprise-server@latest'].some(v => firstLinkSegment.startsWith(v))) {
     newHref = path.join('/', languageCode, href)
   }
 
diff --git a/middleware/enterprise-server-releases.js b/middleware/enterprise-server-releases.js
diff --git a/middleware/index.js b/middleware/index.js
@@ -130,7 +130,6 @@ module.exports = function (app) {
     app.use(asyncMiddleware(instrument('./contextualizers/early-access-breadcrumbs')))
   }
 
-  app.use(asyncMiddleware(instrument('./enterprise-server-releases')))
   app.use(asyncMiddleware(instrument('./dev-toc')))
   app.use(asyncMiddleware(instrument('./featured-links')))
   app.use(asyncMiddleware(instrument('./learning-track')))
diff --git a/tests/content/lint-files.js b/tests/content/lint-files.js
@@ -409,7 +409,10 @@ describe('lint markdown content', () => {
 
           // Filter out some very specific false positive matches
           const matches = initialMatches.filter(match => {
-            if (markdownRelPath === 'content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md') {
+            if (
+              markdownRelPath === 'content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md' ||
+              markdownRelPath === 'content/admin/all-releases.md'
+            ) {
               return false
             }
             return true
@@ -420,7 +423,16 @@ describe('lint markdown content', () => {
         })
 
         test('URLs must not contain a hard-coded domain name', async () => {
-          const matches = (content.match(domainLinkRegex) || [])
+          const initialMatches = (content.match(domainLinkRegex) || [])
+
+          // Filter out some very specific false positive matches
+          const matches = initialMatches.filter(match => {
+            if (markdownRelPath === 'content/admin/all-releases.md') {
+              return false
+            }
+            return true
+          })
+
           const errorMessage = formatLinkError(domainLinkErrorText, matches)
           expect(matches.length, errorMessage).toBe(0)
         })

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+<a class="f6 no-underline color-text-tertiary pt-1" href="/{{currentLanguage}}/{{enterpriseServerVersions[0]}}/admin/all-releases">See all Enterprise releases</a>`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`>`
`15`	`15`	`{{ allVersions[permalink.pageVersion].versionTitle }}</a>`
`16`	`16`	`{% endfor %}`
`17`		`- <a class="f6 no-underline color-text-tertiary pt-1" href="/enterprise-server-releases">See all Enterprise releases</a>`
	`17`	`+ {% include all-enterprise-releases-link %}`
`18`	`18`	`</div>`
`19`	`19`	`</details>`
`20`	`20`	`{% endif %}`