use azure blob storage for archived enterprise versions (#31883)

Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: mchammer01 <42146119+mchammer01@users.noreply.github.com>
github · Oct 25, 2022 · 3e998f6 · Jaxensdad2012 · Nov 9, 2023 · GNng221
1 parent 2cf9768
commit 3e998f6
Show file tree

Hide file tree

Showing 546 changed files with 841 additions and 1,000,122 deletions.
diff --git a/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md b/.github/actions-scripts/enterprise-server-issue-templates/deprecation-issue.md
@@ -6,7 +6,6 @@ The day after a GHES version's [deprecation date](https://github.com/github/docs
 
 The following large repositories are used throughout this checklist, it may be useful to clone them before you begin:
 
-- `github/help-docs-archived-enterprise-versions`
 - `github/github`
 - `github/docs-internal`
 
@@ -18,46 +17,85 @@ Additionally, you may want to download:
 
 **Note**: This step can be performed independently of all other steps, and can be done several days before or along with the other steps.
 
-- [ ] In the `docs-content` repo, remove the deprecated GHES version number from the "Specific GHES version(s)" section in the following files (in the `.github/ISSUE_TEMPLATE/` directory): [`release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml).
+- [ ] In the `docs-content` repo, remove the deprecated GHES version number from the `options` list in the following files (in the `.github/ISSUE_TEMPLATE/` directory): [`release-tier-1-or-2-tracking.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-1-or-2-tracking.yml) and [`release-tier-3-or-tier-4.yml`](https://github.com/github/docs-content/blob/main/.github/ISSUE_TEMPLATE/release-tier-3-or-tier-4.yml).
 - [ ] When the PR is approved, merge it in. This can be merged independently from all other steps.
 
 ## Step 1: Scrape the docs and archive the files
 
-- [ ] In your checkout of the [repo with archived GHES content](https://github.com/github/help-docs-archived-enterprise-versions), create a new branch: `git checkout -b deprecate-<version>`
 - [ ] In your `docs-internal` checkout, download the static files for the oldest supported version into your archival checkout:
       The archive script depends on an optional dependency so install optional dependencies first:
   ```
-  $ npm i --include-optional
+  $ npm i --include=optional
   ```
   Ensure your build is up to date:
   ```
   $ npm run build
   ```
   Then run the archive script:
   ```
-  $ script/enterprise-server-deprecations/archive-version.js -p <path-to-archive-repo-checkout>
+  $ script/enterprise-server-deprecations/archive-version.js
   ```
-  If your checkouts live in the same directory, this command would be:
+
+  This will generate a directory in `github/docs-internal` called `tmpArchivalDir_<VERSION_TO_DEPRECATE>`. For example 'tmpArchivalDir_3.0'. You can also create a specific output directory using the `--output` flag.
+
+  **Note:** You can pass the `--dry-run` flag to scrape only the first 10 pages plus their redirects for testing purposes. **If you use the dry run command, be sure to run the full script without `--dry-run` before you commit the changes.**
+
+## Step 3: Manually remove the search input from the archived docs
+
+- [ ] Search for `site-search-input` in the compressed Javascript files (should find the file in the `_next` directory). When you find it, use something like https://beautifier.io/ or VSCode to reformat it to be readable. To reformat using VSCode, use the "Format document" option or <kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>F</kbd>. Find `site-search-input` in the file, the result will be enclosed in a function that looks something like... `(0,f.jsx)("input",{"data-testid":"site-search-input",` Delete the entire function. For example, this:
   ```
-  $ script/enterprise-server-deprecations/archive-version.js -p ../help-docs-archived-enterprise-versions
+  (0, f.jsxs)("label", {
+    className: "text-normal width-full",
+    children: [(0, f.jsx)("span", {
+      className: "visually-hidden",
+      "aria-label": R($ || ($ = (0, k.Z)(["label"]))),
+      "aria-describedby": R(W || (W = (0, k.Z)(["description"]))),
+      children: R(U || (U = (0, k.Z)(["placeholder"])))
+  }), (0, f.jsx)("input", {
+      "data-testid": "site-search-input",
+      ref: I,
+      className: h()(pe().searchInput, 24 === p && pe().searchIconBackground24, 24 === p && "form-control px-6 f4", 16 === p && pe().searchIconBackground16, 16 === p && "form-control px-5 f4", "compact" === i && "py-2", "expanded" === i && "py-3", r && pe().searchInputHeader, !r && "width-full", r && j && pe().searchInputExpanded, r && j && "position-absolute top-0 right-0"),
+      type: "search",
+      placeholder: R(G || (G = (0, k.Z)(["placeholder"]))),
+      autoComplete: _ ? "on" : "off",
+      autoCorrect: "off",
+      autoCapitalize: "off",
+      spellCheck: "false",
+      maxLength: 512,
+      onChange: function(e) {
+          S(e.target.value)
+      },
+      value: _,
+      "aria-label": R(K || (K = (0, k.Z)(["label"]))),
+      "aria-describedby": R(J || (J = (0, k.Z)(["description"])))
+    })
   ```
-  **Note:** You can pass the `--dry-run` flag to scrape only the first 10 pages plus their redirects for testing purposes. **If you use the dry run command, be sure to run the full script without `--dry-run` before you commit the changes.**
 
-## Step 2: Upload the assets directory to Azure storage
+  becomes:
+
+  ```
+  (0, f.jsxs)('label', {
+    className: 'text-normal width-full',
+    children: [
+      (0, f.jsx)('span', {
+        className: 'visually-hidden',
+        'aria-label': y(Q || (Q = (0, k.Z)(['label']))),
+        'aria-describedby': y(X || (X = (0, k.Z)(['description']))),
+        children: y(ee || (ee = (0, k.Z)(['placeholder']))),
+      }),
+    ],
+  }),
+  ```
+- [ ] Save the file. If using beautifier, copy and paste the updated file back into your temp directory with the scraped archive content.
+
+## Step 2: Upload the scraped content directory to Azure storage
 
 - [ ] Log in to the Azure portal from Okta. Navigate to the [githubdocs Azure Storage Blob resource](https://portal.azure.com/#@githubazure.onmicrosoft.com/resource/subscriptions/fa6134a7-f27e-4972-8e9f-0cedffa328f1/resourceGroups/docs-production/providers/Microsoft.Storage/storageAccounts/githubdocs/overview).
 - [ ] Click the "Open in Explorer" button to the right of search box. If you haven't already, click the download link to download "Microsoft Azure Storage Explorer." To login to the app, click the plug icon in the left sidebar and click the option to "add an azure account." When you login, you'll need a yubikey to authenticate through Okta.
-- [ ] From the Microsoft Azure Storage Explorer app, select the `githubdocs` storage account resource and navigate to the `github-images` blob container.
-- [ ] Click "Upload" and select "Upload folder." Click the "Selected folder" input to navigate to the `help-docs-archived-enterprise-versions` repository and select the `assets` directory for the version you just generated. In the "Destination directory" input, add the version number. For example, `/enterprise/2.22/`.
+- [ ] From the Microsoft Azure Storage Explorer app, select the `githubdocs` storage account resource and navigate to the `enterprise` blob container.
+- [ ] Click "Upload" and select "Upload folder." Click the "Selected folder" input to navigate to the temp directory you just generated. Inside that temp directory, select the `<VERSION_TO_DEPRECATE>` directory (e.g., `3.2`). Leave the destination directory input blank.
 - [ ] Check the log to ensure all files were uploaded successfully.
-- [ ] Remove the `assets` directory from your `help-docs-archived-enterprise-versions` repository, we don't want to commit that directory in the next step.
-
-## Step 3: Commit and push changes to help-docs-archived-enterprise-versions repo
-
-- [ ] Search for `site-search-input` in the compressed Javascript files (should find the file in the `_next` directory). When you find it, use something like https://beautifier.io/ or VSCode to reformat it to be readable. To reformat using VSCode, use the "Format document" option or <kbd>Shift</kbd>+<kbd>Option</kbd>+<kbd>F</kbd>. Find `site-search-input` in the file, the result will be enclosed in a function that looks something like... `1125: function () { ... },` Delete the innards of this function, but leave the `function() {}` part.
-- [ ] Save the file. If using beautifier, copy and paste the updated file back into your local `help-docs-archived-enterprise-versions` repository.
-- [ ] In your archival checkout, `git add <version>`, commit, and push.
-- [ ] Open a PR and merge it in. Note that the version will _not_ be deprecated on the docs site until you do the next step.
+- [ ] Remove the temporarily created directory from your `github/docs-internal` checkout.
 
 ## Step 4: Deprecate the version in docs-internal
 
@@ -71,22 +109,13 @@ In your `docs-internal` checkout:
 You can test that the static pages were generated correctly on localhost and on staging. Verify that the static pages are accessible by running `npm run dev` in your local `docs-internal` checkout and navigate to:
 `http://localhost:3000/enterprise/<version>/`.
 
-Note: the GitHub Pages deployment from the previous step will need to have completed successfully in order for you to test this. You may need to wait up to 10 minutes for this to occur.
-
 Poke around several pages, ensure that the stylesheets are working properly, images are rendering properly, and that the search functionality was disabled.
 
-## Step 5: Continue to deprecate the version in docs-internal
-
-- [ ] Open a new PR. Make sure to check the following:
-  - [ ] Tests are passing (you may need to include the changes in step 6 to get tests to pass).
-  - [ ] The deprecated version renders in preview as expected. You should be able to navigate to `docs.github.com/enterprise/<DEPRECATED VERSION>` to access the docs. You should also be able to navigate to a page that is available in the deprecated version and change the version in the URL to the deprecated version, to test redirects.
-  - [ ] The new oldest supported version renders on staging as expected. You should see a banner on the top of every page for the oldest supported version that notes when the version will be deprecated.
-
 ## Step 5: Remove static files for the version
 
 - [ ] In your `docs-internal` checkout, create a new branch `remove-<version>-static-files` branch: `git checkout -b remove-<version>-static-files` (you can branch off of `main` or from your `deprecate-<version>` branch, up to you).
 - [ ] Run `script/enterprise-server-deprecations/remove-static-files.js` and commit results.
-- [ ] Run `script/enterprise-server-deprecations/remove-redirects.js` and commit results.
+- [ ] Re-generate the static files by running `script/rest/update-files.js --decorate-only`.
 - [ ] Open a new PR.
 - [ ] Get a review from docs-engineering and merge. This step can be merged independently from step 6. The purpose of splitting up steps 5 and 6 is to focus the review on specific files.
 
@@ -107,3 +136,10 @@ Poke around several pages, ensure that the stylesheets are working properly, ima
 - [ ] When the PR is approved, [deploy the `github/github` PR](https://thehub.github.com/epd/engineering/devops/deployment/deploying-dotcom/). If you haven't deployed a `github/github` PR before, work with someone that has -- the process isn't too involved depending on how you deploy, but there are a lot of details that can potentially be confusing as you can see from the documentation.
 
 **Note**: you can do this step independently of the other steps after a GHES version is deprecated since it should no longer get updates in github/github. You should plan to get this PR merged as soon as possible, otherwise if you wait too long our OpenAPI automation may re-add the static files that you removed in step 5.
+
+## Step 5: Continue to deprecate the version in docs-internal
+
+- [ ] Open a new PR. Make sure to check the following:
+  - [ ] Tests are passing (you may need to include the changes in step 6 to get tests to pass).
+  - [ ] The deprecated version renders in preview as expected. You should be able to navigate to `docs.github.com/enterprise/<DEPRECATED VERSION>` to access the docs. You should also be able to navigate to a page that is available in the deprecated version and change the version in the URL to the deprecated version, to test redirects.
+  - [ ] The new oldest supported version renders on staging as expected. You should see a banner on the top of every page for the oldest supported version that notes when the version will be deprecated.
diff --git a/...ub/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md b/...ub/viewing-and-triaging-notifications/managing-notifications-from-your-inbox.md
@@ -161,7 +161,7 @@ For example, to see notifications from the octo-org organization, use `org:octo-
 
 ## {% data variables.product.prodname_dependabot %} custom filters
 
-{% ifversion fpt or ghec or ghes > 3.2 %}
+{% ifversion fpt or ghec or ghes %}
 If you use {% data variables.product.prodname_dependabot %} to keep your dependencies up-to-date, you can use and save these custom filters:
 - `is:repository_vulnerability_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %}.
 - `reason:security_alert` to show notifications for {% data variables.product.prodname_dependabot_alerts %} and security update pull requests.
@@ -170,7 +170,7 @@ If you use {% data variables.product.prodname_dependabot %} to keep your depende
 For more information about {% data variables.product.prodname_dependabot %}, see "[About {% data variables.product.prodname_dependabot_alerts %}](/code-security/supply-chain-security/about-alerts-for-vulnerable-dependencies)."
 {% endif %}
 
-{% ifversion ghes < 3.3 or ghae %}
+{% ifversion ghae %}
 
 If you use {% data variables.product.prodname_dependabot %} to tell you about insecure dependencies, you can use and save these custom filters to show notifications for {% data variables.product.prodname_dependabot_alerts %}:
 - `is:repository_vulnerability_alert` 

diff --git a/...our-github-profile/customizing-your-profile/about-your-organizations-profile.md b/...our-github-profile/customizing-your-profile/about-your-organizations-profile.md
@@ -24,7 +24,7 @@ Organizations that use {% data variables.product.prodname_ghe_cloud %} can confi
 To confirm your organization's identity and display a "Verified" badge on your organization profile page, you can verify your organization's domains with {% data variables.product.prodname_dotcom %}. For more information, see "[Verifying or approving a domain for your organization](/organizations/managing-organization-settings/verifying-or-approving-a-domain-for-your-organization)."
 {% endif %}
 
-{% ifversion fpt or ghes > 3.2 or ghec %}
+{% ifversion fpt or ghes or ghec %}
 ![Sample organization profile page](/assets/images/help/organizations/org_profile_with_overview.png)
 {% else %}
 ![Sample organization profile page](/assets/images/help/profile/org_profile.png)

diff --git a/...nt-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md b/...nt-and-profile/setting-up-and-managing-your-personal-account-on-github/index.md
@@ -1,6 +1,6 @@
 ---
 title: Setting up and managing your personal account on GitHub
-intro: You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.location.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself.
+intro: 'You can manage settings for your personal account on {% ifversion fpt or ghec or ghes %}{% data variables.location.product_location %}{% elsif ghae %}{% data variables.product.product_name %}{% endif %}, including email preferences, access to personal repositories, and organization memberships. You can also manage the account itself.'
 shortTitle: Personal accounts
 redirect_from:
   - /categories/setting-up-and-managing-your-github-user-account

diff --git a/...on-github/managing-personal-account-settings/managing-accessibility-settings.md b/...on-github/managing-personal-account-settings/managing-accessibility-settings.md
@@ -1,7 +1,7 @@
 ---
 title: Managing accessibility settings
 shortTitle: Manage accessibility settings
-intro: "{% data variables.product.product_name %}'s user interface can adapt to your vision, hearing, motor, cognitive, or learning needs."
+intro: '{% data variables.product.product_name %}''s user interface can adapt to your vision, hearing, motor, cognitive, or learning needs.'
 versions:
   feature: keyboard-shortcut-accessibility-setting
 redirect_from:

diff --git a/...t-settings/managing-security-and-analysis-settings-for-your-personal-account.md b/...t-settings/managing-security-and-analysis-settings-for-your-personal-account.md
@@ -4,7 +4,7 @@ intro: 'You can control features that secure and analyze the code in your projec
 versions:
   fpt: '*'
   ghec: '*'
-  ghes: '>3.2'
+  ghes: '*'
 topics:
   - Accounts
 redirect_from:
@@ -32,11 +32,11 @@ For an overview of repository-level security, see "[Securing your repository](/c
 {% data reusables.user-settings.access_settings %}
 {% data reusables.user-settings.security-analysis %}
 3. Under "Code security and analysis", to the right of the feature, click **Disable all** or **Enable all**.
-  {% ifversion ghes > 3.2 %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/3.3/settings/security-and-analysis-disable-or-enable-all.png){% else %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/settings/security-and-analysis-disable-or-enable-all.png){% endif %}
+  {% ifversion ghes %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/3.3/settings/security-and-analysis-disable-or-enable-all.png){% else %}!["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/settings/security-and-analysis-disable-or-enable-all.png){% endif %}
 6. Optionally, enable the feature by default for new repositories that you own.
-  {% ifversion ghes > 3.2 %}!["Enable by default" option for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-by-default-in-modal.png){% else %}!["Enable by default" option for new repositories](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png){% endif %}
+  {% ifversion ghes %}!["Enable by default" option for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-by-default-in-modal.png){% else %}!["Enable by default" option for new repositories](/assets/images/help/settings/security-and-analysis-enable-by-default-in-modal.png){% endif %}
 7. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories you own.
-  {% ifversion ghes > 3.2 %}![Button to disable or enable feature](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-dependency-graph.png){% else %}![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png){% endif %}
+  {% ifversion ghes %}![Button to disable or enable feature](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-dependency-graph.png){% else %}![Button to disable or enable feature](/assets/images/help/settings/security-and-analysis-enable-dependency-graph.png){% endif %}
 
 {% data reusables.security.displayed-information %}
 
@@ -45,7 +45,7 @@ For an overview of repository-level security, see "[Securing your repository](/c
 {% data reusables.user-settings.access_settings %}
 {% data reusables.user-settings.security-analysis %}
 3. Under "Code security and analysis", to the right of the feature, enable or disable the feature by default for new repositories that you own.
-  {% ifversion ghes > 3.2 %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% else %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% endif %}
+  {% ifversion ghes %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/3.3/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% else %}![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/settings/security-and-analysis-enable-or-disable-feature-checkbox.png){% endif %}
 
 ## Further reading
 

diff --git a/...ings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md b/...ings/managing-your-cookie-preferences-for-githubs-enterprise-marketing-pages.md
@@ -1,6 +1,6 @@
 ---
 title: Managing your cookie preferences for GitHub's enterprise marketing pages
-intro: "You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages."
+intro: 'You can control how {% data variables.product.company_short %} uses information from non-essential tracking cookies for enterprise marketing pages.'
 versions:
   fpt: '*'
   ghes: '*'