diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b5f0ccbfe..2fa7a86b9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -25,11 +25,3 @@ Thanks again! - [ ] I have reviewed my changes in staging. (look for the **deploy-to-heroku** link in your pull request, then click **View deployment**) - [ ] For content changes, I have reviewed the [localization checklist](https://github.com/github/docs/blob/main/contributing/localization-checklist.md) - [ ] For content changes, I have reviewed the [Content style guide for GitHub Docs](https://github.com/github/docs/blob/main/contributing/content-style-guide.md). - -### Writer impact (This section is for GitHub staff members only): - -- [ ] This pull request impacts the contribution experience - - [ ] I have added the 'writer impact' label - - [ ] I have added a description and/or a video demo of the changes below (eg. a "before and after video") - - diff --git a/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png b/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png deleted file mode 100644 index c142169c7..000000000 Binary files a/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png and /dev/null differ diff --git a/assets/images/help/repository/repo-transfer-complete.png b/assets/images/help/repository/repo-transfer-complete.png index 1224f6a1f..c33bd0a9a 100644 Binary files a/assets/images/help/repository/repo-transfer-complete.png and b/assets/images/help/repository/repo-transfer-complete.png differ diff --git a/assets/images/help/repository/repo-transfer-free-plan-warnings.png b/assets/images/help/repository/repo-transfer-free-plan-warnings.png index 59bc8de07..773476309 100644 Binary files a/assets/images/help/repository/repo-transfer-free-plan-warnings.png and b/assets/images/help/repository/repo-transfer-free-plan-warnings.png differ diff --git a/content/actions/guides/about-continuous-integration.md b/content/actions/guides/about-continuous-integration.md index afc06b4bd..d23c1fc13 100644 --- a/content/actions/guides/about-continuous-integration.md +++ b/content/actions/guides/about-continuous-integration.md @@ -1,5 +1,5 @@ --- -title: About continuous integration +title: About continuous integration and continuous deployment intro: 'You can create custom continuous integration (CI) and continuous deployment (CD) workflows directly in your {% data variables.product.prodname_dotcom %} repository with {% data variables.product.prodname_actions %}.' product: '{% data reusables.gated-features.actions %}' redirect_from: diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 8bc46e0ba..e045f5742 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -53,7 +53,7 @@ When creating a group, you must choose a policy that defines which repositories **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." @@ -85,7 +85,7 @@ When creating a group, you must choose a policy that defines which organizations **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." diff --git a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md index f32c25533..cbb113098 100644 --- a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md @@ -443,9 +443,7 @@ jobs: path: vendor/bundle key: administrate-${{ matrix.image }}-${{ hashFiles('Gemfile.lock') }} - name: Install postgres headers - run: | - sudo apt-get update - sudo apt-get install libpq-dev + run: sudo apt-get install libpq-dev - name: Install dependencies run: bundle install --path vendor/bundle - name: Setup environment configuration diff --git a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md b/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md deleted file mode 100644 index a41d459b5..000000000 --- a/content/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Approving workflow runs from public forks -intro: 'When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve any workflow runs.' -product: '{% data reusables.gated-features.actions %}' -versions: - free-pro-team: '*' ---- - -Forks of public repositories can submit pull requests that propose changes to a repository's {% data variables.product.prodname_actions %} workflows. Although workflows from forks do not have access to sensitive data such as secrets, they can be an annoyance for maintainers if they are modified for abusive purposes. To help prevent this, workflows on pull requests are not run automatically if they are received from first-time contributors, and must be approved first. - -Maintainers with write access to the repository can use the following procedure to review and run workflows on pull requests from first-time contributors. After a contributor has at least one pull request merged into a project's repository, any future pull requests from that contributor's fork will automatically run workflows. - -{% data reusables.repositories.sidebar-pr %} -{% data reusables.repositories.choose-pr-review %} -{% data reusables.repositories.changed-files %} -1. Inspect the proposed changes in the pull request and ensure that you are comfortable running your workflows on the pull request branch. You should be especially alert to any proposed changes in the `.github/workflows/` directory that affect workflow files. -1. If you are comfortable with running workflows on the pull request branch, return to the {% octicon "comment-discussion" aria-label="The discussion icon" %} **Conversation** tab, and under "Workflow(s) awaiting approval", click **Approve and run**. - - ![Approve and run workflows](/assets/images/help/pull_requests/actions-approve-and-run-workflows-from-fork.png) diff --git a/content/actions/managing-workflow-runs/index.md b/content/actions/managing-workflow-runs/index.md index 2e9d58119..2606df2f9 100644 --- a/content/actions/managing-workflow-runs/index.md +++ b/content/actions/managing-workflow-runs/index.md @@ -26,7 +26,6 @@ versions: {% link_in_list /manually-running-a-workflow %} {% link_in_list /re-running-a-workflow %} {% link_in_list /canceling-a-workflow %} -{% link_in_list /approving-workflow-runs-from-public-forks %} {% link_in_list /reviewing-deployments %} {% link_in_list /disabling-and-enabling-a-workflow %} {% link_in_list /deleting-a-workflow-run %} diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 6fa26dc64..ab5a7c8b9 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -110,8 +110,8 @@ The following workflow will run on pushes to `releases/10` or `releases/beta/mon on: push: branches: - - 'releases/**' - - '!releases/**-alpha' + - 'releases/**' + - '!releases/**-alpha' ``` ### `on..paths` @@ -128,7 +128,7 @@ When all the path names match patterns in `paths-ignore`, the workflow will not on: push: paths-ignore: - - 'docs/**' + - 'docs/**' ``` #### Example including paths @@ -139,7 +139,7 @@ If at least one path matches a pattern in the `paths` filter, the workflow runs. on: push: paths: - - '**.js' + - '**.js' ``` #### Excluding paths @@ -160,8 +160,8 @@ This example runs anytime the `push` event includes a file in the `sub-project` on: push: paths: - - 'sub-project/**' - - '!sub-project/docs/**' + - 'sub-project/**' + - '!sub-project/docs/**' ``` #### Git diff comparisons @@ -478,15 +478,15 @@ jobs: output1: ${{ steps.step1.outputs.test }} output2: ${{ steps.step2.outputs.test }} steps: - - id: step1 - run: echo "::set-output name=test::hello" - - id: step2 - run: echo "::set-output name=test::world" + - id: step1 + run: echo "::set-output name=test::hello" + - id: step2 + run: echo "::set-output name=test::world" job2: runs-on: ubuntu-latest needs: job1 steps: - - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}} + - run: echo ${{needs.job1.outputs.output1}} ${{needs.job1.outputs.output2}} ``` {% endraw %} @@ -556,14 +556,14 @@ jobs: name: My Job runs-on: ubuntu-latest steps: - - name: Print a greeting - env: - MY_VAR: Hi there! My name is - FIRST_NAME: Mona - MIDDLE_NAME: The - LAST_NAME: Octocat - run: | - echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME. + - name: Print a greeting + env: + MY_VAR: Hi there! My name is + FIRST_NAME: Mona + MIDDLE_NAME: The + LAST_NAME: Octocat + run: | + echo $MY_VAR $FIRST_NAME $MIDDLE_NAME $LAST_NAME. ``` {% endraw %} diff --git a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 6eb8734b5..e31cad845 100644 --- a/content/actions/using-github-hosted-runners/about-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -93,10 +93,6 @@ We recommend using actions to interact with the software installed on runners. T If there is a tool that you'd like to request, please open an issue at [actions/virtual-environments](https://github.com/actions/virtual-environments). This repository also contains announcements about all major software updates on runners. -#### Installing additional software - -You can install additional software on {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Customizing GitHub-hosted runners](/actions/using-github-hosted-runners/customizing-github-hosted-runners)". - ### IP addresses {% note %} diff --git a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md b/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md deleted file mode 100644 index 789f759f8..000000000 --- a/content/actions/using-github-hosted-runners/customizing-github-hosted-runners.md +++ /dev/null @@ -1,92 +0,0 @@ ---- -title: Customizing GitHub-hosted runners -intro: >- - You can install additional software on GitHub-hosted runners as a - part of your workflow. -product: '{% data reusables.gated-features.actions %}' -versions: - free-pro-team: '*' - enterprise-server: '>=2.22' -type: tutorial -topics: - - Workflows ---- - -{% data reusables.actions.enterprise-github-hosted-runners %} - -If you require additional software packages on {% data variables.product.prodname_dotcom %}-hosted runners, you can create a job that installs the packages as part of your workflow. - -To see which packages are already installed by default, see "[Preinstalled software](/actions/using-github-hosted-runners/about-github-hosted-runners#preinstalled-software)." - -This guide demonstrates how to create a job that installs additional software on a {% data variables.product.prodname_dotcom %}-hosted runner. - -### Installing software on Ubuntu runners - -The following example demonstrates how to install an `apt` package as part of a job. - -{% raw %} -```yaml -name: Build on Ubuntu -on: push - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Check out repository code - uses: actions/checkout@v2 - - name: Install jq tool - run: | - sudo apt-get update - sudo apt-get install jq -``` -{% endraw %} - -{% note %} - -**Note:** Always run `sudo apt-get update` before installing a package. In case the `apt` index is stale, this command fetches and re-indexes any available packages, which helps prevent package installation failures. - -{% endnote %} - -### Installing software on macOS runners - -The following example demonstrates how to install Brew packages and casks as part of a job. - -{% raw %} -```yaml -name: Build on macOS -on: push - -jobs: - build: - runs-on: macos-latest - steps: - - name: Check out repository code - uses: actions/checkout@v2 - - name: Install GitHub CLI - run: | - brew update - brew install gh - - name: Install Microsoft Edge - run: | - brew update - brew install --cask microsoft-edge -``` -{% endraw %} - -### Installing software on Windows runners - -The following example demonstrates how to use [Chocolatey](https://community.chocolatey.org/packages) to install the {% data variables.product.prodname_dotcom %} CLI as part of a job. - -{% raw %} -```yaml -name: Build on Windows -on: push -jobs: - build: - runs-on: windows-latest - steps: - - run: choco install gh - - run: gh version -``` -{% endraw %} diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md index fb91ee9e6..681269a25 100644 --- a/content/actions/using-github-hosted-runners/index.md +++ b/content/actions/using-github-hosted-runners/index.md @@ -11,7 +11,6 @@ versions: {% data reusables.actions.enterprise-github-hosted-runners %} {% link_in_list /about-github-hosted-runners %} -{% link_in_list /customizing-github-hosted-runners %} {% link_in_list /about-ae-hosted-runners %} {% link_in_list /adding-ae-hosted-runners %} {% link_in_list /using-ae-hosted-runners-in-a-workflow %} diff --git a/content/admin/enterprise-management/upgrading-github-enterprise-server.md b/content/admin/enterprise-management/upgrading-github-enterprise-server.md index 8ca6149d9..a839c0341 100644 --- a/content/admin/enterprise-management/upgrading-github-enterprise-server.md +++ b/content/admin/enterprise-management/upgrading-github-enterprise-server.md @@ -89,12 +89,7 @@ There are two types of snapshots: {% note %} -**{% if currentVersion ver_gt "enterprise-server@2.22" %}Notes{% else %}Note{% endif %}**: - -{% if currentVersion ver_gt "enterprise-server@2.22" %} -- If {% data variables.product.product_location %} is running a release candidate build, you can't upgrade with a hotpatch. - -- {% endif %}Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." +**Note**: Installing a hotpatch using the {% data variables.enterprise.management_console %} is not available in clustered environments. To install a hotpatch in a clustered environment, see "[Upgrading a cluster](/enterprise/{{ currentVersion }}/admin/clustering/upgrading-a-cluster#upgrading-with-a-hotpatch)." {% endnote %} diff --git a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md index 67d7a3b1b..f545d4949 100644 --- a/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-amazon-s3-storage.md @@ -14,7 +14,7 @@ topics: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: -* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +* Create your Amazon S3 bucket for storing artifacts generated by workflow runs. {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} {% data reusables.actions.enterprise-common-prereqs %} diff --git a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md index df78fb814..ba2c6c47a 100644 --- a/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md +++ b/content/admin/github-actions/enabling-github-actions-with-minio-gateway-for-nas-storage.md @@ -15,7 +15,7 @@ topics: Before enabling {% data variables.product.prodname_actions %}, make sure you have completed the following steps: * To avoid resource contention on the appliance, we recommend that MinIO be hosted separately from {% data variables.product.product_location %}. -* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference reusables.actions.enterprise-s3-permission spaces=2 %} +* Create your bucket for storing workflow artifacts. To set up your bucket and access key, see the [MinIO documentation](https://docs.min.io/docs/minio-gateway-for-nas.html). {% indented_data_reference site.data.reusables.actions.enterprise-s3-permission spaces=2 %} {% data reusables.actions.enterprise-common-prereqs %} diff --git a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md index 704a7e097..ad09801a4 100644 --- a/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md +++ b/content/admin/github-actions/using-the-latest-version-of-the-official-bundled-actions.md @@ -26,19 +26,12 @@ You can use {% data variables.product.prodname_github_connect %} to allow {% dat Once {% data variables.product.prodname_github_connect %} is configured, you can use the latest version of an action by deleting its local repository in the `actions` organization on your instance. For example, if your enterprise instance is using the `actions/checkout@v1` action, and you need to use `actions/checkout@v2` which isn't available on your enterprise instance, perform the following steps to be able to use the latest `checkout` action from {% data variables.product.prodname_dotcom_the_website %}: -1. By default, site administrators are not owners of the bundled actions organization. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example: +1. To get the required access to delete the `checkout` repository, use the `ghe-org-admin-promote` command to promote a user to be an owner of the bundled `actions` organization. For more information, see "[Accessing the administrative shell (SSH)](/admin/configuration/accessing-the-administrative-shell-ssh)" and "[`ghe-org-admin-promote`](/admin/configuration/command-line-utilities#ghe-org-admin-promote)." For example: ```shell - $ ghe-org-admin-promote -u octocat -o actions - Do you want to give organization admin privileges for actions to octocat? (y/N) y - Making octocat an admin of actions - --> Adding octocat as an admin of actions - --> octocat is now an admin of the actions organization - --> Done. + ghe-org-admin-promote -u USERNAME -o actions ``` 1. On your {% data variables.product.product_name %} instance, delete the `checkout` repository within the `actions` organization. For information on how to delete a repository, see "[Deleting a repository ](/github/administering-a-repository/deleting-a-repository)." -1. It is recommended that you leave the `actions` organization once you no longer require administrative access. For more information, see "[Removing yourself from an organization -](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-an-organization)." 1. Configure your workflow's YAML to use `actions/checkout@v2`. 1. Each time your workflow runs, the runner will use the `v2` version of `actions/checkout` from {% data variables.product.prodname_dotcom_the_website %}. diff --git a/content/admin/user-management/migrating-to-internal-repositories.md b/content/admin/user-management/migrating-to-internal-repositories.md index 24b7a43c7..c3abc3d40 100644 --- a/content/admin/user-management/migrating-to-internal-repositories.md +++ b/content/admin/user-management/migrating-to-internal-repositories.md @@ -34,12 +34,6 @@ If you don't have private mode enabled, the migration script will have no effect ### Running the migration 1. Connect to the administrative shell. For more information, see "[Accessing the administrative shell (SSH)](/enterprise/admin/installation/accessing-the-administrative-shell-ssh)." -{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} -2. Run the migration command. - ```shell - github-env bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log - ``` -{% else %} 2. Navigate to the `/data/github/current` directory. ```shell cd /data/github/current @@ -48,7 +42,6 @@ If you don't have private mode enabled, the migration script will have no effect ```shell sudo bin/safe-ruby lib/github/transitions/20191210220630_convert_public_ghes_repos_to_internal.rb --verbose -w | tee -a /tmp/convert_public_ghes_repos_to_internal.log ``` -{% endif %} Log output will appear in the terminal and `/tmp/convert_public_ghes_repos_to_internal.log`. diff --git a/content/code-security/supply-chain-security/index.md b/content/code-security/supply-chain-security/index.md index e5358daad..3204a8868 100644 --- a/content/code-security/supply-chain-security/index.md +++ b/content/code-security/supply-chain-security/index.md @@ -20,7 +20,6 @@ topics: {% link_in_list /exploring-the-dependencies-of-a-repository %} {% topic_link_in_list /keeping-your-dependencies-updated-automatically %} {% link_in_list /about-dependabot-version-updates %} - {% link_in_list /upgrading-from-dependabotcom-to-github-native-dependabot %} {% link_in_list /enabling-and-disabling-version-updates %} {% link_in_list /listing-dependencies-configured-for-version-updates %} {% link_in_list /managing-pull-requests-for-dependency-updates %} diff --git a/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md b/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md deleted file mode 100644 index d37315dfd..000000000 --- a/content/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: Upgrading from Dependabot.com to GitHub-native Dependabot -intro: 'You can upgrade to GitHub-native Dependabot by merging a pull request that will allow your dependencies to continue being updated.' -versions: - free-pro-team: '*' -topics: - - repositories ---- - -### About upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -Dependabot Preview has been built directly into {% data variables.product.prodname_dotcom %}, so you can use {% data variables.product.prodname_dependabot %} alongside all the other functionality in {% data variables.product.prodname_dotcom %} without having to install and use a separate application. By migrating to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, we can also focus on bringing lots of exciting new features to {% data variables.product.prodname_dependabot %}, including more [ecosystem updates](https://github.com/github/roadmap/issues/150), [improved notifications](https://github.com/github/roadmap/issues/133), and {% data variables.product.prodname_dependabot %} support for [{% data variables.product.prodname_ghe_server %}](https://github.com/github/roadmap/issues/86) and [{% data variables.product.prodname_ghe_managed %}](https://github.com/github/roadmap/issues/135). - -### Differences between Dependabot Preview and {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -While most of the Dependabot Preview features exist in {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, a few remain unavailable: -- **Live updates:** We hope to bring these back in the future. For now, you can run {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dependabot %} daily to catch new packages within one day of release. -- **PHP environment variable registries:** For now, you can use {% data variables.product.prodname_actions %} to fetch dependencies from these registries. -- **Auto-merge:** We always recommend verifying your dependencies before merging them; therefore, auto-merge will not be supported for the foreseeable future. For those of you who have vetted your dependencies, or are only using internal dependencies, we recommend adding third-party auto-merge apps, or setting up GitHub Actions to merge. - -In {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, you can configure all version updates using the configuration file. This file is similar to the Dependabot Preview configuration file with a few changes and improvements that will be automatically included in your upgrade pull request. For more information about the upgrade pull request, see "[Upgrading to GitHub-native Dependabot](/code-security/supply-chain-security/upgrading-from-dependabotcom-to-github-native-dependabot#upgrading-to-github-native-dependabot)". - -To see update logs for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} that were previously on the Dependabot.com dashboard: - - 1. Navigate to your repository’s **Insights** page. - 2. Click **Dependency graph** to the left. - 3. Click **{% data variables.product.prodname_dependabot %}**. - -For more information about version updates with {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}, see "[About Dependabot version updates](/code-security/supply-chain-security/about-dependabot-version-updates)." - -### Upgrading to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} - -Upgrading from Dependabot Preview to {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %} requires only one step: merge the *Upgrade to GitHub-native Dependabot* pull request in your repository. This pull request includes the updated configuration file needed for {% data variables.product.prodname_dotcom %}-native {% data variables.product.prodname_dependabot %}. - -If you have any questions or need help migrating, you can view or open issues in the [dependabot/dependabot-core](https://github.com/dependabot/dependabot-core/issues) repository. - diff --git a/content/communities/documenting-your-project-with-wikis/about-wikis.md b/content/communities/documenting-your-project-with-wikis/about-wikis.md index f814ef736..2fe6a489b 100644 --- a/content/communities/documenting-your-project-with-wikis/about-wikis.md +++ b/content/communities/documenting-your-project-with-wikis/about-wikis.md @@ -22,12 +22,6 @@ With wikis, you can write content just like everywhere else on {% data variables You can edit wikis directly on {% data variables.product.product_name %}, or you can edit wiki files locally. By default, only people with write access to your repository can make changes to wikis, although you can allow everyone on {% data variables.product.product_location %} to contribute to a wiki in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository. For more information, see "[Changing access permissions for wikis](/communities/documenting-your-project-with-wikis/changing-access-permissions-for-wikis)". -{% note %} - -**Note:** Search engines will not index the contents of wikis. To have your content indexed by search engines, you can use [{% data variables.product.prodname_pages %}](/pages) in a public repository. - -{% endnote %} - ### Further reading - "[Adding or editing wiki pages](/communities/documenting-your-project-with-wikis/adding-or-editing-wiki-pages)" diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning.md index 2f3c81857..d7d1e02bf 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning.md @@ -88,12 +88,6 @@ We strongly recommend you implement signature validation in your secret alert se You can retrieve the {% data variables.product.prodname_dotcom %} secret scanning public key from https://api.github.com/meta/public_keys/secret_scanning and validate the message using the `ECDSA-NIST-P256V1-SHA256` algorithm. -{% note %} - -**Note**: When you send a request to the public key endpoint above, you may hit rate limits. To avoid hitting rate limits, you can use a personal access token as suggested below, or use a conditional request. For more information, see "[Getting started with the REST API](/rest/guides/getting-started-with-the-rest-api#conditional-requests)." - -{% endnote %} - Assuming you receive the following message, the code snippets below demonstrate how you could perform signature validation. The code also assumes you've set an environment variable called `GITHUB_PRODUCTION_TOKEN` with a generated PAT (https://github.com/settings/tokens). The token does not need any permissions set. @@ -364,3 +358,4 @@ A few important points: **Note:** Our request timeout is set to be higher (that is, 30 seconds) for partners who provide data about false positives. If you require a timeout higher than 30 seconds, email us at secret-scanning@github.com. {% endnote %} + diff --git a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md index 7a1376f8f..23fb2d23e 100644 --- a/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md +++ b/content/github/authenticating-to-github/adding-a-new-ssh-key-to-your-github-account.md @@ -87,7 +87,6 @@ After adding a new SSH key to your {% data variables.product.product_name %} acc If your SSH public key file has a different name than the example code, modify the filename to match your current setup. When copying your key, don't add any newlines or whitespace. ```shell - $ sudo apt-get update $ sudo apt-get install xclip # Downloads and installs xclip. If you don't have `apt-get`, you might need to use another installer (like `yum`) diff --git a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md index d3b7eb7dc..3acbcec27 100644 --- a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md +++ b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md @@ -11,7 +11,7 @@ topics: {% tip %} -**{% data variables.product.prodname_ghe_server %} users**: Accessing {% data variables.product.prodname_ghe_server %} via SSH over the HTTPS port is currently not supported. +**GitHub Enterprise users**: Accessing GitHub Enterprise via SSH over the HTTPS port is currently not supported. {% endtip %} diff --git a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md index e3d517ddc..010c9aea6 100644 --- a/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md +++ b/content/github/managing-your-work-on-github/about-automation-for-issues-and-pull-requests-with-query-parameters.md @@ -21,7 +21,7 @@ Query parameters are optional parts of a URL you can customize to share a specif You must have the proper permissions for any action to use the equivalent query parameter. For example, you must have permission to add a label to an issue to use the `labels` query parameter. -If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a `404 Not Found` error page. If you create a URL that exceeds the server limit, the URL will return a `414 URI Too Long` error page. +If you create an invalid URL using query parameters, or if you don’t have the proper permissions, the URL will return a 404 error page. ### Supported query parameters diff --git a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md index 742b05dcd..197330a75 100644 --- a/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md +++ b/content/github/setting-up-and-managing-your-github-profile/personalizing-your-profile.md @@ -141,78 +141,69 @@ You can disable some of the badges for {% data variables.product.prodname_dotcom ### List of qualifying repositories for Mars 2020 Helicopter Contributor badge -If you authored any commit(s) present in the commit history for the listed tag of one or more of the repositories below, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The authored commit must be with a verified email address, associated with your account at the time {% data variables.product.prodname_dotcom %} determined the eligible contributions, in order to be attributed to you. Future changes to verified emails will not have an effect on the badge. We built the list based on information received from NASA's Jet Propulsion Laboratory. - -| {% data variables.product.prodname_dotcom %} Repository | Version | Tag | -|---|---|---| -| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | [v3.4](https://github.com/torvalds/linux/releases/tag/v3.4) | -| [python/cpython](https://github.com/python/cpython) | 3.9.2 | [v3.9.2](https://github.com/python/cpython/releases/tag/v3.9.2) | -| [boto/boto3](https://github.com/boto/boto3) | 1.17.17 | [1.17.17](https://github.com/boto/boto3/releases/tag/1.17.17) | -| [boto/botocore](https://github.com/boto/botocore) | 1.20.11 | [1.20.11](https://github.com/boto/botocore/releases/tag/1.20.11) | -| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 | [2020.12.05](https://github.com/certifi/python-certifi/releases/tag/2020.12.05) | -| [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 | [4.0.0](https://github.com/chardet/chardet/releases/tag/4.0.0) | -| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.10.0 | [v0.10.0](https://github.com/matplotlib/cycler/releases/tag/v0.10.0) | -| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 6.8.1 | [6.8.1](https://github.com/elastic/elasticsearch-py/releases/tag/6.8.1) | -| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 | [2.3.2](https://github.com/ianare/exif-py/releases/tag/2.3.2) | -| [kjd/idna](https://github.com/kjd/idna) | 2.10 | [v2.10](https://github.com/kjd/idna/releases/tag/v2.10) | -| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 0.10.0 | [0.10.0](https://github.com/jmespath/jmespath.py/releases/tag/0.10.0) | -| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 1.3.1 | [1.3.1](https://github.com/nucleic/kiwi/releases/tag/1.3.1) | -| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.3.4 | [v3.3.4](https://github.com/matplotlib/matplotlib/releases/tag/v3.3.4) | -| [numpy/numpy](https://github.com/numpy/numpy) | 1.20.1 | [v1.20.1](https://github.com/numpy/numpy/releases/tag/v1.20.1) | -| [opencv/opencv-python](https://github.com/opencv/opencv-python) | 4.5.1.48 | [48](https://github.com/opencv/opencv-python/releases/tag/48) | -| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 8.1.0 | [8.1.0](https://github.com/python-pillow/Pillow/releases/tag/8.1.0) | -| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 7.43.0.6 | [REL_7_43_0_6](https://github.com/pycurl/pycurl/releases/tag/REL_7_43_0_6) | -| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | [pyparsing_2.4.7](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.7) | -| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | [v3.5](https://github.com/pyserial/pyserial/releases/tag/v3.5) | -| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | [2.8.1](https://github.com/dateutil/dateutil/releases/tag/2.8.1) | -| [yaml/pyyaml ](https://github.com/yaml/pyyaml) | 5.4.1 | [5.4.1](https://github.com/yaml/pyyaml/releases/tag/5.4.1) | -| [psf/requests](https://github.com/psf/requests) | 2.25.1 | [v2.25.1](https://github.com/psf/requests/releases/tag/v2.25.1) | -| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 | [0.3.4](https://github.com/boto/s3transfer/releases/tag/0.3.4) | -| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 | [4.2.0](https://github.com/enthought/scimath/releases/tag/4.2.0) | -| [scipy/scipy](https://github.com/scipy/scipy) | 1.6.1 | [v1.6.1](https://github.com/scipy/scipy/releases/tag/v1.6.1) | -| [benjaminp/six](https://github.com/benjaminp/six) | 1.15.0 | [1.15.0](https://github.com/benjaminp/six/releases/tag/1.15.0) | -| [enthought/traits](https://github.com/enthought/traits) | 6.2.0 | [6.2.0](https://github.com/enthought/traits/releases/tag/6.2.0) | -| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 1.26.3 | [1.26.3](https://github.com/urllib3/urllib3/releases/tag/1.26.3) | -| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 19.3.0 | [19.3.0](https://github.com/python-attrs/attrs/releases/tag/19.3.0) | -| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 | [3.2.4](https://github.com/CheetahTemplate3/cheetah3/releases/tag/3.2.4) | -| [pallets/click](https://github.com/pallets/click) | 7.0 | [7.0](https://github.com/pallets/click/releases/tag/7.0) | -| [pallets/flask](https://github.com/pallets/flask) | 1.1.1 | [1.1.1](https://github.com/pallets/flask/releases/tag/1.1.1) | -| [flask-restful/flask-restful](https://github.com/flask-restful/flask-restful) | 0.3.7 | [0.3.7](https://github.com/flask-restful/flask-restful/releases/tag/0.3.7) | -| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.0.0 | [v1.0.0](https://github.com/pytest-dev/iniconfig/releases/tag/v1.0.0) | -| [pallets/itsdangerous](https://github.com/pallets/itsdangerous) | 1.1.0 | [1.1.0](https://github.com/pallets/itsdangerous/releases/tag/1.1.0) | -| [pallets/jinja](https://github.com/pallets/jinja) | 2.10.3 | [2.10.3](https://github.com/pallets/jinja/releases/tag/2.10.3) | -| [lxml/lxml](https://github.com/lxml/lxml) | 4.4.1 | [lxml-4.4.1](https://github.com/lxml/lxml/releases/tag/lxml-4.4.1) | -| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 3.1.1 | [3.1.1](https://github.com/Python-Markdown/markdown/releases/tag/3.1.1) | -| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 | [1.1.1](https://github.com/pallets/markupsafe/releases/tag/1.1.1) | -| [pypa/packaging](https://github.com/pypa/packaging) | 19.2 | [19.2](https://github.com/pypa/packaging/releases/tag/19.2) | -| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 4.7.0 | [4.7.0](https://github.com/pexpect/pexpect/releases/tag/4.7.0) | -| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 0.13.0 | [0.13.0](https://github.com/pytest-dev/pluggy/releases/tag/0.13.0) | -| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 0.6.0 | [0.6.0](https://github.com/pexpect/ptyprocess/releases/tag/0.6.0) | -| [pytest-dev/py](https://github.com/pytest-dev/py) | 1.8.0 | [1.8.0](https://github.com/pytest-dev/py/releases/tag/1.8.0) | -| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.5 | [pyparsing_2.4.5](https://github.com/pyparsing/pyparsing/releases/tag/pyparsing_2.4.5) | -| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 5.3.0 | [5.3.0](https://github.com/pytest-dev/pytest/releases/tag/5.3.0) | -| [stub42/pytz](https://github.com/stub42/pytz) | 2019.3 | [release_2019.3](https://github.com/stub42/pytz/releases/tag/release_2019.3) | -| [uiri/toml](https://github.com/uiri/toml) | 0.10.0 | [0.10.0](https://github.com/uiri/toml/releases/tag/0.10.0) | -| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 | [0.16.0](https://github.com/pallets/werkzeug/releases/tag/0.16.0) | -| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 | [v1.2](https://github.com/dmnfarrell/tkintertable/releases/tag/v1.2) | -| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 2.9.1.1 | [wxPy-2.9.1.1](https://github.com/wxWidgets/wxPython-Classic/releases/tag/wxPy-2.9.1.1) | -| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 | [NASA-v1.3](https://github.com/nasa/fprime/releases/tag/NASA-v1.3) | -| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | [1.1.0](https://github.com/nucleic/cppy/releases/tag/1.1.0) | -| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | [4.5.1](https://github.com/opencv/opencv/releases/tag/4.5.1) | -| [curl/curl](https://github.com/curl/curl) | 7.72.0 | [curl-7_72_0](https://github.com/curl/curl/releases/tag/curl-7_72_0) | -| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | [v1.2.11](https://github.com/madler/zlib/releases/tag/v1.2.11) | -| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 | [releases/lucene-solr/7.7.3](https://github.com/apache/lucene/releases/tag/releases%2Flucene-solr%2F7.7.3) | -| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | [0.2.5](https://github.com/yaml/libyaml/releases/tag/0.2.5) | -| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 | [v6.8.1](https://github.com/elastic/elasticsearch/releases/tag/v6.8.1) | -| [twbs/bootstrap](https://github.com/twbs/bootstrap) | 4.3.1 | [v4.3.1](https://github.com/twbs/bootstrap/releases/tag/v4.3.1) | -| [vuejs/vue](https://github.com/vuejs/vue) | 2.6.10 | [v2.6.10](https://github.com/vuejs/vue/releases/tag/v2.6.10) | -| [carrotsearch/hppc](https://github.com/carrotsearch/hppc) | 0.7.1 | [0.7.1](https://github.com/carrotsearch/hppc/releases/tag/0.7.1) | -| [JodaOrg/joda-time](https://github.com/JodaOrg/joda-time) | 2.10.1 | [v2.10.1](https://github.com/JodaOrg/joda-time/releases/tag/v2.10.1) | -| [tdunning/t-digest](https://github.com/tdunning/t-digest) | 3.2 | [t-digest-3.2](https://github.com/tdunning/t-digest/releases/tag/t-digest-3.2) | -| [HdrHistogram/HdrHistogram](https://github.com/HdrHistogram/HdrHistogram) | 2.1.9 | [HdrHistogram-2.1.9](https://github.com/HdrHistogram/HdrHistogram/releases/tag/HdrHistogram-2.1.9) | -| [locationtech/spatial4j](https://github.com/locationtech/spatial4j) | 0.7 | [spatial4j-0.7](https://github.com/locationtech/spatial4j/releases/tag/spatial4j-0.7) | -| [locationtech/jts](https://github.com/locationtech/jts) | 1.15.0 | [jts-1.15.0](https://github.com/locationtech/jts/releases/tag/jts-1.15.0) | -| [apache/log4j](https://github.com/apache/log4j) | 2.11 | [v1_2_11](https://github.com/apache/log4j/releases/tag/v1_2_11) | +If you authored any commit(s) on the default branch of one or more of the repositories below, up to the specified version, you'll receive the Mars 2020 Helicopter Contributor badge on your profile. The list was built based on the information received from NASA's Jet Propulsion Laboratory. + +| {% data variables.product.prodname_dotcom %} Repository | Version | +|---|---| +| [torvalds/linux](https://github.com/torvalds/linux) | 3.4 | +| [nasa/fprime](https://github.com/nasa/fprime) | 1.3 | +| [python/cpython](https://github.com/python/cpython) | 3.9.2 | +| [boto/boto3](https://github.com/boto/boto3) | 1.17.17 | +| [boto/botocore](https://github.com/boto/botocore) | 1.20.11 | +| [certifi/python-certifi](https://github.com/certifi/python-certifi) | 2020.12.5 | +| [chardet/chardet](https://github.com/chardet/chardet) | 4.0.0 | +| [matplotlib/cycler](https://github.com/matplotlib/cycler) | 0.10.0 | +| [elastic/elasticsearch-py](https://github.com/elastic/elasticsearch-py) | 6.8.1 | +| [ianare/exif-py](https://github.com/ianare/exif-py) | 2.3.2 | +| [kjd/idna](https://github.com/kjd/idna) | 2.10 | +| [jmespath/jmespath.py](https://github.com/jmespath/jmespath.py) | 0.10.0 | +| [nucleic/kiwi](https://github.com/nucleic/kiwi) | 1.3.1 | +| [matplotlib/matplotlib](https://github.com/matplotlib/matplotlib) | 3.3.4 | +| [numpy/numpy](https://github.com/numpy/numpy) | 1.20.1 | +| [opencv/opencv-python](https://github.com/opencv/opencv-python) | 4.5.1.48 | +| [python-pillow/Pillow](https://github.com/python-pillow/Pillow) | 8.1.0 | +| [pycurl/pycurl](https://github.com/pycurl/pycurl) | 7.43.0.6 | +| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.7 | +| [pyserial/pyserial](https://github.com/pyserial/pyserial) | 3.5 | +| [dateutil/dateutil](https://github.com/dateutil/dateutil) | 2.8.1 | +| [yaml/pyyaml](https://github.com/yaml/pyyaml) | 5.4.1 | +| [psf/requests](https://github.com/psf/requests) | 2.25.1 | +| [boto/s3transfer](https://github.com/boto/s3transfer) | 0.3.4 | +| [enthought/scimath](https://github.com/enthought/scimath) | 4.2.0 | +| [scipy/scipy](https://github.com/scipy/scipy) | 1.6.1 | +| [benjaminp/six](https://github.com/benjaminp/six) | 1.15.0 | +| [enthought/traits](https://github.com/enthought/traits) | 6.2.0 | +| [urllib3/urllib3](https://github.com/urllib3/urllib3) | 1.26.3 | +| [python-attrs/attrs](https://github.com/python-attrs/attrs) | 19.3.0 | +| [CheetahTemplate3/cheetah3](https://github.com/CheetahTemplate3/cheetah3/) | 3.2.4 | +| [pallets/click](https://github.com/pallets/click) | 7.0 | +| [pallets/flask](https://github.com/pallets/flask) | 1.1.1 | +| [flask-restful/flask-restful](https://github.com/flask-restful/flask-restful) | 0.3.7 | +| [pytest-dev/iniconfig](https://github.com/pytest-dev/iniconfig) | 1.0.0 | +| [pallets/itsdangerous](https://github.com/pallets/itsdangerous) | 1.1.0 | +| [pallets/jinja](https://github.com/pallets/jinja) | 2.10.3 | +| [lxml/lxml](https://github.com/lxml/lxml) | 4.4.1 | +| [Python-Markdown/markdown](https://github.com/Python-Markdown/markdown) | 3.1.1 | +| [pallets/markupsafe](https://github.com/pallets/markupsafe) | 1.1.1 | +| [pypa/packaging](https://github.com/pypa/packaging) | 19.2 | +| [pexpect/pexpect](https://github.com/pexpect/pexpect) | 4.7.0 | +| [pytest-dev/pluggy](https://github.com/pytest-dev/pluggy) | 0.13.0 | +| [pexpect/ptyprocess](https://github.com/pexpect/ptyprocess) | 0.6.0 | +| [pytest-dev/py](https://github.com/pytest-dev/py) | 1.8.0 | +| [pyparsing/pyparsing](https://github.com/pyparsing/pyparsing) | 2.4.5 | +| [pytest-dev/pytest](https://github.com/pytest-dev/pytest) | 5.3.0 | +| [stub42/pytz](https://github.com/stub42/pytz) | 2019.3 | +| [uiri/toml](https://github.com/uiri/toml) | 0.10.0 | +| [pallets/werkzeug](https://github.com/pallets/werkzeug) | 0.16.0 | +| [dmnfarrell/tkintertable](https://github.com/dmnfarrell/tkintertable) | 1.2 | +| [wxWidgets/wxPython-Classic](https://github.com/wxWidgets/wxPython-Classic) | 2.9.1.1 | +| [opencv/opencv](https://github.com/opencv/opencv) | 4.5.1 | +| [curl/curl](https://github.com/curl/curl) | 7.19.0 | +| [madler/zlib](https://github.com/madler/zlib) | 1.2.11 | +| [apache/lucene](https://github.com/apache/lucene) | 7.7.3 | +| [yaml/libyaml](https://github.com/yaml/libyaml) | 0.2.5 | +| [elastic/elasticsearch](https://github.com/elastic/elasticsearch) | 6.8.1 | +| [nucleic/cppy](https://github.com/nucleic/cppy) | 1.1.0 | ### Further reading diff --git a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md index e3fc2daf3..e2410b488 100644 --- a/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md +++ b/content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md @@ -47,7 +47,7 @@ To set up a `www` or custom subdomain, such as `www.example.com` or `blog.exampl ![Save custom domain button](/assets/images/help/pages/save-custom-subdomain.png) 5. Navigate to your DNS provider and create a `CNAME` record that points your subdomain to the default domain for your site. For example, if you want to use the subdomain `www.example.com` for your user site, create a `CNAME` record that points `www.example.com` to `.github.io`. If you want to use the subdomain `www.anotherexample.com` for your organization site, create a `CNAME` record that points `www.anotherexample.com` to `.github.io`. The `CNAME` record should always point to `.github.io` or `.github.io`, excluding the repository name. {% data reusables.pages.contact-dns-provider %} {% data reusables.pages.default-domain-information %} -{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} +{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _WWW.EXAMPLE.COM_ with your subdomain. ```shell @@ -81,7 +81,7 @@ To set up an apex domain, such as `example.com`, you must configure a _CNAME_ fi 185.199.111.153 ``` -{% indented_data_reference reusables.pages.wildcard-dns-warning spaces=3 %} +{% indented_data_reference site.data.reusables.pages.wildcard-dns-warning spaces=3 %} {% data reusables.command_line.open_the_multi_os_terminal %} 6. To confirm that your DNS record configured correctly, use the `dig` command, replacing _EXAMPLE.COM_ with your apex domain. Confirm that the results match the IP addresses for {% data variables.product.prodname_pages %} above. ```shell diff --git a/data/reusables/developer-site/pull_request_forked_repos_link.md b/data/reusables/developer-site/pull_request_forked_repos_link.md index 3d29c028b..54d745b49 100644 --- a/data/reusables/developer-site/pull_request_forked_repos_link.md +++ b/data/reusables/developer-site/pull_request_forked_repos_link.md @@ -10,10 +10,6 @@ When you create a pull request from a forked repository to the base repository, Workflows don't run on forked repositories by default. You must enable GitHub Actions in the **Actions** tab of the forked repository. -{% if currentVersion == "free-pro-team@latest"%} -When a first-time contributor submits a pull request to a public repository, a maintainer with write access must approve running workflows on the pull request. For more information, see "[Approving workflow runs from public forks](/actions/managing-workflow-runs/approving-workflow-runs-from-public-forks)." -{% endif %} - {% data reusables.actions.forked-secrets %} The permissions for the `GITHUB_TOKEN` in forked repositories is read-only. For more information, see "[Authenticating with the GITHUB_TOKEN](/actions/configuring-and-managing-workflows/authenticating-with-the-github_token)." {% note %} diff --git a/data/reusables/gated-features/auto-merge.md b/data/reusables/gated-features/auto-merge.md index 7ce0001db..4f05ac43b 100644 --- a/data/reusables/gated-features/auto-merge.md +++ b/data/reusables/gated-features/auto-merge.md @@ -1 +1 @@ -{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% if enterpriseServerVersions contains "enterprise-server@3.1" %}{% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}{% else %}and {% data variables.product.prodname_ghe_cloud %}{% endif %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} +{% if currentVersion == "github-ae@latest" %}Auto-merge for pull requests is available in internal and private repositories with {% data variables.product.prodname_ghe_managed %}, {% else %}Auto-merge for pull requests is available {% endif %} in public repositories with {% data variables.product.prodname_free_user %} and {% data variables.product.prodname_free_team %} for organizations, and in public and private repositories with {% data variables.product.prodname_pro %}, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, and {% data variables.product.prodname_ghe_server %}. {% if currentVersion == "free-pro-team@latest" %}{% data reusables.gated-features.more-info %}{% endif %} diff --git a/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md b/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md index 3839db944..3b2ba51fe 100644 --- a/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md +++ b/data/reusables/github-actions/self-hosted-runner-configure-runner-group-access.md @@ -6,7 +6,7 @@ **Warning** - {% indented_data_reference reusables.github-actions.self-hosted-runner-security spaces=3 %} + {% indented_data_reference site.data.reusables.github-actions.self-hosted-runner-security spaces=3 %} For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#self-hosted-runner-security-with-public-repositories)." diff --git a/data/reusables/repositories/actions-scheduled-workflow-example.md b/data/reusables/repositories/actions-scheduled-workflow-example.md index 3dae8f356..40d253284 100644 --- a/data/reusables/repositories/actions-scheduled-workflow-example.md +++ b/data/reusables/repositories/actions-scheduled-workflow-example.md @@ -6,6 +6,6 @@ This example triggers the workflow every day at 5:30 and 17:30 UTC: on: schedule: # * is a special character in YAML so you have to quote this string - - cron: '30 5,17 * * *' + - cron: '*/30 5,17 * * *' ``` diff --git a/data/reusables/secret-scanning/partner-secret-list-private-repo.md b/data/reusables/secret-scanning/partner-secret-list-private-repo.md index 030bdefa4..69cad3e66 100644 --- a/data/reusables/secret-scanning/partner-secret-list-private-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-private-repo.md @@ -32,7 +32,6 @@ Dropbox | Dropbox Short Lived Access Token | dropbox_short_lived_access_token Dynatrace | Dynatrace Access Token | dynatrace_access_token Dynatrace | Dynatrace Internal Token | dynatrace_internal_token Facebook | Facebook Access Token | facebook_access_token -Fastly | Fastly API Token | fastly_api_token Finicity | Finicity App Key | finicity_app_key Frame.io | Frame.io JSON Web Token | frameio_jwt Frame.io| Frame.io Developer Token | frameio_developer_token @@ -55,7 +54,6 @@ Mailchimp | Mailchimp API Key | mailchimp_api_key Mailgun | Mailgun API Key | mailgun_api_key npm | npm Access Token | npm_access_token NuGet | NuGet API Key | nuget_api_key -OpenAI | OpenAI API Key | openai_api_key Palantir | Palantir JSON Web Token | palantir_jwt Postman | Postman API Key | postman_api_key Proctorio | Proctorio Consumer Key | proctorio_consumer_key diff --git a/data/reusables/secret-scanning/partner-secret-list-public-repo.md b/data/reusables/secret-scanning/partner-secret-list-public-repo.md index a13fab600..a3926d6d7 100644 --- a/data/reusables/secret-scanning/partner-secret-list-public-repo.md +++ b/data/reusables/secret-scanning/partner-secret-list-public-repo.md @@ -47,7 +47,6 @@ Mailgun | Mailgun API Key MessageBird | MessageBird API Key npm | npm Access Token NuGet | NuGet API Key -OpenAI | OpenAI API Key Palantir | Palantir JSON Web Token Plivo | Plivo Auth Token Postman | Postman API Key diff --git a/feature-flags.json b/feature-flags.json index 5a0027370..64c69f19d 100644 --- a/feature-flags.json +++ b/feature-flags.json @@ -1,5 +1,4 @@ { "FEATURE_TEST_TRUE": true, - "FEATURE_TEST_FALSE": false, - "FEATURE_NEW_SITETREE": false + "FEATURE_TEST_FALSE": false } diff --git a/includes/article.html b/includes/article.html index d4b408324..ba58d0f82 100644 --- a/includes/article.html +++ b/includes/article.html @@ -68,14 +68,6 @@

diff --git a/includes/breadcrumbs.html b/includes/breadcrumbs.html index 57c6ab0ca..2a08fecb2 100644 --- a/includes/breadcrumbs.html +++ b/includes/breadcrumbs.html @@ -1,16 +1,3 @@ -{% if FEATURE_NEW_SITETREE %} - -{% else %} -{% endif %} diff --git a/includes/category-articles-list.html b/includes/category-articles-list.html deleted file mode 100644 index 27e2cdd7f..000000000 --- a/includes/category-articles-list.html +++ /dev/null @@ -1,34 +0,0 @@ -{% for categoryPage in currentProductTree.childPages %} -{% if categoryPage.href == currentPath %}{% assign currentCategory = categoryPage %}{% endif %} -{% endfor %} - -{% if currentCategory.page.shortTitle and currentCategory.page.shortTitle != '' %}{% assign currentCategoryTitle = currentCategory.page.shortTitle %}{% else %}{% assign currentCategoryTitle = currentCategory.page.title %}{% endif %} - -{% assign maxArticles = 10 %} - -
-

{{ currentCategoryTitle }} docs

- -
- {% for childPage in currentCategory.childPages %} - {% unless childPage.page.hidden %} -
-

{{ childPage.page.title }}

-
    - {% for grandchildPage in childPage.childPages %} -
  • - - {{ grandchildPage.page.title }} - -
    • - {% endfor %} - {% assign numArticles = childPage.childPages | obj_size %} - {% if numArticles > maxArticles %} - - {% endif %} -
-
- {% endunless %} - {% endfor %} -
-
diff --git a/includes/generic-toc-items.html b/includes/generic-toc-items.html deleted file mode 100644 index 0c2def85b..000000000 --- a/includes/generic-toc-items.html +++ /dev/null @@ -1,12 +0,0 @@ -{% if tocItems %} - -{% for tocItem in tocItems %} - -{% assign title = tocItem.title %} -{% assign fullPath = tocItem.fullPath %} -{% assign intro = tocItem.intro %} -{% include liquid-tags/link-with-intro %} - -{% endfor %} - -{% endif %} diff --git a/includes/generic-toc-list.html b/includes/generic-toc-list.html deleted file mode 100644 index 8cdd55c9c..000000000 --- a/includes/generic-toc-list.html +++ /dev/null @@ -1,24 +0,0 @@ -{% if tocItems %} -
    -{% for tocItem in tocItems %} - -{% assign title = tocItem.title %} -{% assign fullPath = tocItem.fullPath %} -{% assign intro = tocItem.intro %} - -
  • {% include liquid-tags/link %} - {% if tocItem.childTocItems %} - {% unless page.relativePath == "github/index.md" %} -
      - {% for childItem in tocItem.childTocItems %} - {% assign title = childItem.title %} - {% assign fullPath = childItem.fullPath %} -
    • {% include liquid-tags/link %}
      • - {% endfor %} -
    - {% endunless %} - {% endif %} -
    • -{% endfor %} -
-{% endif %} diff --git a/includes/header.html b/includes/header.html index d27e2802d..56f3709c5 100644 --- a/includes/header.html +++ b/includes/header.html @@ -22,7 +22,7 @@

{% data ui.homepage.explore_by_product %}

- +
@@ -35,7 +35,7 @@

{% data ui.h {% for product in activeProducts %} + {% if product.id == currentProduct %}color-text-link-mktg text-underline active{% elsif product.id == currentProduct.id %}color-text-link-mktg text-underline active{% else %}Link--primary no-underline{% endif %}"> {{ product.name }} {% if product.external %} diff --git a/includes/product-articles-list.html b/includes/product-articles-list.html deleted file mode 100644 index de0bec335..000000000 --- a/includes/product-articles-list.html +++ /dev/null @@ -1,46 +0,0 @@ -{% assign maxArticles = 10 %} - -{% if currentProductTree.page.shortTitle and currentProductTree.page.shortTitle != '' %}{% assign productTitle = currentProductTree.page.shortTitle %}{% else %}{% assign productTitle = currentProductTree.page.title %}{% endif %} - -
-

All {{ productTitle }} docs

- -
- {% for childPage in currentProductTree.childPages %} - {% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %} - {% unless standaloneCategory %} -
-

{{ childPage.page.title }}

- - {% if childPage.childPages and childPage.childPages[0].page.documentType == "mapTopic" %} -
    - {% for grandchildPage in childPage.childPages %} - {% unless grandchildPage.page.hidden %} - {% assign numArticles = childPage.childPages | obj_size %} -
  • - - {{ grandchildPage.page.title }} - -
    • - {% if numArticles > maxArticles %} - - {% endif %} - {% endunless %} - {% endfor %} -
- {% else %} -
    - {% assign numArticles = childPage.childPages | obj_size %} - {% for grandchildPage in childPage.childPages %} -
  • {{ grandchildPage.page.title }}
    • - {% endfor %} -
- {% if numArticles > maxArticles %} - - {% endif %} - {% endif %} -
- {% endunless %} - {% endfor %} -
-
diff --git a/includes/sidebar-product.html b/includes/sidebar-product.html deleted file mode 100644 index 5b5b6b78c..000000000 --- a/includes/sidebar-product.html +++ /dev/null @@ -1,74 +0,0 @@ - - -{% include all-products-link %} - -{% unless currentProductTree.page.hidden %} - -{% if currentProductTree.renderedShortTitle %}{% assign productTitle = currentProductTree.renderedShortTitle %}{% else %}{% assign productTitle = currentProductTree.renderedFullTitle %}{% endif %} - -
  • - {{ productTitle }} -
    • -
  • -
      - {% for childPage in currentProductTree.childPages %} - {% if childPage.page.documentType == "article" %}{% assign standaloneCategory = true %}{% else %}{% assign standaloneCategory = false %}{% endif %} -
    • - {% if childPage.renderedShortTitle %}{% assign childTitle = childPage.renderedShortTitle %}{% else %}{% assign childTitle = childPage.renderedFullTitle %}{% endif %} - {% if standaloneCategory %} - {{ childTitle }} - {% else %} -
      - -
      - {{ childTitle }} - {% if forloop.index < 4 %} - - {% endif %} -
      -       - {% endif %} - - {% if currentPath contains childPage.href or forloop.index < 4 %} - {% if childPage.childPages[0].page.documentType == "mapTopic" %} -
        - {% for grandchildPage in childPage.childPages %} - {% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %} -
      • - {{ grandchildTitle }} -
          - {% for greatgrandchildPage in grandchildPage.childPages %} - {% if greatgrandchildPage.renderedShortTitle %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedShortTitle %}{% else %}{% assign greatgrandchildTitle = greatgrandchildPage.renderedFullTitle %}{% endif %} -
        • - {{ greatgrandchildTitle }} -
          • - {% endfor %} -
        -
        • - {% endfor %} -
      - - {% elsif childPage.childPages[0].page.documentType == "article" %} -
        - {% for grandchildPage in childPage.childPages %} - {% if grandchildPage.renderedShortTitle %}{% assign grandchildTitle = grandchildPage.renderedShortTitle %}{% else %}{% assign grandchildTitle = grandchildPage.renderedFullTitle %}{% endif %} -
      • - {{ grandchildTitle }} -
        • - {% endfor %} -
      - {% endif %} - {% endif %} -
      -
      • - {% endfor %} -
    -
    • - -{% endunless %} diff --git a/includes/sidebar.html b/includes/sidebar.html index 470a26208..74f1c94cc 100644 --- a/includes/sidebar.html +++ b/includes/sidebar.html @@ -15,11 +15,7 @@ {% else %}
      - {% if FEATURE_NEW_SITETREE %} - {% include sidebar-product %} - {% else %} {% include sidebar-specific-product %} - {% endif %}
    {% endif %} diff --git a/layouts/product-landing.html b/layouts/product-landing.html index db2027814..618ec963e 100644 --- a/layouts/product-landing.html +++ b/layouts/product-landing.html @@ -150,22 +150,11 @@

    Guides

    {% endif %}
    - {% if FEATURE_NEW_SITETREE %} - {% if page.documentType == "category" %} - {% include category-articles-list %} - {% endif %} - {% if page.documentType == "product" %} - {% include product-articles-list %} - {% endif %} - {% endif %} - - {% unless FEATURE_NEW_SITETREE %} {% if currentCategory %} {% include all-articles-category %} {% else %} {% include all-articles-product %} {% endif %} - {% endunless %}
    {% include support-section %} diff --git a/lib/create-tree.js b/lib/create-tree.js index fe89e52eb..8649b8283 100644 --- a/lib/create-tree.js +++ b/lib/create-tree.js @@ -20,7 +20,7 @@ module.exports = async function createTree (originalPath, langObj) { const localizedBasePath = path.posix.join(__dirname, '..', langObj.dir, 'content') // Initialize the Page! This is where the file reads happen. - const page = await Page.init({ + let page = await Page.init({ basePath: localizedBasePath, relativePath, languageCode: langObj.code @@ -29,10 +29,17 @@ module.exports = async function createTree (originalPath, langObj) { if (!page) { // Do not throw an error if Early Access is not available. if (relativePath.startsWith('early-access')) return - // Do not throw an error if translated page is not available. - if (langObj.code !== 'en') return - - throw Error(`Cannot initialize page for ${filepath} in ${langObj.code}`) + // If a translated path doesn't exist, fall back to the English so there is parity between + // the English tree and the translated trees. + if (langObj.code !== 'en') { + page = await Page.init({ + basePath: basePath, + relativePath, + languageCode: langObj.code + }) + } + + if (!page) throw Error(`Cannot initialize page for ${filepath}`) } // Create the root tree object on the first run, and create children recursively. diff --git a/lib/liquid-tags/indented-data-reference.js b/lib/liquid-tags/indented-data-reference.js index 03dfeb15c..46b17f871 100644 --- a/lib/liquid-tags/indented-data-reference.js +++ b/lib/liquid-tags/indented-data-reference.js @@ -14,7 +14,7 @@ module.exports = { this.markup = tagToken.args.trim() }, - async render (scope) { + async render (context) { // obfuscate first legit space, remove all other spaces, then restore legit space // this way we can support spaces=NUMBER as well as spaces = NUMBER const input = this.markup @@ -30,7 +30,7 @@ module.exports = { assert(parseInt(numSpaces) || numSpaces === '0', '"spaces=NUMBER" must include a number') // Get the referenced value from the context - const value = await this.liquid.evalValue(`site.data.${dataReference}`, scope) + const value = await this.liquid.evalValue(`site.data.${dataReference}`, context) // If nothing is found in the context, exit with nothing; this may // feel weird and that we should throw an error, but this is "The Liquid Way TM" @@ -39,6 +39,6 @@ module.exports = { // add spaces to each line const renderedReferenceWithIndent = value.replace(/^/mg, ' '.repeat(numSpaces)) - return this.liquid.parseAndRender(renderedReferenceWithIndent, scope.environments) + return this.liquid.parseAndRender(renderedReferenceWithIndent, context) } } diff --git a/lib/redirects/add-redirect-to-frontmatter.js b/lib/redirects/add-redirect-to-frontmatter.js index d392eed5e..3e2d26a4c 100644 --- a/lib/redirects/add-redirect-to-frontmatter.js +++ b/lib/redirects/add-redirect-to-frontmatter.js @@ -1,7 +1,7 @@ // add a new redirect string to redirect_from frontmatter module.exports = function addRedirectToFrontmatter (redirectFromData, newRedirectString) { - if (Array.isArray(redirectFromData) && !redirectFromData.includes(newRedirectString)) { + if (Array.isArray(redirectFromData)) { redirectFromData.push(newRedirectString) } else if (typeof redirectFromData === 'string') { redirectFromData = [redirectFromData] diff --git a/lib/render-content/create-processor.js b/lib/render-content/create-processor.js index 3320d027d..bb4a2d18e 100644 --- a/lib/render-content/create-processor.js +++ b/lib/render-content/create-processor.js @@ -27,7 +27,7 @@ module.exports = function createProcessor (context) { .use(highlight, { languages: { graphql }, subset: false }) .use(raw) .use(rewriteLegacyAssetPaths, context) - .use(wrapInElement, { selector: 'ol > li img', wrapper: 'span.procedural-image-wrapper' }) + .use(wrapInElement, { selector: 'ol > li img', wrapper: 'div.procedural-image-wrapper' }) .use(rewriteLocalLinks, { languageCode: context.currentLanguage, version: context.currentVersion }) .use(html) } diff --git a/lib/render-content/plugins/wrap-in-element.js b/lib/render-content/plugins/wrap-in-element.js index c24ad442f..16b4d6ef8 100644 --- a/lib/render-content/plugins/wrap-in-element.js +++ b/lib/render-content/plugins/wrap-in-element.js @@ -22,11 +22,11 @@ module.exports = options => { throw new TypeError('Expected a `string` as selector') } - for (const match of selectAll(selector, tree)) { + for (const match of selectAll(options.selector, tree)) { visit(tree, match, (node, i, parent) => { - const parsedWrapper = parseSelector(wrapper) - parsedWrapper.children = [node] - parent.children[i] = parsedWrapper + const wrapper = parseSelector('div') + wrapper.children = [node] + parent.children[i] = wrapper }) } } diff --git a/middleware/categories-for-support.js b/middleware/categories-for-support.js deleted file mode 100644 index b577d012b..000000000 --- a/middleware/categories-for-support.js +++ /dev/null @@ -1,55 +0,0 @@ -const path = require('path') -const renderOpts = { textOnly: true, encodeEntities: true } - -// This middleware exposes a list of all categories and child articles at /categories.json. -// GitHub Support uses this for internal ZenDesk search functionality. -module.exports = async function categoriesForSupport (req, res, next) { - const englishSiteTree = req.context.siteTree.en - - const allCategories = [] - - await Promise.all(Object.keys(englishSiteTree).map(async (version) => { - await Promise.all(englishSiteTree[version].childPages.map(async (productPage) => { - if (productPage.page.relativePath.startsWith('early-access')) return - if (!productPage.childPages) return - - await Promise.all(productPage.childPages.map(async (categoryPage) => { - // We can't get the rendered titles from middleware/render-tree-titles - // here because that middleware only runs on the current version, and this - // middleware processes all versions. - const name = categoryPage.page.title.includes('{') - ? await categoryPage.page.renderProp('title', req.context, renderOpts) - : categoryPage.page.title - - allCategories.push({ - name, - published_articles: await findArticlesPerCategory(categoryPage, [], req.context) - }) - })) - })) - })) - - return res.json(allCategories) -} - -async function findArticlesPerCategory (currentPage, articlesArray, context) { - if (currentPage.page.documentType === 'article') { - const title = currentPage.page.title.includes('{') - ? await currentPage.page.renderProp('title', context, renderOpts) - : currentPage.page.title - - articlesArray.push({ - title, - slug: path.basename(currentPage.href) - }) - } - - if (!currentPage.childPages) return articlesArray - - // Run recursively to find any articles deeper in the tree. - await Promise.all(currentPage.childPages.map(async (childPage) => { - await findArticlesPerCategory(childPage, articlesArray, context) - })) - - return articlesArray -} diff --git a/middleware/context.js b/middleware/context.js index ec9c94c85..30081f2ec 100644 --- a/middleware/context.js +++ b/middleware/context.js @@ -10,7 +10,7 @@ const { getPathWithoutLanguage } = require('../lib/path-utils') const productNames = require('../lib/product-names') -const warmServer = process.env.FEATURE_NEW_SITETREE ? require('../lib/warm-server2') : require('../lib/warm-server') +const warmServer = require('../lib/warm-server') const featureFlags = Object.keys(require('../feature-flags')) const builtAssets = require('../lib/built-asset-urls') const searchVersions = require('../lib/search/versions') @@ -27,7 +27,7 @@ module.exports = async function contextualize (req, res, next) { // make feature flag environment variables accessible in layouts req.context.process = { env: {} } featureFlags.forEach(featureFlagName => { - req.context[featureFlagName] = process.env[featureFlagName] + req.context.process.env[featureFlagName] = process.env[featureFlagName] }) // define each context property explicitly for code-search friendliness diff --git a/middleware/contextualizers/breadcrumbs.js b/middleware/contextualizers/breadcrumbs.js deleted file mode 100644 index 2eccfd0e4..000000000 --- a/middleware/contextualizers/breadcrumbs.js +++ /dev/null @@ -1,38 +0,0 @@ -module.exports = async function breadcrumbs (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.hidden) return next() - - req.context.breadcrumbs = [] - - // Return an empty array on the landing page. - if (req.context.page.documentType === 'homepage') { - return next() - } - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - await createBreadcrumb( - // Array of child pages on the root, i.e., the product level. - currentSiteTree.childPages, - req.context - ) - - return next() -} - -async function createBreadcrumb (pageArray, context) { - // Find each page in the siteTree's array of child pages that starts with the requested path. - const childPage = pageArray.find(page => context.currentPath.startsWith(page.href)) - - context.breadcrumbs.push({ - documentType: childPage.page.documentType, - href: childPage.href, - title: childPage.renderedShortTitle || childPage.renderedFullTitle - }) - - // Recursively loop through the siteTree and create each breadcrumb, until we reach the - // point where the current siteTree page is the same as the requested page. Then stop. - if (childPage.childPages && context.currentPath !== childPage.href) { - createBreadcrumb(childPage.childPages, context) - } -} diff --git a/middleware/contextualizers/current-product-tree.js b/middleware/contextualizers/current-product-tree.js deleted file mode 100644 index 92d0cb03d..000000000 --- a/middleware/contextualizers/current-product-tree.js +++ /dev/null @@ -1,10 +0,0 @@ -module.exports = function currentProductTree (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.documentType === 'homepage') return next() - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - req.context.currentProductTree = currentSiteTree.childPages.find(page => req.context.currentPath.startsWith(page.href)) - - return next() -} diff --git a/middleware/contextualizers/early-access-breadcrumbs.js b/middleware/contextualizers/early-access-breadcrumbs.js deleted file mode 100644 index 21f1a0aee..000000000 --- a/middleware/contextualizers/early-access-breadcrumbs.js +++ /dev/null @@ -1,55 +0,0 @@ -module.exports = async function breadcrumbs (req, res, next) { - if (!req.context.page) return next() - if (!req.context.page.hidden) return next() - - req.context.breadcrumbs = [] - - // Return an empty array on the landing page. - if (req.context.page.documentType === 'homepage') { - return next() - } - - const earlyAccessProduct = req.context.siteTree[req.language][req.context.currentVersion].childPages.find(childPage => childPage.page.relativePath === 'early-access/index.md') - if (!earlyAccessProduct) return next() - - // Create initial landing page breadcrumb - req.context.breadcrumbs.push({ - documentType: earlyAccessProduct.page.documentType, - href: '', - title: earlyAccessProduct.page.title - }) - - // If this is the Early Access landing page, return now - if (req.context.currentPath === earlyAccessProduct.href) { - return next() - } - - // Otherwise, create breadcrumbs - await createBreadcrumb( - earlyAccessProduct.childPages, - req.context - ) - - return next() -} - -async function createBreadcrumb (pageArray, context) { - // Find each page in the siteTree's array of child pages that starts with the requested path. - const childPage = pageArray.find(page => context.currentPath.startsWith(page.href)) - - // Gray out product breadcrumb links and `Articles` categories - const hideHref = childPage.page.documentType === 'product' || - (childPage.page.documentType === 'category' && childPage.page.relativePath.endsWith('/articles/index.md')) - - context.breadcrumbs.push({ - documentType: childPage.page.documentType, - href: hideHref ? '' : childPage.href, - title: await childPage.page.renderTitle(context, { textOnly: true, encodeEntities: true }) - }) - - // Recursively loop through the siteTree and create each breadcrumb, until we reach the - // point where the current siteTree page is the same as the requested page. Then stop. - if (childPage.childPages && context.currentPath !== childPage.href) { - createBreadcrumb(childPage.childPages, context) - } -} diff --git a/middleware/contextualizers/early-access-links.js b/middleware/contextualizers/early-access-links.js index b30090a07..f09c68f1d 100644 --- a/middleware/contextualizers/early-access-links.js +++ b/middleware/contextualizers/early-access-links.js @@ -7,7 +7,7 @@ module.exports = function earlyAccessContext (req, res, next) { // Get a list of all hidden pages per version const earlyAccessPageLinks = uniq(Object.values(req.context.pages) - .filter(page => page.hidden && page.relativePath.startsWith('early-access') && !page.relativePath.endsWith('index.md')) + .filter(page => page.hidden && page.relativePath.startsWith('early-access') && page.relativePath !== 'early-access/index.md') .map(page => page.permalinks) .flat()) // Get links for the current version diff --git a/middleware/contextualizers/generic-toc.js b/middleware/contextualizers/generic-toc.js deleted file mode 100644 index 9ebcee7d0..000000000 --- a/middleware/contextualizers/generic-toc.js +++ /dev/null @@ -1,59 +0,0 @@ -const { sortBy } = require('lodash') - -module.exports = async function genericToc (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.hidden) return next() - if (req.context.currentLayoutName !== 'default') return next() - if (req.context.page.documentType === 'homepage' || req.context.page.documentType === 'article') return next() - - const currentSiteTree = req.context.siteTree[req.context.currentLanguage][req.context.currentVersion] - - // Find the array of child pages that start with the requested path. - const currentPageInSiteTree = findPageInSiteTree(currentSiteTree.childPages, req.context.currentPath) - - req.context.tocItems = sortBy( - await getUnsortedTocItems(currentPageInSiteTree.childPages, req.context), - // Sort by the ordered array of `children` in the frontmatter. - currentPageInSiteTree.page.children - ) - - return next() -} - -// Recursively loop through the siteTree until we reach the point where the -// current siteTree page is the same as the requested page. Then stop. -function findPageInSiteTree (pageArray, currentPath) { - const childPage = pageArray.find(page => currentPath.startsWith(page.href)) - - if (childPage.href === currentPath) { - return childPage - } - - return findPageInSiteTree(childPage.childPages, currentPath) -} - -async function getUnsortedTocItems (pageArray, context) { - return Promise.all(pageArray.map(async (childPage) => { - // return an empty string if it's a hidden link on a non-hidden page (hidden links on hidden pages are OK) - if (childPage.page.hidden && !context.page.hidden) { - return '' - } - - const fullPath = childPage.href - // Titles are already rendered by middleware/contextualizers/render-tree-titles.js. - const title = childPage.renderedFullTitle - const intro = await childPage.page.renderProp('intro', context, { unwrap: true }) - - if (!childPage.childPages) { - return { fullPath, title, intro } - } - - const childTocItems = sortBy( - await getUnsortedTocItems(childPage.childPages, context), - // Sort by the ordered array of `children` in the frontmatter. - childPage.page.children - ) - - return { fullPath, title, intro, childTocItems } - })) -} diff --git a/middleware/contextualizers/layout.js b/middleware/contextualizers/layout.js index 7a6051c2e..54c40540a 100644 --- a/middleware/contextualizers/layout.js +++ b/middleware/contextualizers/layout.js @@ -3,18 +3,20 @@ const layouts = require('../../lib/layouts') module.exports = function layoutContext (req, res, next) { if (!req.context.page) return next() - const layoutOptsByType = { + let layoutName + + if (req.context.page.layout) { // Layouts can be specified with a `layout` frontmatter value. // Any invalid layout values will be caught by frontmatter schema validation. - string: req.context.page.layout, + layoutName = req.context.page.layout // A `layout: false` value means use no layout. - boolean: '', - // For all other files (like articles and the homepage), use the `default` layout. - undefined: 'default' + } else if (req.context.page.layout === false) { + layoutName = '' + // If undefined, use either the default layout or the generic-toc layout. + } else if (req.context.page.layout === undefined) { + layoutName = 'default' } - const layoutName = layoutOptsByType[typeof (req.context.page.layout)] - // Attach to the context object req.context.currentLayoutName = layoutName req.context.currentLayout = layouts[layoutName] diff --git a/middleware/contextualizers/render-tree-titles.js b/middleware/contextualizers/render-tree-titles.js deleted file mode 100644 index 0d71ae50d..000000000 --- a/middleware/contextualizers/render-tree-titles.js +++ /dev/null @@ -1,33 +0,0 @@ -const { sortBy } = require('lodash') -const renderOpts = { textOnly: true, encodeEntities: true } - -module.exports = async function renderTreeTitles (req, res, next) { - if (!req.context.page) return next() - if (req.context.page.documentType === 'homepage') return next() - - await renderLiquidInTitles(req.context.siteTree[req.context.currentLanguage][req.context.currentVersion], req.context) - - return next() -} - -// Add new props to each siteTree page here... -async function renderLiquidInTitles (pageInTree, context) { - // We _only_ need to render the titles and shortTitles that contain Liquid. - pageInTree.renderedFullTitle = pageInTree.page.title.includes('{') - ? await pageInTree.page.renderProp('title', context, renderOpts) - : pageInTree.page.title - - if (pageInTree.page.shortTitle) { - pageInTree.renderedShortTitle = pageInTree.page.shortTitle.includes('{') - ? await pageInTree.page.renderProp('shortTitle', context, renderOpts) - : pageInTree.page.shortTitle - } - - if (!pageInTree.childPages) return - - pageInTree.page.childPages = sortBy( - await Promise.all(pageInTree.childPages.map(async (childPage) => await renderLiquidInTitles(childPage, context))), - // Sort by the ordered array of `children` in the frontmatter. - pageInTree.page.children - ) -} diff --git a/middleware/index.js b/middleware/index.js index cb70213a7..e6cacac9a 100644 --- a/middleware/index.js +++ b/middleware/index.js @@ -97,12 +97,7 @@ module.exports = function (app) { app.use(asyncMiddleware(instrument('./archived-enterprise-versions'))) app.use(instrument('./robots')) app.use(/(\/.*)?\/early-access$/, instrument('./contextualizers/early-access-links')) - if (!process.env.FEATURE_NEW_SITETREE) { - app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support-team'))) - } - if (process.env.FEATURE_NEW_SITETREE) { - app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support'))) - } + app.use('/categories.json', asyncMiddleware(instrument('./categories-for-support-team'))) app.use(instrument('./loaderio-verification')) app.get('/_500', asyncMiddleware(instrument('./trigger-error'))) @@ -116,20 +111,8 @@ module.exports = function (app) { app.use(instrument('./contextualizers/webhooks')) app.use(asyncMiddleware(instrument('./contextualizers/whats-new-changelog'))) app.use(instrument('./contextualizers/layout')) - - if (!process.env.FEATURE_NEW_SITETREE) { - app.use(asyncMiddleware(instrument('./breadcrumbs'))) - app.use(asyncMiddleware(instrument('./early-access-breadcrumbs'))) - } - - if (process.env.FEATURE_NEW_SITETREE) { - app.use(asyncMiddleware(instrument('./contextualizers/render-tree-titles'))) - app.use(instrument('./contextualizers/current-product-tree')) - app.use(asyncMiddleware(instrument('./contextualizers/generic-toc'))) - app.use(asyncMiddleware(instrument('./contextualizers/breadcrumbs'))) - app.use(asyncMiddleware(instrument('./contextualizers/early-access-breadcrumbs'))) - } - + app.use(asyncMiddleware(instrument('./breadcrumbs'))) + app.use(asyncMiddleware(instrument('./early-access-breadcrumbs'))) app.use(asyncMiddleware(instrument('./enterprise-server-releases'))) app.use(asyncMiddleware(instrument('./dev-toc'))) app.use(asyncMiddleware(instrument('./featured-links'))) diff --git a/script/content-migrations/add-early-access-tocs.js b/script/content-migrations/add-early-access-tocs.js deleted file mode 100755 index 34d936f50..000000000 --- a/script/content-migrations/add-early-access-tocs.js +++ /dev/null @@ -1,44 +0,0 @@ -#!/usr/bin/env node - -const fs = require('fs') -const path = require('path') -const readFrontmatter = require('../../lib/read-frontmatter') -const earlyAccessDir = path.posix.join(process.cwd(), 'content', 'early-access') -const { sentenceCase } = require('change-case') - -updateOrCreateToc(earlyAccessDir) - -console.log('Updated Early Access TOCs!') - -function updateOrCreateToc (directory) { - const children = fs.readdirSync(directory) - .filter(subpath => !subpath.endsWith('index.md')) - - if (!children.length) return - - const tocFile = path.posix.join(directory, 'index.md') - - let content, data - - if (fs.existsSync(tocFile)) { - const matter = readFrontmatter(fs.readFileSync(tocFile, 'utf8')) - content = matter.content - data = matter.data - } else { - content = '' - data = { - title: sentenceCase(path.basename(directory)), - versions: '*', - hidden: true - } - } - - data.children = children.map(child => `/${child.replace('.md', '')}`) - const newContents = readFrontmatter.stringify(content, data, { lineWidth: 10000 }) - fs.writeFileSync(tocFile, newContents) - - children.forEach(child => { - if (child.endsWith('.md')) return - updateOrCreateToc(path.posix.join(directory, child)) - }) -} diff --git a/script/content-migrations/remove-map-topics.js b/script/content-migrations/remove-map-topics.js index ec24064da..7da04a8e4 100755 --- a/script/content-migrations/remove-map-topics.js +++ b/script/content-migrations/remove-map-topics.js @@ -3,7 +3,6 @@ const fs = require('fs') const path = require('path') const walk = require('walk-sync') -const stripHtmlComments = require('strip-html-comments') const languages = require('../../lib/languages') const frontmatter = require('../../lib/read-frontmatter') const addRedirectToFrontmatter = require('../../lib/redirects/add-redirect-to-frontmatter') @@ -27,10 +26,6 @@ const categoryIndexFiles = fullDirectoryPaths.map(fullDirectoryPath => walk(full categoryIndexFiles.forEach(categoryIndexFile => { let categoryIndexContent = fs.readFileSync(categoryIndexFile, 'utf8') - if (categoryIndexFile.endsWith('github/getting-started-with-github/index.md')) { - categoryIndexContent = stripHtmlComments(categoryIndexContent.replace(/\n$/m.test(line)) - - newContent = newLinesArray.join('\n') - // Index files should no longer have body content, so we write an empty string - fs.writeFileSync(indexFile, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) + fs.writeFileSync(indexFile, frontmatter.stringify('', data, { lineWidth: 10000 })) }) function getLinks (linkItemArray) { diff --git a/stylesheets/article.scss b/stylesheets/article.scss index f7fdf6349..8533e1cb8 100644 --- a/stylesheets/article.scss +++ b/stylesheets/article.scss @@ -10,8 +10,8 @@ grid-template-rows: auto 1fr; grid-template-columns: minmax(500px, 720px) minmax(220px, 1fr); grid-template-areas: - "top right-sidebar" - "bottom right-sidebar"; + 'top right-sidebar' + 'bottom right-sidebar'; column-gap: $spacer-6; } @@ -45,6 +45,7 @@ /* Deprecation banner ------------------------------------------------------------------------------*/ .deprecation-banner { + & + .alert { margin-top: 5px; } @@ -57,21 +58,24 @@ margin-bottom: 0; } + + #bootcamp { + margin-top: 20px; + } + b, strong { font-weight: bold; } p { - margin: 0; + margin: 0; } } /* Code style overrides ------------------------------------------------------------------------------*/ -.markdown-body .highlight pre, -.markdown-body pre { +.markdown-body .highlight pre, .markdown-body pre { margin-top: 10px; } @@ -89,13 +93,12 @@ } } -.breadcrumbs a:not(:last-child)::after, -.breadcrumbs span:not(:last-child)::after { - content: "/"; +.breadcrumbs a:not(:last-child)::after, .breadcrumbs span:not(:last-child)::after { + content: '/'; color: var(--color-auto-gray-4); padding-right: $spacer-1; padding-left: $spacer-2; - display: inline-block; + display:inline-block; } /* Numbered procedures (step 1, step 2, ...) @@ -178,8 +181,7 @@ img[src*="https://github.githubassets.com/images/icons/emoji"] { .warning, .danger { // remove extra space under lists inside of notes - ul, - ol { + ul, ol { margin-bottom: 0; } } diff --git a/stylesheets/dev-toc.scss b/stylesheets/dev-toc.scss index b40f48cbb..6c16a24b8 100644 --- a/stylesheets/dev-toc.scss +++ b/stylesheets/dev-toc.scss @@ -11,4 +11,4 @@ ul.versions-list > li { details ul.products-list li { margin: 3px 0 0 30px; -} +} \ No newline at end of file diff --git a/stylesheets/directory.scss b/stylesheets/directory.scss new file mode 100644 index 000000000..67c9d0afb --- /dev/null +++ b/stylesheets/directory.scss @@ -0,0 +1,50 @@ +/* Styles for directory pages (any page that organizes categories and articles) +------------------------------------------------------------------------------*/ + +// Hoverable boxes on product pages +// Markup can be different and we need both selectors below +.directory-link-box:hover .Box, +.directory-link-box.Box:hover { + border: 1px solid var(--color-auto-blue-5); +} + +// Expandable grid is used on article listing pages +// e.g. enterprise/2.15/admin/installation +.directory-dropdown-grid { + display: grid; + grid-template-columns: 100%; + grid-column-gap: 48px; + grid-row-gap: 24px; + + @include breakpoint(lg) { + grid-template-columns: calc(50% - 24px) calc(50% - 24px); + } + + // Disable the grid row expanding from expanding a closed dropdown on desktop + @include breakpoint(lg) { + .dropdown-withArrow { + max-height: 74px; + + &[open] { + max-height: initial; + } + } + } +} + +// Product ToC list +.directory-toc { + h2 { + margin-top: $spacer-6; + + &:first-of-type { + margin-top: 0; + } + } + + h3 { + margin-top: 0; + padding-bottom: initial; + border-bottom: 0; + } +} diff --git a/stylesheets/gradient.scss b/stylesheets/gradient.scss index b6062ad72..a6e61d2f8 100644 --- a/stylesheets/gradient.scss +++ b/stylesheets/gradient.scss @@ -1,11 +1,6 @@ $gradients: ( - "-purple-pink": - linear-gradient( - 135deg, - var(--color-auto-purple-5) 0%, - var(--color-auto-pink-5) 100% - ), - /*"-aquamarine-mauve": linear-gradient(130deg, #3bf0e4 -6.8%, #bca1f7 70%), + "-purple-pink": linear-gradient(135deg, var(--color-auto-purple-5) 0%, var(--color-auto-pink-5) 100%), +/*"-aquamarine-mauve": linear-gradient(130deg, #3bf0e4 -6.8%, #bca1f7 70%), "-purple-coral": linear-gradient(87.54deg, #9867f0 -6.8%, #ed4e50 84.14%), "-purple-coral-dark": linear-gradient(92deg, #bca1f7 15%, #e577b4 45%, #ff7170 85%), "-coral-yellow": linear-gradient(267.91deg, #ffe57f 9.35%, #ff7170 96.48%), @@ -17,24 +12,9 @@ $gradients: ( "-blue-green": linear-gradient(-70deg, #2188ff 0%, #01a49e 100%), "-red-orange": linear-gradient(-70deg, #ed4e50 0%, #f06f00 100%), "-blue-purple": linear-gradient(-70deg, #2188ff 0%, #804eda 100%), */ - "-pink-blue": - linear-gradient( - 90deg, - var(--color-auto-pink-5) -50%, - var(--color-auto-blue-5) 150% - ), - "-pink-blue-dark": - linear-gradient( - -70deg, - var(--color-auto-pink-3) 0%, - var(--color-auto-blue-3) 100% - ), - "-blue-pink": - linear-gradient( - -70deg, - var(--color-auto-blue-5) 0%, - var(--color-auto-pink-5) 100% - ) + "-pink-blue": linear-gradient(90deg, var(--color-auto-pink-5) -50%, var(--color-auto-blue-5) 150%), + "-pink-blue-dark": linear-gradient(-70deg, var(--color-auto-pink-3) 0%, var(--color-auto-blue-3) 100%), + "-blue-pink": linear-gradient(-70deg, var(--color-auto-blue-5) 0%, var(--color-auto-pink-5) 100%) ) !default; @mixin bg-gradient($parent, $gradient) { @@ -43,9 +23,8 @@ $gradients: ( } } -/* @mixin text-gradient($parent, $gradient) { - #{parent} { + #{$parent} { background-image: $gradient; -webkit-background-clip: text; background-clip: text; @@ -53,7 +32,6 @@ $gradients: ( color: transparent; } } -*/ $border-width: 2px; @mixin border-gradient($parent, $gradient) { @@ -93,11 +71,9 @@ $border-width: 2px; @include bg-gradient(".bg-gradient-#{$gradient}", $value); } -/* @each $gradient, $value in $gradients { - @include text-gradient(".text-gradient-#{gradient}", $value); + @include text-gradient(".text-gradient-#{$gradient}", $value); } -*/ @each $gradient, $value in $gradients { @include border-gradient(".border-gradient-#{$gradient}", $value); diff --git a/stylesheets/index.scss b/stylesheets/index.scss index 839832056..ca807a051 100644 --- a/stylesheets/index.scss +++ b/stylesheets/index.scss @@ -12,6 +12,7 @@ $marketing-font-path: "/dist/fonts/"; @import "new-mktg.scss"; @import "type.scss"; @import "nav.scss"; +@import "directory.scss"; @import "article.scss"; @import "search.scss"; @import "overrides.scss"; diff --git a/stylesheets/nav.scss b/stylesheets/nav.scss index 9271120e1..f7c8a9fd5 100644 --- a/stylesheets/nav.scss +++ b/stylesheets/nav.scss @@ -46,14 +46,14 @@ header summary, } .nav-mobile-burgerIcon { - background: url("/assets/images/octicons/hamburger.svg") no-repeat right; + background: url('/assets/images/octicons/hamburger.svg') no-repeat right; width: 18px; height: 23px; position: relative; z-index: 3; &.js-open { - background: url("/assets/images/octicons/x.svg") no-repeat right; + background: url('/assets/images/octicons/x.svg') no-repeat right; width: 16px; height: 21px; } @@ -91,7 +91,7 @@ header summary, } } -.nav-dropdown { +.nav-dropdown { @media (min-width: 1012px) and (max-width: 1279px) { right: 0; } diff --git a/stylesheets/new-mktg.scss b/stylesheets/new-mktg.scss index ecef50779..6d5c56e10 100644 --- a/stylesheets/new-mktg.scss +++ b/stylesheets/new-mktg.scss @@ -1,15 +1,23 @@ /* Styles not incorporated into Primer yet ------------------------------------------------------------------------------*/ +// Position utils +@media (min-width: $width-lg) { + .top-lg-n9 { + top: -$spacer-9; + } +} + +// Type +.color-text-link-mktg { + color: var(--color-auto-blue-5) !important; +} + // Text styling .underline-dashed { display: inline; padding-bottom: $spacer-1; - background-image: linear-gradient( - to right, - var(--color-auto-gray-3) 50%, - transparent 0% - ); + background-image: linear-gradient(to right, var(--color-auto-gray-3) 50%, transparent 0%); background-repeat: repeat-x; background-position: bottom; background-size: 10px 1px; @@ -43,9 +51,7 @@ // Typography $marketing-font-path: "/assets/fonts/alliance/"; -$font-family-mktg: "Alliance No.1", -apple-system, BlinkMacSystemFont, - "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", - "Segoe UI Emoji", "Segoe UI Symbol" !default; +$font-family-mktg: "Alliance No.1", -apple-system, BlinkMacSystemFont, "Segoe UI", Helvetica, Arial, sans-serif, "Apple Color Emoji", "Segoe UI Emoji", "Segoe UI Symbol" !default; $font-weight-extrabold: 800 !default; .font-mktg { @@ -57,8 +63,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-normal; - src: local("Alliance No.1 Regular"), local("alliance-no-1-regular"), - url("#{$marketing-font-path}alliance-no-1-regular.woff") format("woff"); + src: local("Alliance No.1 Regular"), local("alliance-no-1-regular"), url("#{$marketing-font-path}alliance-no-1-regular.woff") format("woff"); font-display: swap; } @@ -66,8 +71,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-semibold; - src: local("Alliance No.1 Medium"), local("alliance-no-1-medium"), - url("#{$marketing-font-path}alliance-no-1-medium.woff") format("woff"); + src: local("Alliance No.1 Medium"), local("alliance-no-1-medium"), url("#{$marketing-font-path}alliance-no-1-medium.woff") format("woff"); font-display: swap; } @@ -75,8 +79,7 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-bold; - src: local("Alliance No.1 Bold"), local("alliance-no-1-bold"), - url("#{$marketing-font-path}alliance-no-1-bold.woff") format("woff"); + src: local("Alliance No.1 Bold"), local("alliance-no-1-bold"), url("#{$marketing-font-path}alliance-no-1-bold.woff") format("woff"); font-display: swap; } @@ -84,7 +87,6 @@ $font-weight-extrabold: 800 !default; font-family: "Alliance No.1"; font-style: normal; font-weight: $font-weight-extrabold; - src: local("Alliance No.1 ExtraBold"), local("alliance-no-1-extrabold"), - url("#{$marketing-font-path}alliance-no-1-extrabold.woff") format("woff"); + src: local("Alliance No.1 ExtraBold"), local("alliance-no-1-extrabold"), url("#{$marketing-font-path}alliance-no-1-extrabold.woff") format("woff"); font-display: swap; } diff --git a/stylesheets/opacity.scss b/stylesheets/opacity.scss index a2b96b4cd..74f81ddef 100644 --- a/stylesheets/opacity.scss +++ b/stylesheets/opacity.scss @@ -1,6 +1,11 @@ -.opacity-60 { - opacity: 0.6; -} -.opacity-70 { - opacity: 0.7; -} +.opacity-0 { opacity: 0; } +.opacity-10 { opacity: 0.1; } +.opacity-80 { opacity: 0.2; } +.opacity-30 { opacity: 0.3; } +.opacity-40 { opacity: 0.4; } +.opacity-50 { opacity: 0.5; } +.opacity-60 { opacity: 0.6; } +.opacity-70 { opacity: 0.7; } +.opacity-80 { opacity: 0.8; } +.opacity-90 { opacity: 0.9; } +.opacity-100 { opacity: 1; } \ No newline at end of file diff --git a/stylesheets/overrides.scss b/stylesheets/overrides.scss index 30f3389ca..b898027c7 100644 --- a/stylesheets/overrides.scss +++ b/stylesheets/overrides.scss @@ -14,7 +14,6 @@ } } -// NB: Note that there's also overlapping styling in "article.scss" .markdown-body ol > li { padding: $spacer-2 0 $spacer-2 $spacer-7; border: 0; @@ -32,6 +31,7 @@ .extended-markdown { margin-top: 15px; } + } .markdown-body ul ul, @@ -65,18 +65,21 @@ color: var(--color-text-primary); } -.product-callout p, -.contributor-callout p { +.product-callout p, .contributor-callout p { margin: 0; } -// Largely overwritten in tables.scss .markdown-body table { display: table; table-layout: fixed; line-height: 1.5; } +li.nestedTocItem { + margin-left: 2em; + list-style-type: circle; +} + /* Getting Started and Popular Articles sections in article layout */ .markdown-body div.featured-links { padding-bottom: 30px; @@ -94,6 +97,12 @@ margin-top: 0; } +.octicon { + display: inline-block; + vertical-align: text-top; + fill: currentColor; +} + /* code styles */ pre .redbox { border: 2px solid var(--color-auto-red-5); @@ -116,6 +125,27 @@ pre .bluebox { margin-right: 2px; } +/* Accessibility color contrast */ +.btn-mktg { + background-color: var(--color-auto-blue-5); +} + +/* Accessibility color contrast */ +.btn-outline-mktg { + background-color: var(--color-auto-inverse); + color: var(--color-auto-blue-5); +} + +/* Accessibility color contrast */ +.color-bg-danger a { + color: var(--color-auto-blue-6); +} + +/* Accessibility color contrast */ +.markdown-body .color-bg-info blockquote { + color: var(--color-auto-gray-6); +} + /* Helpfulness survey override */ :checked + .x-radio-label { background: var(--color-auto-blue-5); diff --git a/stylesheets/product-landing.scss b/stylesheets/product-landing.scss index 65d0369fe..2024e1b43 100644 --- a/stylesheets/product-landing.scss +++ b/stylesheets/product-landing.scss @@ -1,7 +1,3 @@ .bg-guides-gradient { - background: linear-gradient( - 0deg, - var(--color-auto-blue-0) 0%, - transparent 100% - ); + background: linear-gradient(0deg, var(--color-auto-blue-0) 0%, transparent 100%); } diff --git a/stylesheets/product-sublanding.scss b/stylesheets/product-sublanding.scss index 200145b89..f3e5cb633 100644 --- a/stylesheets/product-sublanding.scss +++ b/stylesheets/product-sublanding.scss @@ -6,7 +6,7 @@ .learning-track { &--description { - min-height: 1em * $body-line-height * 3; + min-height: 1em * $body-line-height * 3 } } @@ -17,12 +17,10 @@ .step-circle-text { color: var(--color-auto-purple-5); } - .description-text { opacity: 0.7; line-height: 1.8em; } - .uppercase-category-text { letter-spacing: 0.08em; font-size: 0.8em; @@ -41,14 +39,27 @@ @include truncate(3); @include truncate(8); + .fade-background-left { - background: linear-gradient(to right, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to right, + var(--color-bg-tertiary), + transparent + ); } .fade-background-right { - background: linear-gradient(to left, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to left, + var(--color-bg-tertiary), + transparent + ); } .fade-background-bottom { - background: linear-gradient(to top, var(--color-bg-tertiary), transparent); + background: linear-gradient( + to top, + var(--color-bg-tertiary), + transparent + ); } diff --git a/stylesheets/release-notes.scss b/stylesheets/release-notes.scss index ba3397dde..7470f3132 100644 --- a/stylesheets/release-notes.scss +++ b/stylesheets/release-notes.scss @@ -1,15 +1,15 @@ ul.release-notes-list li.release-notes-list-item { font-size: 15px !important; - &::marker { + &::marker { // `• ` - content: "\2022\00a0\00a0\00a0\00a0"; + content: '\2022\00a0\00a0\00a0\00a0'; font-size: 1.6em; color: var(--color-auto-gray-4); } &.list-style-none::marker { - content: ""; + content: ''; } } @@ -17,9 +17,7 @@ ul.release-notes-list li.release-notes-list-item { font-size: 15px !important; } -details[open].release-notes-version-picker - summary - .octicon.octicon-chevron-down { +details[open].release-notes-version-picker summary .octicon.octicon-chevron-down { transform: rotate(180deg); } @@ -29,7 +27,7 @@ details[open].release-notes-version-picker } } -$colors-list: ( +$colors-list:( features: var(--color-auto-green-5), bugs: var(--color-auto-yellow-5), known_issues: var(--color-auto-blue-5), @@ -39,12 +37,11 @@ $colors-list: ( backups: var(--color-auto-orange-5) ); -@each $key, $val in $colors-list { +@each $key,$val in $colors-list{ .release-notes-section-#{$key} { .release-notes-section-label { background-color: #{$val}; } - .release-notes-section-heading { color: #{$val}; } diff --git a/stylesheets/scroll-button.scss b/stylesheets/scroll-button.scss index 4f49d3653..d2fe257a8 100644 --- a/stylesheets/scroll-button.scss +++ b/stylesheets/scroll-button.scss @@ -1,19 +1,18 @@ button.arrow-for-scrolling-top { - opacity: 0; - transition: 1s; - background-color: var(--color-auto-blue-5); - color: var(--color-text-inverse); - position: fixed; - bottom: 10px; - right: 10px; - display: block; - width: 40px; - height: 40px; - border-radius: 50%; - - &.show { - opacity: 1; - border: none; + opacity: 0; transition: 1s; - } + background-color: var(--color-auto-blue-5); + color: var(--color-text-inverse); + position: fixed; + bottom: 10px; + right: 10px; + display: block; + width: 40px; + height: 40px; + border-radius: 50%; + &.show { + opacity: 1; + border: none; + transition: 1s; + } } diff --git a/stylesheets/search.scss b/stylesheets/search.scss index 1219f5280..0972cd31b 100644 --- a/stylesheets/search.scss +++ b/stylesheets/search.scss @@ -22,8 +22,31 @@ Form and inputs using .ais- prefix gets added by search.js */ padding: 10px $spacer-2 10px $spacer-5; font-size: 16px; @extend .form-control; - background: var(--color-bg-primary) url("/assets/images/octicons/search.svg") - no-repeat 6px; + background: var(--color-bg-primary) url("/assets/images/octicons/search.svg") no-repeat 6px; +} + +.ais-SearchBox-reset { + width: 30px; + height: 100%; + position: absolute; + top: 0; + right: 0; + opacity: 0.5; + border: none; + outline: none; + background: none; + z-index: 1; + + @include breakpoint(md) { + header & { + height: 30px; + } + } + + .ais-SearchBox-resetIcon { + width: 12px; + height: 12px; + } } .ais-Hits-item { @@ -47,7 +70,8 @@ Form and inputs using .ais- prefix gets added by search.js */ } mark, -.ais-Highlight-highlighted { +.ais-Highlight-highlighted +{ background: none; color: inherit; diff --git a/stylesheets/shadows.scss b/stylesheets/shadows.scss index 63af06627..c3f05069d 100644 --- a/stylesheets/shadows.scss +++ b/stylesheets/shadows.scss @@ -1,5 +1,5 @@ .hover-shadow { - /* & { + & { transition: box-shadow 0.3s ease-in-out; &:hover { @@ -13,7 +13,7 @@ &:hover { box-shadow: var(--color-shadow-medium) !important; } - } */ + } &-large { transition: box-shadow 0.3s ease-in-out; @@ -23,11 +23,11 @@ } } - /* &-extra-large { + &-extra-large { transition: box-shadow 0.3s ease-in-out; &:hover { box-shadow: var(--color-shadow-extra-large) !important; } - } */ + } } diff --git a/stylesheets/sidebar.scss b/stylesheets/sidebar.scss index dcfcd8e58..5b7a13670 100644 --- a/stylesheets/sidebar.scss +++ b/stylesheets/sidebar.scss @@ -46,6 +46,8 @@ .sidebar-category, .sidebar-maptopic, .sidebar-article { + &.active > a { + } &.is-current-page > a { color: var(--color-auto-blue-3); } @@ -58,7 +60,6 @@ .sidebar-maptopic { .sidebar-article { position: relative; - &::before { content: ""; position: absolute; @@ -68,7 +69,6 @@ width: 1px; top: 0; } - &.active { &::before { border-left: 3px solid var(--color-auto-blue-7); diff --git a/stylesheets/type.scss b/stylesheets/type.scss index 9811628ba..13b427b55 100644 --- a/stylesheets/type.scss +++ b/stylesheets/type.scss @@ -25,7 +25,6 @@ summary { display: inline-block; margin-top: 10px; margin-bottom: 10px; - p { margin: 0; padding: 0; @@ -38,4 +37,8 @@ summary { // except those on each product's toc h3 a { color: var(--color-auto-blue-5); + + .directory-toc & { + color: var(--color-auto-gray-9); + } }