diff --git a/.all-contributorsrc b/.all-contributorsrc index 6a608ccc20..994a3ed16a 100644 --- a/.all-contributorsrc +++ b/.all-contributorsrc @@ -285,6 +285,15 @@ "bug", "code" ] + }, + { + "login": "BenJam", + "name": "Benjamin Nickolls", + "avatar_url": "https://avatars2.githubusercontent.com/u/158833?v=4", + "profile": "https://github.com/BenJam", + "contributions": [ + "doc" + ] } ], "contributorsPerLine": 7, @@ -294,4 +303,4 @@ "repoHost": "https://github.com", "skipCi": true, "commitConvention": "none" -} \ No newline at end of file +} diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000000..9255044645 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: GitHub Support + url: https://support.github.com/contact + about: Contact Support if you're having trouble with your GitHub account. diff --git a/.github/ISSUE_TEMPLATE/engineering-issue.md b/.github/ISSUE_TEMPLATE/engineering-issue.md deleted file mode 100644 index d99619c21d..0000000000 --- a/.github/ISSUE_TEMPLATE/engineering-issue.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Docs Engineering support request -about: Get help from the Docs Engineering team with bugs, site features, testing, deployment, etc. -title: '' -labels: engineering -projects: github/1269 -assignees: '' ---- - - - -### What's happening? - - - -### What did you expect to happen? - - -### What have you tried? - - -- [ ] Inspected failing test output πŸ” -- [ ] Reproduced the problem locally on your own computer πŸ’» -- [ ] Redeployed to staging -- [ ] Asked writers on the `@github/product-docs` team for πŸ‘€ -- [ ] Other... - -### What is the timeframe? - - - - diff --git a/.github/ISSUE_TEMPLATE/enterprise-release.md b/.github/ISSUE_TEMPLATE/enterprise-release.md deleted file mode 100644 index 5fddaf37d1..0000000000 --- a/.github/ISSUE_TEMPLATE/enterprise-release.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: Enterprise Release issue -about: Playbook for releasing new Enterprise versions -title: '' -labels: engineering -assignees: '' ---- - -- [ ] Prepend the new version string to the `supported` array in [lib/enterprise-server-releases.js](lib/enterprise-server-releases.js) -- [ ] Run `npm run sync-search` to generate and upload new Algolia indices in each supported language for the new GHE version. You can also run `npm run sync-search-dry-run` to do a test build of all the indices without actually uploading anything to Algolia's servers. See [search.md#development](https://github.com/github/docs-internal/blob/main/search.md#development) for more details. -- [ ] Run `script/update-enterprise-dates.js` to get the latest Enterprise release and deprecation dates. - -**Note**: The `update-enterprise-dates.js` script requires that you have a GitHub Personal Access Token in a `.env` file. See [script/README.md](https://github.com/github/docs-internal/blob/main/script/README.md#additional-scripts) for details. - -cc @github/docs-engineering diff --git a/.github/ISSUE_TEMPLATE/improve-existing-docs.md b/.github/ISSUE_TEMPLATE/improve-existing-docs.md index b8143f0395..168e744973 100644 --- a/.github/ISSUE_TEMPLATE/improve-existing-docs.md +++ b/.github/ISSUE_TEMPLATE/improve-existing-docs.md @@ -1,13 +1,33 @@ --- -name: Docs content issues have moved! -about: Create an issue about existing content (not upcoming releases/ships), whether reported by users or noticed by Hubbers. +name: Improve existing docs +about: Make a suggestion to improve our existing documentation. title: '' labels: -- Improve existing docs +- content assignees: '' --- -# Docs content issues have moved! + -When we open source this repository in October :tada: all of our issue templates will be visible to the public. From now on, you can open new docs issues for docs.github.com in our internal [docs-content repo](https://github.com/github/docs-content) :dizzy: + + +### What article on docs.github.com is affected? + + + +### What part(s) of the article would you like to see updated? + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/improve-the-site.md b/.github/ISSUE_TEMPLATE/improve-the-site.md new file mode 100644 index 0000000000..df3a1fe1e7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improve-the-site.md @@ -0,0 +1,33 @@ +--- +name: Improve the docs.github.com site +about: Make a suggestions or report a problem on the docs.github.com website. +title: '' +labels: engineering +assignees: '' +--- + + + + + +### What is the current behavior? + + + +### What changes are you suggesting? + + + +### Additional information + + diff --git a/.github/ISSUE_TEMPLATE/issue-party.md b/.github/ISSUE_TEMPLATE/issue-party.md deleted file mode 100644 index 9437022a48..0000000000 --- a/.github/ISSUE_TEMPLATE/issue-party.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Issue party content strategy plan -about: Create an issue about existing content for external contributors to work on in the soon to be public repo. -title: '' -labels: -- transfer-to-oss -assignees: '' - ---- - -## Issue party content strategy plan - -## Content plan - -_Summarize the issue, the impact on GitHub users, and the documentation changes we'll make to resolve the issue._ - -### Audience - -Describe the audience for the change. - -### Content to update - -List the articles we'll update with relevant details on the change to make. - -### Questions - -If you have any questions after writing a plan, ask them here! diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 65695b4759..8aba8a8e28 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -1,15 +1,29 @@ + + + +### Why: + + + +### What's being changed: + + + +### Check off the following: +- [ ] All of the tests are passing. +- [ ] I have reviewed my changes in staging. +- [ ] 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). diff --git a/.github/config.yml b/.github/config.yml new file mode 100644 index 0000000000..4136dc84fa --- /dev/null +++ b/.github/config.yml @@ -0,0 +1,11 @@ +# Configuration for welcome - https://github.com/behaviorbot/welcome + +# Configuration for new-issue-welcome - https://github.com/behaviorbot/new-issue-welcome +# Comment to be posted to on first time issues +newIssueWelcomeComment: > + Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the [contributing guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md). + +# Configuration for new-pr-welcome - https://github.com/behaviorbot/new-pr-welcome +# Comment to be posted to on PRs from first time contributors in your repository +newPRWelcomeComment: > + Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the [contributing guidelines](https://github.com/github/docs/blob/main/CONTRIBUTING.md). diff --git a/.github/workflows/merged-notification.yml b/.github/workflows/merged-notification.yml index 7cc62bc58b..5b38232b38 100644 --- a/.github/workflows/merged-notification.yml +++ b/.github/workflows/merged-notification.yml @@ -15,9 +15,9 @@ jobs: issue_number: context.payload.pull_request.number, body: `Thanks very much for contributing! Your pull request has been merged πŸŽ‰ You should see your changes appear on the site in approximately 24 hours. To add your ✨ contribution to the README.md, create a new comment in this PR with: - ``` + \`\`\` @all-contributors please add @${context.payload.pull_request.user.login} for docs - ``` + \`\`\` If you want to, you can use the [emoji key](https://allcontributors.org/docs/en/emoji-key) to replace docs with a different contribution type.` }) diff --git a/.github/workflows/repo-sync.yml b/.github/workflows/repo-sync.yml index 6c5d696db4..2239456eb1 100644 --- a/.github/workflows/repo-sync.yml +++ b/.github/workflows/repo-sync.yml @@ -1,3 +1,9 @@ +# The docs.github.com project has two repositories: github/docs (public) and github/docs-internal (private) +# +# This GitHub Actions workflow keeps the main branch of those two repos in sync. +# +# For more details, see https://github.com/repo-sync/repo-sync#how-it-works + name: Repo Sync on: diff --git a/.github/workflows/sync-algolia-search-indices.yml b/.github/workflows/sync-algolia-search-indices.yml index 6a75fd5e33..9af47377fc 100644 --- a/.github/workflows/sync-algolia-search-indices.yml +++ b/.github/workflows/sync-algolia-search-indices.yml @@ -15,7 +15,7 @@ jobs: uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: - node-version: "12.x" + node-version: 14.x - name: cache node modules uses: actions/cache@v1 with: diff --git a/.github/workflows/test-translations.yml b/.github/workflows/test-translations.yml index 75d07d18bd..68daec8099 100644 --- a/.github/workflows/test-translations.yml +++ b/.github/workflows/test-translations.yml @@ -19,7 +19,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache @@ -57,7 +57,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache diff --git a/.github/workflows/test-windows.yml b/.github/workflows/test-windows.yml index c85ec1e04b..649df7a1c3 100644 --- a/.github/workflows/test-windows.yml +++ b/.github/workflows/test-windows.yml @@ -20,7 +20,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache @@ -58,7 +58,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index c5bd73f20c..ddfde7bbed 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -23,7 +23,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache @@ -60,7 +60,7 @@ jobs: - name: Setup node uses: actions/setup-node@v1 with: - node-version: 12.x + node-version: 14.x - name: Get npm cache directory id: npm-cache diff --git a/.github/workflows/triage-issue-comments.yml b/.github/workflows/triage-issue-comments.yml index 77a7e85134..ac1e449413 100644 --- a/.github/workflows/triage-issue-comments.yml +++ b/.github/workflows/triage-issue-comments.yml @@ -33,13 +33,13 @@ jobs: return 'false' } - name: Label issues with new comments with 'triage' - uses: andymckay/labeler@v1.0.2 + uses: rachmari/labeler@v1.0.4 if: (steps.is-internal-contributor.outputs.result == 'false') with: repo-token: "${{ secrets.GITHUB_TOKEN }}" add-labels: "triage" - name: Triage to project board - uses: konradpabjan/actions-add-new-issue-to-column@v1.1 + uses: rachmari/actions-add-new-issue-to-column@v1.1.1 with: action-token: ${{ secrets.GITHUB_TOKEN }} project-url: "https://github.com/github/docs/projects/1" diff --git a/.github/workflows/triage-issues.yml b/.github/workflows/triage-issues.yml index 301592da99..6bf0888eec 100644 --- a/.github/workflows/triage-issues.yml +++ b/.github/workflows/triage-issues.yml @@ -10,12 +10,12 @@ jobs: steps: - name: Label new issues with 'triage' - uses: andymckay/labeler@v1.0.2 + uses: rachmari/labeler@v1.0.4 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" add-labels: "triage" - name: Triage to project board - uses: konradpabjan/actions-add-new-issue-to-column@v1.1 + uses: rachmari/actions-add-new-issue-to-column@v1.1.1 with: action-token: ${{ secrets.GITHUB_TOKEN }} project-url: "https://github.com/github/docs/projects/1" diff --git a/.github/workflows/triage-pull-requests.yml b/.github/workflows/triage-pull-requests.yml index 07ebe4ba0a..778d6a1110 100644 --- a/.github/workflows/triage-pull-requests.yml +++ b/.github/workflows/triage-pull-requests.yml @@ -4,18 +4,18 @@ on: types: [reopened, opened] jobs: - triage_issues: + triage_pulls: if: github.repository == 'github/docs' runs-on: ubuntu-latest steps: - name: Label new pull requests with 'triage' - uses: andymckay/labeler@v1.0.2 + uses: rachmari/labeler@v1.0.4 with: repo-token: "${{ secrets.GITHUB_TOKEN }}" add-labels: "triage" - name: Triage to project board - uses: konradpabjan/actions-add-new-issue-to-column@v1.1 + uses: rachmari/actions-add-new-issue-to-column@v1.1.1 with: action-token: ${{ secrets.GITHUB_TOKEN }} project-url: "https://github.com/github/docs/projects/1" diff --git a/.node-version b/.node-version index a54ec1fce4..98b0fc5f44 100644 --- a/.node-version +++ b/.node-version @@ -1 +1 @@ -12.8.0 \ No newline at end of file +14.13.0 \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71a7a92ff3..0a15ad19a2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,58 @@ # Contributing to this repository -We welcome contributions from the community. Read on to learn about the ways you can contribute to GitHub Docs. + +## Getting started + +Before you begin: +- This site is powered by Node.js. Check to see if you're on the [version of node we support](contributing/development.md). +- Have you read the [code of conduct](CODE_OF_CONDUCT.md)? +- Check out the [existing issues](https://github.com/github/docs/issues) & see if we [accept contributions](#types-of-contributions-memo) for your type of issue. + +### Use the 'make a contribution' button + +![](./assets/images/make-contribution.gif) + +Navigating a new codebase can be challenging, so we're making that a little easier. As you're using docs.github.com, you may come across an article that you want to make an update to. You can click on the **make a contribution** button right on that article, which will take you to the file in this repo where you'll make your changes. + +Before you make your changes, check to see if an [issue exists](https://github.com/github/docs/issues/) already for the change you want to make. + +### Don't see your issue? Open one + +If you spot something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. + +### Ready to make a change? Fork the repo + +Fork using GitHub Desktop: + +- [Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. +- Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! + +Fork using the command line: +- [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them. + +### Make your update: +Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-githubdocs-repository). + - Are you making changes to the application code? You'll need **Node.js v14** to run the site locally. See [contributing/development.md](contributing/development.md). + - Are you contributing to markdown? We use [GitHub Markdown](contributing/content-markup-reference). + +### Open a pull request +When you're done making changes and you'd like to propose them for review, use the [pull request template](#pull-request-template) to open your PR (pull request). + +### Submit your PR & get it reviewed +- Once you submit your PR, others from the Docs community will review it with you. The first thing you're going to want to do is a [self review](#self-review). +- After that, we may have questions, check back on your PR to keep up with the conversation. +- Did you have an issue, like a merge conflict? Check out our [git tutorial](https://lab.github.com/githubtraining/managing-merge-conflicts) on how to resolve merge conflicts and other issues. + +### Your PR is merged! +Congratulations! The whole GitHub community thanks you. :sparkles: + +Once your PR is merged, you can be added as a contributor in the [readme](README.md#contributors-). + +### Keep contributing as you use GitHub Docs + +Now that you're a part of the GitHub Docs community, you can keep participating in many ways. + +**Learn more about contributing:** + - [Types of contributions :memo:](#types-of-contributions-memo) - [:mega: Discussions](#mega-discussions) - [:beetle: Issues](#beetle-issues) @@ -26,10 +79,10 @@ We welcome contributions from the community. Read on to learn about the ways you - [Windows](#windows) ## Types of contributions :memo: -You can contribute to the GitHub Docs content and site in several ways. +You can contribute to the GitHub Docs content and site in several ways. This repo is a place to discuss and collaborate on docs.github.com! Our small, but mighty :muscle: docs team is maintaining this repo, to preserve our bandwidth, off topic conversations will be closed. ### :mega: Discussions -Discussions are where we have conversations. +Discussions are where we have conversations. If you'd like help troubleshooting a docs PR you're working on, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/github/docs/discussions). @@ -39,7 +92,7 @@ If you'd like help troubleshooting a docs PR you're working on, have a great new If you've found something in the content or the website that should be updated, search open issues to see if someone else has reported the same thing. If it's something new, open an issue using a [template](https://github.com/github/docs/issues/new/choose). We'll use the issue to have a conversation about the problem you want to fix. ### :hammer_and_wrench: Pull requests -A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. +A [pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests) is a way to suggest changes in our repository. When we merge those changes, they should be deployed to the live site within 24 hours. :earth_africa: To learn more about opening a pull request in this repo, see [Opening a pull request](#opening-a-pull-request) below. @@ -66,22 +119,11 @@ You can browse existing issues to find something that needs help! Labels can help you find an issue you'd like to help with. - The [`good-first-issue` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Agood-first-issue) is for problems or updates we think are ideal for beginners. - The [`content` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Acontent) is for problems or updates in the content on docs.github.com. These will usually require some knowledge of Markdown. -- The [`engineering` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aengineering) is for problems or updates in the docs.github.com website. These will usually require some knowledge of JavaScript/Node.js or YAML to fix. +- The [`engineering` label](https://github.com/github/docs/issues?q=is%3Aopen+is%3Aissue+label%3Aengineering) is for problems or updates in the docs.github.com website. These will usually require some knowledge of JavaScript/Node.js or YAML to fix. ## Opening a pull request You can use the GitHub user interface :pencil2: for some small changes, like fixing a typo or updating a readme. You can also fork the repo and then clone it locally, to view changes and run your tests on your machine. -### Fork using GitHub Desktop -[Getting started with GitHub Desktop](https://docs.github.com/en/desktop/installing-and-configuring-github-desktop/getting-started-with-github-desktop) will guide you through setting up Desktop. Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)! - -### Fork using the command line -1. [Fork](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) the repo. -2. Open the terminal. -3. Enter the following command. Use your GitHub username instead of `YOUR-USERNAME`. - ``` - git clone git@github.com:YOUR-USERNAME/docs - ``` - ## Working in the github/docs repository Here's some information that might be helpful while working on a Docs PR: @@ -97,69 +139,10 @@ Here's some information that might be helpful while working on a Docs PR: - [Liquid](/contribution/liquid-helpers.md) - We use liquid helpers to create different versions of our content. -- [Scripts](/script/README.md) - The scripts directory is the home for all of the scripts you can run locally. +- [Scripts](/script/README.md) - The scripts directory is the home for all of the scripts you can run locally. - [Tests](/tests/README.md) - We use tests to ensure content will render correctly on the site. Tests run automatically in your PR, and sometimes it's also helpful to run them locally. -## Resolving merge conflicts -When you try to merge two branches that change the same part of the same file, you will get a merge conflict. - -### In the GitHub user interface -You can resolve the merge conflicts in the [GitHub UI](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/resolving-a-merge-conflict-on-github). This is useful for small conflicts, but if the conflict is more involved, you'll want to use your editor. - -#### Editing the file and committing the changes - -1. On the command line or GitHub Desktop, note the file that contains merge conflicts. -2. Open the file in your editor. -3. In the file, look for the merge conflict markers. (this is what it looks like in Atom) - - ```command-line - <<<<<<< HEAD - - Here are your changes. - ===================== - Here are the changes you are pulling in. - >>>>>>> main -``` -4. Decide which changes to keep and delete the unwanted changes and the merge conflict markers. If there are multiple files with merge conflicts, repeat this step until you resolve all conflicts. - - ```command-line - Here are your changes. -``` - -**Note**: Resolving merge conflicts requires thought; it isn't purely mechanical and rote. Sometimes you outright accept your own changes, sometimes you take the upstream changes, and sometimes you combine the two to make a glorious hybrid update. - -5. To commit your new changes: -- Using Desktop: - - Check out this [GitHub Desktop](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/committing-and-reviewing-changes-to-your-project) article. - -- Using the terminal: - - Stage the file (or files) you just modified for commit. - - ```command-line - $ git add -``` - - Commit the file to your local branch. - - ```command-line - $ git commit -m "resolves merge conflicts" -``` - - Push the committed changes to the remote branch of the repository on GitHub. - ```command-line - $ git push origin -``` - -## Troubleshooting -If you get stuck while you're trying to contribute, see if someone else has had a similar problem in [discussions](https://github.com/github/docs/discussions). If not, open a new discussion! - -While you're there, we'd appreciate any help answering questions you feel knowledgeable about. - -### Failed status checks -If your pull request has failing status checks, [Troubleshooting](/contributing/troubleshooting.md) will walk you through some of the possible reasons. - -## Draft pull requests -Do not review any [draft PRs](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests), they're not ready! The docs team uses draft PRs to work on projects over time. When the PR is ready for feedback, we'll change the state from draft to ready for review. - ## Reviewing We (usually the docs team, but sometimes GitHub product managers, engineers, or supportocats too!) review every single PR. The purpose of reviews is to create the best content we can for people who use GitHub. diff --git a/Dockerfile b/Dockerfile index a99f471d8d..59846b78f6 100644 --- a/Dockerfile +++ b/Dockerfile @@ -6,7 +6,7 @@ # INSTALLATION IMAGE # A temporary image that installs production-only dependencies -FROM node:12-alpine as installation +FROM node:14-alpine as installation ENV NODE_ENV production WORKDIR /usr/src/docs COPY package*.json ./ @@ -18,7 +18,7 @@ RUN npm ci # BUNDLE IMAGE # A temporary image that installs dependencies and builds the production-ready front-end bundles. -FROM node:12-alpine as bundles +FROM node:14-alpine as bundles WORKDIR /usr/src/docs # Install the files used to create the bundles COPY package*.json ./ @@ -32,7 +32,7 @@ RUN npm ci && npm run build # -------------------------------------------------------------------------------- # MAIN IMAGE -FROM node:12-alpine +FROM node:14-alpine # Let's make our home WORKDIR /usr/src/docs diff --git a/LICENSE b/LICENSE index b50625eb63..9238c8f938 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,386 @@ -MIT License +Attribution 4.0 International -Copyright (c) 2020 GitHub +======================================================================= -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. +Using Creative Commons Public Licenses -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the β€œLicensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/LICENSE-CODE b/LICENSE-CODE new file mode 100644 index 0000000000..b50625eb63 --- /dev/null +++ b/LICENSE-CODE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 GitHub + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 66fa37e4e6..30cb965b76 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ This repository contains the documentation website code and Markdown source files for docs.github.com. -GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. +GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo. In this article: - [Contributing](#contributing) @@ -12,15 +12,33 @@ In this article: ## Contributing -:memo: To find out how you can best contribute to GitHub's product documentation, see the [CONTRIBUTING](/CONTRIBUTING.md) guide. +### Start contributing right now: -:mega: If you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/github/docs/discussions). +We accept a lot of [different contributions](CONTRIBUTING.md/#types-of-contributions-memo), including some that don't require you to write a single line of code. -:beetle: If you've found a problem, you can open an issue using a [template](https://github.com/github/docs/issues/new/choose). +#### Click **make a contribution** from docs -:question: If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). +As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on **make a contribution** to navigate directly to that article in the codebase, so that you can begin making your contribution. -:yellow_heart: We do not accept pull requests for translated content - see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information. + + +#### Open an issue + +If you've found a problem, you can open an issue using a [template](https://github.com/github/docs/issues/new/choose). + +#### Join us in discussions + +We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in [discussions](https://github.com/github/docs/discussions). + +#### And that's it! +That's how you can get started easily as a member of the GitHub Documentation community. :sparkles: + +If you want to know more, or you're making a more complex contribution, check out [Getting Started with Contributing](/CONTRIBUTING.md). + +There are a few more things to know when you're getting started with this repo: + +1. If you're having trouble with your GitHub account, contact [Support](https://support.github.com/contact). +2. We do not accept pull requests for translated content - see [CONTRIBUTING.md](/CONTRIBUTING.md) for more information. ## READMEs @@ -43,9 +61,9 @@ In addition to the README you're reading right now, this repo includes other REA ## License -The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](content/LICENSE). +The GitHub product documentation in the assets, content, and data folders are licensed under a [CC-BY license](LICENSE). -All other code in this repository is licensed under a [MIT](LICENSE.md). +All other code in this repository is licensed under a [MIT license](LICENSE-CODE). When using the GitHub logos, be sure to follow the [GitHub logo guidelines](https://github.com/logos). @@ -58,45 +76,48 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + - - - - - - - + + + + + + + + + +

Alexandra Bourne
πŸ–‹ πŸ›
Cynthia Rich
πŸ–‹ πŸ›
Emily Gould
πŸ–‹ πŸ›
Felicity Chapman
πŸ–‹ πŸ›
Kevin Heis
πŸ› πŸ’»
Alistair Christie
πŸ–‹ πŸ›
James M. Greene
πŸ› πŸ’»
Alexandra Bourne
πŸ–‹ πŸ›
Cynthia Rich
πŸ–‹ πŸ›
Emily Gould
πŸ–‹ πŸ›
Felicity Chapman
πŸ–‹ πŸ›
Kevin Heis
πŸ› πŸ’»
Alistair Christie
πŸ–‹ πŸ›
James M. Greene
πŸ› πŸ’»

Janice
πŸ–‹ πŸ›
Jason Etcovitch
πŸ› πŸ’»
James Fletcher
πŸ–‹ πŸ›
Jenn Leaver
πŸ–‹ πŸ›
jmarlena
πŸ–‹ πŸ›
John M. Wargo
πŸ–‹ πŸ›
Laura Coursen
πŸ–‹ πŸ›
Janice
πŸ–‹ πŸ›
Jason Etcovitch
πŸ› πŸ’»
James Fletcher
πŸ–‹ πŸ›
Jenn Leaver
πŸ–‹ πŸ›
jmarlena
πŸ–‹ πŸ›
John M. Wargo
πŸ–‹ πŸ›
Laura Coursen
πŸ–‹ πŸ›

Lucas Costi
πŸ–‹ πŸ›
Martin Lopes
πŸ–‹ πŸ›
Matt Pollard
πŸ–‹ πŸ›
mc
πŸ–‹ πŸ›
Meg Bird
πŸ–‹ πŸ›
Melanie Yarbrough
πŸ–‹ πŸ›
Rachael Sewell
πŸ–‹ πŸ›
Lucas Costi
πŸ–‹ πŸ›
Martin Lopes
πŸ–‹ πŸ›
Matt Pollard
πŸ–‹ πŸ›
mc
πŸ–‹ πŸ›
Meg Bird
πŸ–‹ πŸ›
Melanie Yarbrough
πŸ–‹ πŸ›
Rachael Sewell
πŸ–‹ πŸ›

Leona B. Campbell
πŸ–‹ πŸ›
Sarah Schneider
πŸ› πŸ’»
Shati Patel
πŸ–‹ πŸ›
Kathy Korevec
πŸ–‹ πŸ›
Amy Burns
πŸ–‹ πŸ›
Vanessa Yuen
πŸ› πŸ’»
Zeke Sikelianos
πŸ› πŸ’»
Leona B. Campbell
πŸ–‹ πŸ›
Sarah Schneider
πŸ› πŸ’»
Shati Patel
πŸ–‹ πŸ›
Kathy Korevec
πŸ–‹ πŸ›
Amy Burns
πŸ–‹ πŸ›
Vanessa Yuen
πŸ› πŸ’»
Zeke Sikelianos
πŸ› πŸ’»

Benjamin Nickolls
πŸ“–
- + -This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! \ No newline at end of file +This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome! diff --git a/assets/images/contribution_cta.png b/assets/images/contribution_cta.png new file mode 100644 index 0000000000..59bb7374de Binary files /dev/null and b/assets/images/contribution_cta.png differ diff --git a/assets/images/make-contribution.gif b/assets/images/make-contribution.gif new file mode 100644 index 0000000000..b348f12b6c Binary files /dev/null and b/assets/images/make-contribution.gif differ diff --git a/assets/images/octocat-books.png b/assets/images/octocat-books.png new file mode 100644 index 0000000000..1586da4067 Binary files /dev/null and b/assets/images/octocat-books.png differ diff --git a/content/LICENSE b/content/LICENSE deleted file mode 100644 index 9238c8f938..0000000000 --- a/content/LICENSE +++ /dev/null @@ -1,386 +0,0 @@ -Attribution 4.0 International - -======================================================================= - -Creative Commons Corporation ("Creative Commons") is not a law firm and -does not provide legal services or legal advice. Distribution of -Creative Commons public licenses does not create a lawyer-client or -other relationship. Creative Commons makes its licenses and related -information available on an "as-is" basis. Creative Commons gives no -warranties regarding its licenses, any material licensed under their -terms and conditions, or any related information. Creative Commons -disclaims all liability for damages resulting from their use to the -fullest extent possible. - -Using Creative Commons Public Licenses - -Creative Commons public licenses provide a standard set of terms and -conditions that creators and other rights holders may use to share -original works of authorship and other material subject to copyright -and certain other rights specified in the public license below. The -following considerations are for informational purposes only, are not -exhaustive, and do not form part of our licenses. - - Considerations for licensors: Our public licenses are - intended for use by those authorized to give the public - permission to use material in ways otherwise restricted by - copyright and certain other rights. Our licenses are - irrevocable. Licensors should read and understand the terms - and conditions of the license they choose before applying it. - Licensors should also secure all rights necessary before - applying our licenses so that the public can reuse the - material as expected. Licensors should clearly mark any - material not subject to the license. This includes other CC- - licensed material, or material used under an exception or - limitation to copyright. More considerations for licensors: - wiki.creativecommons.org/Considerations_for_licensors - - Considerations for the public: By using one of our public - licenses, a licensor grants the public permission to use the - licensed material under specified terms and conditions. If - the licensor's permission is not necessary for any reason--for - example, because of any applicable exception or limitation to - copyright--then that use is not regulated by the license. Our - licenses grant only permissions under copyright and certain - other rights that a licensor has authority to grant. Use of - the licensed material may still be restricted for other - reasons, including because others have copyright or other - rights in the material. A licensor may make special requests, - such as asking that all changes be marked or described. - Although not required by our licenses, you are encouraged to - respect those requests where reasonable. More considerations - for the public: - wiki.creativecommons.org/Considerations_for_licensees - -======================================================================= - -Creative Commons Attribution 4.0 International Public License - -By exercising the Licensed Rights (defined below), You accept and agree -to be bound by the terms and conditions of this Creative Commons -Attribution 4.0 International Public License ("Public License"). To the -extent this Public License may be interpreted as a contract, You are -granted the Licensed Rights in consideration of Your acceptance of -these terms and conditions, and the Licensor grants You such rights in -consideration of benefits the Licensor receives from making the -Licensed Material available under these terms and conditions. - -Section 1 -- Definitions. - - a. Adapted Material means material subject to Copyright and Similar - Rights that is derived from or based upon the Licensed Material - and in which the Licensed Material is translated, altered, - arranged, transformed, or otherwise modified in a manner requiring - permission under the Copyright and Similar Rights held by the - Licensor. For purposes of this Public License, where the Licensed - Material is a musical work, performance, or sound recording, - Adapted Material is always produced where the Licensed Material is - synched in timed relation with a moving image. - - b. Adapter's License means the license You apply to Your Copyright - and Similar Rights in Your contributions to Adapted Material in - accordance with the terms and conditions of this Public License. - - c. Copyright and Similar Rights means copyright and/or similar rights - closely related to copyright including, without limitation, - performance, broadcast, sound recording, and Sui Generis Database - Rights, without regard to how the rights are labeled or - categorized. For purposes of this Public License, the rights - specified in Section 2(b)(1)-(2) are not Copyright and Similar - Rights. - - d. Effective Technological Measures means those measures that, in the - absence of proper authority, may not be circumvented under laws - fulfilling obligations under Article 11 of the WIPO Copyright - Treaty adopted on December 20, 1996, and/or similar international - agreements. - - e. Exceptions and Limitations means fair use, fair dealing, and/or - any other exception or limitation to Copyright and Similar Rights - that applies to Your use of the Licensed Material. - - f. Licensed Material means the artistic or literary work, database, - or other material to which the Licensor applied this Public - License. - - g. Licensed Rights means the rights granted to You subject to the - terms and conditions of this Public License, which are limited to - all Copyright and Similar Rights that apply to Your use of the - Licensed Material and that the Licensor has authority to license. - - h. Licensor means the individual(s) or entity(ies) granting rights - under this Public License. - - i. Share means to provide material to the public by any means or - process that requires permission under the Licensed Rights, such - as reproduction, public display, public performance, distribution, - dissemination, communication, or importation, and to make material - available to the public including in ways that members of the - public may access the material from a place and at a time - individually chosen by them. - - j. Sui Generis Database Rights means rights other than copyright - resulting from Directive 96/9/EC of the European Parliament and of - the Council of 11 March 1996 on the legal protection of databases, - as amended and/or succeeded, as well as other essentially - equivalent rights anywhere in the world. - - k. You means the individual or entity exercising the Licensed Rights - under this Public License. Your has a corresponding meaning. - -Section 2 -- Scope. - - a. License grant. - - 1. Subject to the terms and conditions of this Public License, - the Licensor hereby grants You a worldwide, royalty-free, - non-sublicensable, non-exclusive, irrevocable license to - exercise the Licensed Rights in the Licensed Material to: - - a. reproduce and Share the Licensed Material, in whole or - in part; and - - b. produce, reproduce, and Share Adapted Material. - - 2. Exceptions and Limitations. For the avoidance of doubt, where - Exceptions and Limitations apply to Your use, this Public - License does not apply, and You do not need to comply with - its terms and conditions. - - 3. Term. The term of this Public License is specified in Section - 6(a). - - 4. Media and formats; technical modifications allowed. The - Licensor authorizes You to exercise the Licensed Rights in - all media and formats whether now known or hereafter created, - and to make technical modifications necessary to do so. The - Licensor waives and/or agrees not to assert any right or - authority to forbid You from making technical modifications - necessary to exercise the Licensed Rights, including - technical modifications necessary to circumvent Effective - Technological Measures. For purposes of this Public License, - simply making modifications authorized by this Section 2(a) - (4) never produces Adapted Material. - - 5. Downstream recipients. - - a. Offer from the Licensor -- Licensed Material. Every - recipient of the Licensed Material automatically - receives an offer from the Licensor to exercise the - Licensed Rights under the terms and conditions of this - Public License. - - b. No downstream restrictions. You may not offer or impose - any additional or different terms or conditions on, or - apply any Effective Technological Measures to, the - Licensed Material if doing so restricts exercise of the - Licensed Rights by any recipient of the Licensed - Material. - - 6. No endorsement. Nothing in this Public License constitutes or - may be construed as permission to assert or imply that You - are, or that Your use of the Licensed Material is, connected - with, or sponsored, endorsed, or granted official status by, - the Licensor or others designated to receive attribution as - provided in Section 3(a)(1)(A)(i). - - b. Other rights. - - 1. Moral rights, such as the right of integrity, are not - licensed under this Public License, nor are publicity, - privacy, and/or other similar personality rights; however, to - the extent possible, the Licensor waives and/or agrees not to - assert any such rights held by the Licensor to the limited - extent necessary to allow You to exercise the Licensed - Rights, but not otherwise. - - 2. Patent and trademark rights are not licensed under this - Public License. - - 3. To the extent possible, the Licensor waives any right to - collect royalties from You for the exercise of the Licensed - Rights, whether directly or through a collecting society - under any voluntary or waivable statutory or compulsory - licensing scheme. In all other cases the Licensor expressly - reserves any right to collect such royalties. - -Section 3 -- License Conditions. - -Your exercise of the Licensed Rights is expressly made subject to the -following conditions. - - a. Attribution. - - 1. If You Share the Licensed Material (including in modified - form), You must: - - a. retain the following if it is supplied by the Licensor - with the Licensed Material: - - i. identification of the creator(s) of the Licensed - Material and any others designated to receive - attribution, in any reasonable manner requested by - the Licensor (including by pseudonym if - designated); - - ii. a copyright notice; - - iii. a notice that refers to this Public License; - - iv. a notice that refers to the disclaimer of - warranties; - - v. a URI or hyperlink to the Licensed Material to the - extent reasonably practicable; - - b. indicate if You modified the Licensed Material and - retain an indication of any previous modifications; and - - c. indicate the Licensed Material is licensed under this - Public License, and include the text of, or the URI or - hyperlink to, this Public License. - - 2. You may satisfy the conditions in Section 3(a)(1) in any - reasonable manner based on the medium, means, and context in - which You Share the Licensed Material. For example, it may be - reasonable to satisfy the conditions by providing a URI or - hyperlink to a resource that includes the required - information. - - 3. If requested by the Licensor, You must remove any of the - information required by Section 3(a)(1)(A) to the extent - reasonably practicable. - - 4. If You Share Adapted Material You produce, the Adapter's - License You apply must not prevent recipients of the Adapted - Material from complying with this Public License. - -Section 4 -- Sui Generis Database Rights. - -Where the Licensed Rights include Sui Generis Database Rights that -apply to Your use of the Licensed Material: - - a. for the avoidance of doubt, Section 2(a)(1) grants You the right - to extract, reuse, reproduce, and Share all or a substantial - portion of the contents of the database; - - b. if You include all or a substantial portion of the database - contents in a database in which You have Sui Generis Database - Rights, then the database in which You have Sui Generis Database - Rights (but not its individual contents) is Adapted Material; and - - c. You must comply with the conditions in Section 3(a) if You Share - all or a substantial portion of the contents of the database. - -For the avoidance of doubt, this Section 4 supplements and does not -replace Your obligations under this Public License where the Licensed -Rights include other Copyright and Similar Rights. - -Section 5 -- Disclaimer of Warranties and Limitation of Liability. - - a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE - EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS - AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF - ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, - IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, - WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR - PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, - ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT - KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT - ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. - - b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE - TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, - NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, - INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, - COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR - USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN - ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR - DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR - IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. - - c. The disclaimer of warranties and limitation of liability provided - above shall be interpreted in a manner that, to the extent - possible, most closely approximates an absolute disclaimer and - waiver of all liability. - -Section 6 -- Term and Termination. - - a. This Public License applies for the term of the Copyright and - Similar Rights licensed here. However, if You fail to comply with - this Public License, then Your rights under this Public License - terminate automatically. - - b. Where Your right to use the Licensed Material has terminated under - Section 6(a), it reinstates: - - 1. automatically as of the date the violation is cured, provided - it is cured within 30 days of Your discovery of the - violation; or - - 2. upon express reinstatement by the Licensor. - - For the avoidance of doubt, this Section 6(b) does not affect any - right the Licensor may have to seek remedies for Your violations - of this Public License. - - c. For the avoidance of doubt, the Licensor may also offer the - Licensed Material under separate terms or conditions or stop - distributing the Licensed Material at any time; however, doing so - will not terminate this Public License. - - d. Sections 1, 5, 6, 7, and 8 survive termination of this Public - License. - -Section 7 -- Other Terms and Conditions. - - a. The Licensor shall not be bound by any additional or different - terms or conditions communicated by You unless expressly agreed. - - b. Any arrangements, understandings, or agreements regarding the - Licensed Material not stated herein are separate from and - independent of the terms and conditions of this Public License. - -Section 8 -- Interpretation. - - a. For the avoidance of doubt, this Public License does not, and - shall not be interpreted to, reduce, limit, restrict, or impose - conditions on any use of the Licensed Material that could lawfully - be made without permission under this Public License. - - b. To the extent possible, if any provision of this Public License is - deemed unenforceable, it shall be automatically reformed to the - minimum extent necessary to make it enforceable. If the provision - cannot be reformed, it shall be severed from this Public License - without affecting the enforceability of the remaining terms and - conditions. - - c. No term or condition of this Public License will be waived and no - failure to comply consented to unless expressly agreed to by the - Licensor. - - d. Nothing in this Public License constitutes or may be interpreted - as a limitation upon, or waiver of, any privileges and immunities - that apply to the Licensor or You, including from the legal - processes of any jurisdiction or authority. - -======================================================================= - -Creative Commons is not a party to its public -licenses. Notwithstanding, Creative Commons may elect to apply one of -its public licenses to material it publishes and in those instances -will be considered the β€œLicensor.” The text of the Creative Commons -public licenses is dedicated to the public domain under the CC0 Public -Domain Dedication. Except for the limited purpose of indicating that -material is shared under a Creative Commons public license or as -otherwise permitted by the Creative Commons policies published at -creativecommons.org/policies, Creative Commons does not authorize the -use of the trademark "Creative Commons" or any other trademark or logo -of Creative Commons without its prior written consent including, -without limitation, in connection with any unauthorized modifications -to any of its public licenses or any other arrangements, -understandings, or agreements concerning use of licensed material. For -the avoidance of doubt, this paragraph does not form part of the -public licenses. - -Creative Commons may be contacted at creativecommons.org. diff --git a/content/README.md b/content/README.md index 08eed6cc15..a493d1e2b0 100644 --- a/content/README.md +++ b/content/README.md @@ -2,12 +2,12 @@ The `/content` directory is where all the site's (English) Markdown content lives! -See the [markup reference guide](contribution/content-markup-reference.md) for more information about supported Markdown features. +See the [markup reference guide](contributing/content-markup-reference.md) for more information about supported Markdown features. -See the repository's top-level [README](../README.md) for general information about how the site works. +See the [contributing docs](contributing) for general information about working with the docs. - [Frontmatter](#frontmatter) - - [`productVersions`](#productversions) + - [`versions`](#versions) - [`redirect_from`](#redirect_from) - [`title`](#title) - [`shortTitle`](#shorttitle) @@ -38,48 +38,39 @@ The following frontmatter values have special meanings and requirements for this There's also a schema that's used by the test suite to validate every page's frontmatter. See [`lib/frontmatter.js`](../lib/frontmatter.js). -### `productVersions` +### `versions` -- Purpose: Indicates the products and product versions to which a page applies. +- Purpose: Indicates the [versions](../lib/all-versions.js) to which a page applies. See [Versioning](#versioning) for more info. -- Type: `Object`. Allowable keys map to product names and can be found in the `productVersions` object in [`lib/frontmatter.js`](../lib/frontmatter.js). +- Type: `Object`. Allowable keys map to product names and can be found in the `versions` object in [`lib/frontmatter.js`](../lib/frontmatter.js). - This frontmatter value is currently **required** for all pages. +- The `*` is used to denote all releases for the version. -Example that applies to GitHub.com and recent versions of GitHub Enterprise: +Example that applies to GitHub.com and recent versions of GitHub Enterprise Server: ```yml title: About your personal dashboard -productVersions: - dotcom: '*' - enterprise: '>=2.14' +versions: + free-pro-team: '*' + enterprise-server: '>=2.20' ``` -Example that applies to all supported versions of GitHub enterprise +Example that applies to all supported versions of GitHub Enterprise Server: (but not GitHub.com): ```yml title: Downloading your license -productVersions: - enterprise: '*' +versions: + enterprise-server: '*' ``` -Example that applies to GitHub Actions: - -```yml -title: Building actions -productVersions: - actions: '*' -``` - -Note: Every product except `enterprise` is an evergreen product without specific versions, so the `*` is used to denote all versions. - ### `redirect_from` - Purpose: List URLs that should redirect to this page. -- Type: `Array` (for multiple redirects) or `String` (for just one) +- Type: `Array` - Optional -Example with multiple redirects: +Example: ```yml title: Getting started with GitHub Desktop @@ -89,14 +80,7 @@ redirect_from: - /articles/getting-started-with-github-for-windows/ ``` -Example with a single redirect: - -```yml -title: Denying access to a previously approved OAuth App for your organization -redirect_from: /articles/denying-access-to-a-previously-approved-application-for-your-organization/ -``` - -See [README#redirects](../README.md#redirects) for more info. +See [`contributing/redirects`](contributing/redirects.md) for more info. ### `title` @@ -108,7 +92,7 @@ See [README#redirects](../README.md#redirects) for more info. - Purpose: An abbreviated variant of the page title for use in breadcrumbs. - Type: `String` -- Optional. If omitted, `title` will be used. Used only for map topic and category pages. +- Optional. If omitted, `title` will be used. Example: @@ -163,7 +147,7 @@ For a layout named `layouts/article.html`, the value would be `article`. ### `miniTocMaxHeadingLevel` - Purpose: Indicates the maximum heading level to include in an article's mini TOC. See [Autogenerated mini TOCs](#autogenerated-mini-tocs) for more info. -- Type: `Number`. Default is `3`. Minimum is `2`. Maximum is `4` for now. (If we need to add more levels, we can revisit this. We will need to add CSS to do deeper nesting.) +- Type: `Number`. Default is `3`. Minimum is `2`. Maximum is `4`. - Optional. ### `allowTitleToDifferFromFilename` @@ -193,56 +177,16 @@ Make sure not to add hardcoded "In this article" sections in the Markdown source ## Versioning -Versioning for any content file lives in **two** places: +A content file can have **two** types of versioning: -* The file's [`productVersions`](#productversions) frontmatter. -* Liquid conditionals in the file's parent [index page](#index-pages). - -For example, an article with this frontmatter: - -```yml -title: About your personal dashboard -productVersions: - dotcom: '*' - enterprise: '>=2.14' -``` - -should be referenced in the parent index page like this: - -``` -{%- if page.version == 'dotcom' or page.version ver_gt "2.13" %} -- About your personal dashboard -{%- endif %} -``` +* [`versions`](#versions) frontmatter (**required**) + * Determines in which the versions the page is available. See [contributing/permalinks](../contributing/permalinks.md) for more info. +* Liquid statements in content (**optional**) + * Conditionally render content depending on the current version being viewed. See [contributing/liquid-helpers](../contributing/liquid-helpers.md) for more info. Note Liquid conditionals can also appear in `data` and `include` files. ## Filenames -The site automatically creates links to articles in index pages. For example, this block in `content/index.md`: - -``` -## Bootcamp - -- Set up git -- Create a repo -- Fork a repo -- Be social -``` - -renders with links to each article. - -If you're adding a new article, make sure the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the title you use in both the article and the parent index. This can get tricky when a title has punctuation (such as "GitHub's Billing Plans"). If you're not sure what the filename should be based on the title, you can find out by adding the title to the TOC. For example: - -``` -## Bootcamp - -- Set up git -- Create a repo -- Fork a repo -- Be social -- I'm a new article -``` - -Then just run the site locally and see what the link is. In this example, the filename would be: `im-a-new-article` +When adding a new article, make sure the filename is a [kebab-cased](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles) version of the title you use in the article's [`title`](#title) frontmatter. This can get tricky when a title has punctuation (such as "GitHub's Billing Plans"). A test will flag any discrepancies between title and filename. To override this requirement for a given article, you can add [`allowTitleToDifferFromFilename`](#allowtitletodifferfromfilename) frontmatter. ## Whitespace control @@ -258,31 +202,31 @@ These characters are especially important in [index pages](#index-pages) compris ## Links and image paths -Any local links (like those starting with `/articles/`) and image paths (starting with `/assets`) that you include in content and data files will undergo some transformations on the server side to match the current page's language and Enterprise version (if applicable). The handling for these transformations lives in [`lib/rewrite-local-links`](lib/rewrite-local-links.js) and [`lib/rewrite-asset-paths-to-s3`](lib/rewrite-asset-paths-to-s3.js). +Local links must start with a product ID (like `/actions` or `/admin`), and image paths must start with `/assets`. These links undergo some transformations on the server side to match the current page's language and version. The handling for these transformations lives in [`lib/rewrite-local-links`](lib/rewrite-local-links.js) and [`lib/rewrite-asset-paths-to-s3`](lib/rewrite-asset-paths-to-s3.js). For example, if you include the following link in a content file: ``` -/articles/creating-a-saved-reply +/github/writing-on-github/creating-a-saved-reply ``` -When viewed on Dotcom, the link gets rendered with the language code: +When viewed on GitHub.com docs, the link gets rendered with the language code and version: ``` -/en/articles/creating-a-saved-reply +/en/free-pro-team@latest/github/writing-on-github/creating-a-saved-reply ``` -and when viewed on GHE, the version is included as well: +and when viewed on GitHub Enterprise Server docs, the version is included as well: ``` -/en/enterprise/2.16/user/articles/creating-a-saved-reply +/en/enterprise-server@2.20/github/writing-on-github/creating-a-saved-reply ``` -The transformation is a little simpler for image paths. If you include the following image path in a content file: +The transformation is a little different for image paths. If you include the following image path in a content file: ``` /assets/images/help/profile/follow-user-button.png ``` -when viewed on GHE, the path gets rewritten to include S3: +when viewed on GitHub Enterprise Server docs, the path gets rewritten to include S3: ``` -https://github-images.s3.amazonaws.com/enterprise/2.16/assets/images/help/profile/follow-user-button.png +https://github-images.s3.amazonaws.com/enterprise/2.20/assets/images/help/profile/follow-user-button.png ``` ### Preventing transformations @@ -290,7 +234,7 @@ https://github-images.s3.amazonaws.com/enterprise/2.16/assets/images/help/profil Sometimes you want to link to a Dotcom-only article in Enterprise content and you don't want the link to be Enterprise-ified. To prevent the transformation, write the link using HTML and add a class of `dotcom-only`. For example: ``` -GitHub's Terms of Service +GitHub's Terms of Service ``` -Sometimes the canonical home of content moves outside the help site. None of the links included in [`lib/external-redirects.json`](lib/external-redirects.json) get rewritten. See the top-level [README](../README.md#external-redirects) for more info about this type of redirect. \ No newline at end of file +Sometimes the canonical home of content moves outside the docs site. None of the links included in [`lib/redirects/external-redirects.json`](lib/redirects/external-redirects.json) get rewritten. See [`contributing/redirects.md`](contributing/redirects.md) for more info about this type of redirect. diff --git a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md index 167b74d4aa..d7c662b90d 100644 --- a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md @@ -33,7 +33,7 @@ For more information, see "[Core concepts for {% data variables.product.prodname Jenkins lets you send builds to a single build agent, or you can distribute them across multiple agents. You can also classify these agents according to various attributes, such as operating system types. -Similiarly, {% data variables.product.prodname_actions %} can send jobs to {% data variables.product.prodname_dotcom %}-hosted or self-hosted runners, and you can use labels to classify runners according to various attributes. The following table compares how the distributed build concept is implemented for both Jenkins and {% data variables.product.prodname_actions %}. +Similarly, {% data variables.product.prodname_actions %} can send jobs to {% data variables.product.prodname_dotcom %}-hosted or self-hosted runners, and you can use labels to classify runners according to various attributes. The following table compares how the distributed build concept is implemented for both Jenkins and {% data variables.product.prodname_actions %}. | Jenkins | {% data variables.product.prodname_actions %} | | ------------- | ------------- | @@ -41,7 +41,7 @@ Similiarly, {% data variables.product.prodname_actions %} can send jobs to {% da #### Using sections to organize pipelines -Jenkins splits its Declarative Pipelines into multiple sections. Similiarly, {% data variables.product.prodname_actions %} organizes its workflows into separate sections. The table below compares Jenkins sections with the {% data variables.product.prodname_actions %} workflow. +Jenkins splits its Declarative Pipelines into multiple sections. Similarly, {% data variables.product.prodname_actions %} organizes its workflows into separate sections. The table below compares Jenkins sections with the {% data variables.product.prodname_actions %} workflow. |Jenkins Directives | {% data variables.product.prodname_actions %} | | ------------- | ------------- | diff --git a/content/actions/reference/environment-variables.md b/content/actions/reference/environment-variables.md index 4ace66924b..c8acb6a91c 100644 --- a/content/actions/reference/environment-variables.md +++ b/content/actions/reference/environment-variables.md @@ -49,7 +49,7 @@ We strongly recommend that actions use environment variables to access the files | `GITHUB_REPOSITORY` | The owner and repository name. For example, `octocat/Hello-World`. | | `GITHUB_EVENT_NAME` | The name of the webhook event that triggered the workflow. | | `GITHUB_EVENT_PATH` | The path of the file with the complete webhook event payload. For example, `/github/workflow/event.json`. | -| `GITHUB_WORKSPACE` | The {% data variables.product.prodname_dotcom %} workspace directory path. The workspace directory contains a subdirectory with a copy of your repository if your workflow uses the [actions/checkout](https://github.com/actions/checkout) action. If you don't use the `actions/checkout` action, the directory will be empty. For example, `/home/runner/work/my-repo-name/my-repo-name`. | +| `GITHUB_WORKSPACE` | The {% data variables.product.prodname_dotcom %} workspace directory path. The workspace directory is a copy of your repository if your workflow uses the [actions/checkout](https://github.com/actions/checkout) action. If you don't use the `actions/checkout` action, the directory will be empty. For example, `/home/runner/work/my-repo-name/my-repo-name`. | | `GITHUB_SHA` | The commit SHA that triggered the workflow. For example, `ffac537e6cbbf934b08745a378932722df287a53`. | | `GITHUB_REF` | The branch or tag ref that triggered the workflow. For example, `refs/heads/feature-branch-1`. If neither a branch or tag is available for the event type, the variable will not exist. | | `GITHUB_HEAD_REF` | Only set for forked repositories. The branch of the head repository. diff --git a/content/github/administering-a-repository/changing-the-default-branch.md b/content/github/administering-a-repository/changing-the-default-branch.md index ad377044d7..7e1a1c1135 100644 --- a/content/github/administering-a-repository/changing-the-default-branch.md +++ b/content/github/administering-a-repository/changing-the-default-branch.md @@ -16,7 +16,7 @@ You can choose the default branch for a repository. The default branch is the ba {% note %} -**Note**: If you use the Git-Subversion bridge, setting a different default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients)" and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation. +**Note**: If you use the Git-Subversion bridge, changing the default branch will affect your `trunk` branch contents and the `HEAD` you see when you list references for the remote repository. For more information, see "[Support for Subversion clients](/github/importing-your-projects-to-github/support-for-subversion-clients)" and [git-ls-remote](https://git-scm.com/docs/git-ls-remote.html) in the Git documentation. {% endnote %} @@ -51,8 +51,8 @@ To change the default branch, your repository must have more than one branch. Fo {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.repository-branches %} -4. In the default branch drop-down, choose the new default branch. +1. In the default branch drop-down, choose the new default branch. ![Default branch dropdown selector](/assets/images/help/repository/repository-options-defaultbranch.png) -5. Click **Update**. +1. Click **Update**. {% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md index 3e78220ab3..9e87c1f42c 100644 --- a/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md +++ b/content/github/creating-cloning-and-archiving-repositories/about-archiving-repositories.md @@ -20,7 +20,7 @@ versions: Once a repository is archived, you cannot add or remove collaborators or teams. Contributors with access to the repository can only fork or star your project. -When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, and comments become read-only. To make changes in an archived repository, you must unarchive the repository first. +When a repository is archived, its issues, pull requests, code, labels, milestones, projects, wiki, releases, commits, tags, branches, reactions, code scanning alerts, and comments become read-only. To make changes in an archived repository, you must unarchive the repository first. You can search for archived repositories. For more information, see "[Searching for repositories](/articles/searching-for-repositories/#search-based-on-whether-a-repository-is-archived)." You can also search for issues and pull requests within archived repositories. For more information, see "[Searching issues and pull requests](/articles/searching-issues-and-pull-requests/#search-based-on-whether-a-repository-is-archived)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system.md index 7f75a79ad2..ca6cebabd9 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-code-scanning-in-your-ci-system.md @@ -39,9 +39,18 @@ chmod +x codeql-runner-macos sudo xattr -d com.apple.quarantine codeql-runner-macos ``` +On Windows, the `codeql-runner-win.exe` file usually requires no change to permissions. + ### Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -Once you have downloaded the {% data variables.product.prodname_codeql_runner %} and verified that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. In addition to this, each CI server also needs: +Once you have downloaded the {% data variables.product.prodname_codeql_runner %} and verified that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. It is important to notice that each CI server that you intend to use for {% data variables.product.prodname_code_scanning %} needs to have the {% data variables.product.prodname_codeql_runner %}. You might configure each server to copy the runner from a central, internal location, or you could use the REST API to get the runner direct from GitHub, for example: + +```shell +wget https://github.com/github/codeql-action/releases/download/codeql-bundle-20200826/codeql-runner-linux +chmod +x codeql-runner-linux +``` + +In addition to this, each CI server also needs: - A {% data variables.product.prodname_github_apps %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. For private repositories the token must have the `repo` scope. For public the token needs only the `public_repo` and `repo:security_events` scopes. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." - Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains the {% data variables.product.prodname_codeql %} CLI, queries, and libraries needed for {% data variables.product.prodname_codeql %} analysis. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://help.semmle.com/codeql/codeql-cli.html)." diff --git a/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md b/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md index 0678a9c924..dcf5a01db9 100644 --- a/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md +++ b/content/github/managing-your-work-on-github/applying-labels-to-issues-and-pull-requests.md @@ -11,15 +11,16 @@ versions: {% tip %} -**Tip:** You can also apply a label in the Labels drop-down menu within an issue or pull request. +**Tip:** You can apply up to a maximum of 100 labels to issues and pull requests. {% endtip %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-issue-pr %} {% data reusables.repositories.select-items-in-issue-or-pr-list %} -4. In the upper-right corner, click **Label**, then start typing the name of an existing label. Click the label's name to associate it with the selected items. +4. In the upper-right corner, click **Label**, then start typing the name of an existing label. Click the label's name to associate it with the selected items. You can also apply a label in the Labels drop-down menu within an issue or pull request. ![Issues Milestone assignment drop-down](/assets/images/help/issues/issues_applying_labels_dropdown.png) + ### Further reading diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md index edacc586e6..112d33ca4e 100644 --- a/content/rest/reference/permissions-required-for-github-apps.md +++ b/content/rest/reference/permissions-required-for-github-apps.md @@ -168,7 +168,6 @@ _Search_ {% if currentVersion == "free-pro-team@latest" %} - [`DELETE /repos/:owner/:repo/vulnerability-alerts`](/v3/repos/#disable-vulnerability-alerts) (:write) {% endif %} -- [`POST /user/repos`](/v3/repos/#create-a-repository-for-the-authenticated-user) (:write) - [`PATCH /user/repository_invitations/:invitation_id`](/v3/repos/invitations/#accept-a-repository-invitation) (:write) - [`DELETE /user/repository_invitations/:invitation_id`](/v3/repos/invitations/#decline-a-repository-invitation) (:write) diff --git a/contributing/development.md b/contributing/development.md index 70dc76ca65..000c3dfcec 100644 --- a/contributing/development.md +++ b/contributing/development.md @@ -8,7 +8,7 @@ This site is powered by Node.js! :sparkles: :turtle: :rocket: :sparkles: It runs on macOS, Windows, and Linux environments. -You'll need **Node.js v12** to run the site. If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) below for instructions on switching to Node.js 12. If you're not using `nodenv`, the best way to install Node.js is to [download the LTS installer from nodejs.org](https://nodejs.org). +You'll need **Node.js v14** to run the site. If you're using [`nodenv`](https://github.com/nodenv/nodenv), read the [`nodenv` docs](#nodenv) for instructions on switching Node.js versions. If you're not using `nodenv`, the best way to install Node.js is to [download the LTS installer from nodejs.org](https://nodejs.org). Once you've installed Node.js (which includes the popular `npm` package manager), open Terminal and run the following: @@ -52,26 +52,4 @@ For more info about working with this site, check out these READMEs: - [middleware/README.md](../middleware/README.md) - [script/README.md](../script/README.md) - [stylesheets/README.md](../stylesheets/README.md) -- [tests/README.md](../tests/README.md) - -## `nodenv` - -[nodenv](https://github.com/nodenv/nodenv) is a tool for managing multiple Node.js versions on your local machine. It is **not required** to run this app, but you may already have it installed if you've worked on other projects that use Node.js. - -To install Node.js 12 and make it your default version, run this command: - -```sh -nodenv install 12.8.0 && nodenv global 12.8.0 -``` - -You may sometimes see a warning when running npm scripts with nodenv: - -```sh -npm WARN lifecycle The node binary used for scripts is [...] but npm is using [...] -``` - -This is due to nodenv's overriding behavior. To silence this harmless warning, the [nodenv docs](https://github.com/nodenv/nodenv/wiki/FAQ#npm-warning-about-mismatched-binaries) recommend running the following command from any directory: - -```sh -npm config set scripts-prepend-node-path auto -``` +- [tests/README.md](../tests/README.md) \ No newline at end of file diff --git a/contributing/liquid-helpers.md b/contributing/liquid-helpers.md index 404f7593d5..df19388b06 100644 --- a/contributing/liquid-helpers.md +++ b/contributing/liquid-helpers.md @@ -45,13 +45,13 @@ Note: The below examples are only intended to show Liquid syntax and operators. In statements where **all** operands must be true for the condition to be true, use the operator `and`: ``` -{% if page.version != "dotcom" and page.version ver_gt "2.6" %} +{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %} ``` In statements where **at least one** operand must be true for the condition to be true, use the operator `or`: ``` -{% if page.version == "dotcom" or page.version ver_gt "2.6" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} ``` Do **not** use the operators `&&` or `||`. If you do, the content will not render in the intended versions. Only use `and` or `or`. @@ -74,11 +74,11 @@ If your content is included in all versions of Enterprise, you need not include If your content only applies to GitHub.com, such as billing information, use this logic: ``` -{% if page.version == "dotcom" %}This is how you pay for your personal account, which is something you wouldn't do in Enterprise.{% endif %} +{% if currentVersion == "free-pro-team@latest" %}This is how you pay for your personal account, which is something you wouldn't do in Enterprise.{% endif %} ``` In this example: -- `if page.version == "dotcom"` will include the content for Dotcom output and *only* Dotcom. +- `if currentVersion == "free-pro-team@latest"` will include the content for Dotcom output and *only* Dotcom. - `{% endif %}` ends the statement. #### Including content for *new Dotcom features* that will be included in Enterprise @@ -86,13 +86,13 @@ In this example: If your content is describing a new feature that was added to GitHub.com and will be automatically included in the next release of GitHub Enterprise, use this logic: ``` -{% if page.version == "dotcom" or page.version ver_gt "2.6" %}This is a brand new feature, the likes of which have never been seen at this company before!{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}This is a brand new feature, the likes of which have never been seen at this company before!{% endif %} ``` In this example: -- `if page.version == "dotcom"` will include the content for GitHub.com output. -- `or page.version ver_gt "2.6"` will include the content for releases *after* Enterprise 2.6, which means the content will be included for 2.7+. +- `if currentVersion == "free-pro-team@latest"` will include the content for GitHub.com output. +- `or currentVersion ver_gt "enterprise-server@2.21"` will include the content for releases *after* Enterprise 2.21, which means the content will be included for 2.7+. - `{% endif %}` ends the statement. #### Including content for *changed* Dotcom features that will also change in Enterprise @@ -100,13 +100,13 @@ In this example: If your content is describing a change to existing functionality in Dotcom, such as changed UI text or a more simple means of completing a task, use this logic: ``` -{% if page.version == "dotcom" or page.version ver_gt "2.10" %}This is the new way of doing things {% else %}This is the old way of doing things {% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "2.20" %}This is the new way of doing things {% else %}This is the old way of doing things {% endif %} ``` In this example: -- `if page.version == "dotcom"` will include the content for GitHub.com output. -- `or page.version ver_gt "2.6"` will include the content for releases *after* Enterprise 2.6, which means the content will be included for 2.7+. +- `if currentVersion == "free-pro-team@latest"` will include the content for GitHub.com output. +- `or currentVersion ver_gt "enterprise-server@2.21"` will include the content for releases *after* Enterprise 2.21, which means the content will be included for 2.22+. - `{% else %}` means if the above is NOT true, then display the content that follows, `This is the old way of doing things`. - `{% endif %}` ends the statement. @@ -115,22 +115,23 @@ In this example: If your content is describing a change to existing functionality in Dotcom, and that functionality doesn't exist in all older Enterprise versions, use logic like this: ``` -{% if page.version == 'dotcom' or page.version ver_gt "2.10" %} +{% if currentVersion == 'dotcom' or currentVersion ver_gt "2.20" %} This is the new way of doing things. -{% elsif page.version ver_gt "2.8" and page.version ver_lt "2.11" %} +{% endif %} +{% if currentVersion ver_gt "enterprise-server@2.19" and currentVersion ver_lt "2.21" %} -This is the old way of doing things (which did not exist before 2.9). +This is the old way of doing things (which did not exist before 2.20). {% endif %} ``` In this example: -- `if page.version == "dotcom"` will include the content for GitHub.com output. -- `or page.version ver_gt "2.10"` will include the content for releases *after* Enterprise 2.10, which means the content will be included for 2.11+. -- `elsif page.version ver_gt "2.8" and page.version ver_lt "2.11"` means if the above is NOT true, and the version is either 2.9 or 2.10, then display the content that follows, `This is the old way of doing things`. No content will be displayed for versions older than 2.9. +- `if currentVersion == "free-pro-team@latest"` will include the content for GitHub.com output. +- `or currentVersion ver_gt "2.20"` will include the content for releases *after* Enterprise 2.20, which means the content will be included for 2.21+. +- `elsif currentVersion ver_gt "enterprise-server@2.19" and currentVersion ver_lt "2.21"` means if the above is NOT true, and the version is 2.20, then display the content that follows, `This is the old way of doing things`. No content will be displayed for versions older than 2.20. - `{% endif %}` ends the statement. #### Including content for *new Enterprise features* that don't exist on Dotcom @@ -138,13 +139,13 @@ In this example: If your content is describing a new feature that was added to GitHub Enterprise but not GitHub, such as LDAP support, use this logic: ``` -{% if page.version != "dotcom" and page.version ver_gt "2.6" %}This is a brand new feature, admin-type people!{% endif %} +{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}This is a brand new feature, admin-type people!{% endif %} ``` In this example: -- `if page.version != "dotcom"` will exclude the content for GitHub.com output. -- `and page.version ver_gt "2.6"` will *additionally* include the content for releases *after* Enterprise 2.6, which means the content will be included for 2.7+. +- `if currentVersion != "free-pro-team@latest"` will exclude the content for GitHub.com output. +- `and currentVersion ver_gt "enterprise-server@2.21"` will *additionally* include the content for releases *after* Enterprise 2.21, which means the content will be included for 2.22+. - `{% endif %}` ends the statement. #### Including content for *changed Enterprise features* that don't exist on Dotcom @@ -152,12 +153,12 @@ In this example: If your content is describing a change to existing functionality in GitHub Enterprise, such as changed UI text or a more simple means of completing a task in the Management Console, use this logic: ``` -{% if page.version != "dotcom" and page.version ver_gt "2.6" %}This is the new way of doing things, admins! {% else %}This is the old way of doing things, admins! {% endif %} +{% if currentVersion != "free-pro-team@latest" and currentVersion ver_gt "enterprise-server@2.21" %}This is the new way of doing things, admins! {% else %}This is the old way of doing things, admins! {% endif %} ``` In this example: -- `if page.version != "dotcom"` will exclude the content for GitHub.com output. -- `and page.version ver_gt "2.6"` will *additionally* include the content for releases *after* Enterprise 2.6, which means the content will be included for 2.7+. +- `if currentVersion != "free-pro-team@latest"` will exclude the content for GitHub.com output. +- `and currentVersion ver_gt "enterprise-server@2.21"` will *additionally* include the content for releases *after* Enterprise 2.21, which means the content will be included for 2.22+. - `{% else %}` means if the above is NOT true, then display the content that follows, `This is the old way of doing things, admins!`. - `{% endif %}` ends the statement. diff --git a/contributing/node-versions.md b/contributing/node-versions.md index 4c44e4dd4a..60c42b86f1 100644 --- a/contributing/node-versions.md +++ b/contributing/node-versions.md @@ -1,26 +1,32 @@ -## Node Versions +# Node Versions -The site currently runs on Node.js v12, the [Active LTS version](https://nodejs.org/en/about/releases/) that will be supported until 2020-10-20. +The site currently runs on Node.js v14, the [Active LTS version](https://nodejs.org/en/about/releases/) from 2020-10-27 to 2021-10-26. When updating to a new Node.js version, consider the following files: -- The `engines.node` entry in `package.json` -- The `.node-version` file used by [nodenv](https://github.com/nodenv/nodenv), a tool for managing multiple Node.js versions on your machine. -- The `.github/*.workflow` Actions files -- The `Dockerfile` that can be used for deployments -- This README! +- [ ] The `engines.node` entry in `package.json` +- [ ] The `.node-version` file used by [nodenv](https://github.com/nodenv/nodenv), a tool for managing multiple Node.js versions on your machine. +- [ ] The `.github/*.workflow` Actions files +- [ ] The `Dockerfile` that can be used for deployments +- [ ] The `contributing/development.md` guide +- [ ] The `contributing/node-versions.md` file -### `nodenv` +## `nodenv` -[nodenv](https://github.com/nodenv/nodenv) is a tool for managing multiple -Node.js versions on your local machine. It is **not required** to run the -docs-internal app, but you may already have it installed if you've worked on other -internal GitHub projects that use Node.js. +[nodenv](https://github.com/nodenv/nodenv) is a tool for managing multiple Node.js versions on your local machine. It is **not required** to run this app, but you may already have it installed if you've worked on other projects that use Node.js. -To install Node.js 12 and make it your default version, run this command: +If you're using macOS, run this command to get the latest: + +``` +brew upgrade nodenv node-build +``` + +If you're using another operating system, or did not use Homebrew to install nodenv, see these [upgrade instructions](https://github.com/nodenv/nodenv#installation). + +To install Node.js 14 and make it your default version, run this command: ```sh -nodenv install 12.8.0 && nodenv global 12.8.0 +nodenv install 14.13.0 && nodenv global 14.13.0 ``` You may sometimes see a warning when running npm scripts with nodenv: @@ -29,10 +35,8 @@ You may sometimes see a warning when running npm scripts with nodenv: npm WARN lifecycle The node binary used for scripts is [...] but npm is using [...] ``` -This is due to nodenv's overriding behavior. To silence this harmless warning, -the [nodenv docs](https://github.com/nodenv/nodenv/wiki/FAQ#npm-warning-about-mismatched-binaries) -recommend running the following command from any directory: +This is due to nodenv's overriding behavior. To silence this harmless warning, the [nodenv docs](https://github.com/nodenv/nodenv/wiki/FAQ#npm-warning-about-mismatched-binaries) recommend running the following command from any directory: ```sh npm config set scripts-prepend-node-path auto -``` \ No newline at end of file +``` diff --git a/contributing/permalinks.md b/contributing/permalinks.md index 9e91eb8fc0..07615c4938 100644 --- a/contributing/permalinks.md +++ b/contributing/permalinks.md @@ -1,15 +1,15 @@ # Permalinks -Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`productVersions` frontmatter](content#productversions). +Because the site is dynamic, it does not build HTML files for each different version of an article. Instead it generates a "permalink" for every version of the article. It does this based on the article's [`versions` frontmatter](content#versions). -For example, an article that is available in Dotcom and all Enterprise versions will have permalinks like the following: +For example, an article that is available in currently supported versions will have permalink URLs like the following: -* `/en/articles/set-up-git` -* `/en/enterprise/2.16/user/articles/set-up-git` -* `/en/enterprise/2.15/user/articles/set-up-git` -* `/en/enterprise/2.14/user/articles/set-up-git` -* `/en/enterprise/2.13/user/articles/set-up-git` +* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git` +* `/en/enterprise-server@2.22/github/getting-started-with-github/set-up-git` +* `/en/enterprise-server@2.21/github/getting-started-with-github/set-up-git` +* `/en/enterprise-server@2.20/github/getting-started-with-github/set-up-git` +* `/en/enterprise-server@2.19/github/getting-started-with-github/set-up-git` -An article that is only available in Dotcom will have just one permalink: +An article that is not available in Enterprise will have just one permalink: -* `/en/articles/githubs-billing-plans` +* `/en/free-pro-team@latest/github/getting-started-with-github/set-up-git` diff --git a/contributing/redirects.md b/contributing/redirects.md index e74839e1e4..14597b5a67 100644 --- a/contributing/redirects.md +++ b/contributing/redirects.md @@ -8,22 +8,12 @@ Sometimes we change the name of an article but want its old URL to redirect to i ## External redirects -Sometimes the canonical home of some content moves outside the help site. For these types of redirects, we add entries to [/lib/external-redirects.json](/lib/external-redirects.json). +Sometimes the canonical home of some content moves outside the help site. For these types of redirects, we add entries to [/lib/redirects/external-redirects.json](/lib/redirects/external-redirects.json). ## Custom redirects -We also have custom routing code that dynamically handles things like moved [hidden pages](/content#hidden-pages) or deprecated products like GitHub Desktop Classic. This code lives in [/middleware/redirects.js](/middleware/redirects.js). +We also have custom routing code that automatically creates redirects under the hood for things like moved Admin guide pages. This code lives in [/lib/redirects/get-old-paths-from-permalink.js](/lib/redirects/get-old-paths-from-permalink.js). All redirects for the site are compiled when the server starts by [/lib/redirects/precompile.js](/lib/redirects/precompile.js). -## Autogenerated redirects +See [Links and image paths](content/README.md#links-and-image-paths) for info on how links and images are rewritten on the fly at page render time. -The site automatically generates a number of redirects under the hood: - -| Redirect from | Redirect to | Example -| -- | -- | -- | -| Path without a language prefix | Path with an English prefix | `https://help.github.com/articles/set-up-git` to `https://help.github.com/en/articles/set-up-git` -| Redirect without a language code | Path with an English prefix | `https://help.github.com/mac-set-up-git` to `https://help.github.com/en/articles/set-up-git/` -| Enterprise path without a version | Path with the latest version | `https://help.github.com/enterprise` to `https://help.github.com/en/enterprise/2.16` -| Enterprise path that includes `/guides/` | Path without `/guides/` | `https://help.github.com/enterprise/admin/guides/installation` to `https://help.github.com/en/enterprise/2.16/admin/installation` -| Desktop path that includes `/guides/` | Path without `/guides/` | `https://help.github.com/desktop/guides/contributing-to-projects` to `https://help.github.com/en/desktop/contributing-to-projects` - -See [Debugging](contribution/debugging.md) for info on viewing the redirects for any page. +See [Troubleshooting](contribution/troubleshooting.md#debugging-locally) for info on viewing the redirects for any page. diff --git a/includes/article.html b/includes/article.html index 77213265c7..8719e347a9 100644 --- a/includes/article.html +++ b/includes/article.html @@ -58,10 +58,7 @@
{% assign helpId = 'xl' %} {% include helpfulness %} - {% comment %} - - {% include contribution %} - {% endcomment %} + {% include contribution %}
@@ -76,9 +73,6 @@
{% assign helpId = 'sm' %} {% include helpfulness %} - {% comment %} - - {% include contribution %} - {% endcomment %} + {% include contribution %}
diff --git a/includes/support.html b/includes/support.html index 85040ec8bf..b782f5ec36 100644 --- a/includes/support.html +++ b/includes/support.html @@ -1,15 +1,15 @@
-

+

{% data ui.support.still_need_help %}

{% if currentVersion contains 'enterprise' %}{% assign isEnterprise = true %}{% else %}{% assign isEnterprise = false %}{% endif %} - + {% octicon "people" width="16" %} {% data ui.support.ask_community %} - + {% octicon "comment-discussion" width="16" %} {% data ui.support.contact_support %} diff --git a/package-lock.json b/package-lock.json index 93cc942592..402075a1ce 100644 --- a/package-lock.json +++ b/package-lock.json @@ -4,9 +4,9 @@ "lockfileVersion": 1, "dependencies": { "@actions/core": { - "version": "1.2.4", - "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.4.tgz", - "integrity": "sha512-YJCEq8BE3CdN8+7HPZ/4DxJjk/OkZV2FFIf+DlZTC/4iBlzYCD5yjRR6eiOS5llO11zbRltIRuKAjMKaWTE6cg==", + "version": "1.2.6", + "resolved": "https://registry.npmjs.org/@actions/core/-/core-1.2.6.tgz", + "integrity": "sha512-ZQYitnqiyBc3D+k7LsgSBmMDVkOVidaagDG7j3fOym77jNunWRuYx7VSHa9GNfFZh+zh61xsCjRj4JxMZlDqTA==", "dev": true }, "@babel/code-frame": { @@ -1167,9 +1167,9 @@ "dev": true }, "@hapi/hoek": { - "version": "8.5.0", - "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-8.5.0.tgz", - "integrity": "sha512-7XYT10CZfPsH7j9F1Jmg1+d0ezOux2oM2GfArAzLwWe4mE2Dr3hVjsAL6+TFY49RRJlCdJDMw3nJsLFroTc8Kw==", + "version": "8.5.1", + "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-8.5.1.tgz", + "integrity": "sha512-yN7kbciD87WzLGc5539Tn0sApjyiGHAJgKvG9W8C7O+6c7qmoQMfVs0W4bX17eqz6C78QJqqFrtgdK5EWf6Qow==", "dev": true }, "@hapi/pinpoint": { @@ -7289,7 +7289,7 @@ }, "load-json-file": { "version": "2.0.0", - "resolved": "http://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz", + "resolved": "https://registry.npmjs.org/load-json-file/-/load-json-file-2.0.0.tgz", "integrity": "sha1-eUfkIUmvgNaWy/eXvKq8/h/inKg=", "dev": true, "requires": { @@ -9907,7 +9907,7 @@ "dependencies": { "mkdirp": { "version": "0.3.0", - "resolved": "http://registry.npmjs.org/mkdirp/-/mkdirp-0.3.0.tgz", + "resolved": "https://registry.npmjs.org/mkdirp/-/mkdirp-0.3.0.tgz", "integrity": "sha1-G79asbqCevI1dRQ0kEJkVfSB/h4=" }, "nopt": { diff --git a/package.json b/package.json index 57133d2f3f..d999e40465 100644 --- a/package.json +++ b/package.json @@ -7,6 +7,7 @@ "name": "GitHub", "url": "https://github.com/github/docs" }, + "license": "(MIT AND CC-BY-4.0)", "dependencies": { "@babel/core": "^7.8.3", "@babel/plugin-transform-runtime": "^7.11.0", @@ -140,7 +141,7 @@ "pa11y-test": "start-server-and-test browser-test-server 4001 pa11y-ci" }, "engines": { - "node": "8 - 12" + "node": "12 - 14" }, "repository": "https://github.com/github/docs", "standard": { diff --git a/script/README.md b/script/README.md index 9247ceacbe..c0127ee9bf 100644 --- a/script/README.md +++ b/script/README.md @@ -87,6 +87,27 @@ Run this script in your branch to check whether any images referenced in Enterpr --- +### [`content-migrations/extended-markdown-tags.js`](content-migrations/extended-markdown-tags.js) + + + +--- + + +### [`content-migrations/octicon-tag.js`](content-migrations/octicon-tag.js) + + + +--- + + +### [`content-migrations/site-data-tag.js`](content-migrations/site-data-tag.js) + + + +--- + + ### [`create-glossary-from-spreadsheet.js`](create-glossary-from-spreadsheet.js) This script turns a Google Sheets CSV spreadsheet into a YAML file. @@ -115,6 +136,19 @@ Pass this script any old dotcom path (e.g., `articles/foo` or `foo.md`) and it w --- +### [`get-new-version-path.js`](get-new-version-path.js) + +Helper script that returns a "new" versioned path given an "old" versioned path. + +Examples: + +Given: /github/getting-started-with-github/using-github Returns: /free-pro-team@latest/github/getting-started-with-github/using-github + +Given: /enterprise/admin/installation/upgrading-github-enterprise Returns: /enterprise-server@2.22/admin/installation/upgrading-github-enterprise + +--- + + ### [`graphql/build-changelog-from-markdown.js`](graphql/build-changelog-from-markdown.js) @@ -199,6 +233,50 @@ This script moves reusables out of YAML files into individual Markdown files. --- +### [`new-versioning/fixtures.js`](new-versioning/fixtures.js) + + + +--- + + +### [`new-versioning/main`](new-versioning/main) + +All the new versioning! + +Usage $ script/new-versioning/main + +--- + + +### [`new-versioning/move-admin-dir.js`](new-versioning/move-admin-dir.js) + + + +--- + + +### [`new-versioning/update-content.js`](new-versioning/update-content.js) + + + +--- + + +### [`new-versioning/update-frontmatter.js`](new-versioning/update-frontmatter.js) + + + +--- + + +### [`new-versioning/update-products-yml.js`](new-versioning/update-products-yml.js) + + + +--- + + ### [`pages-with-liquid-titles.js`](pages-with-liquid-titles.js) This is a temporary script to visualize which pages have liquid (and conditionals) in their `title` frontmatter @@ -206,9 +284,16 @@ This is a temporary script to visualize which pages have liquid (and conditional --- -### [`prevent-pushes-to-master.js`](prevent-pushes-to-master.js) +### [`ping-staging-apps.js`](ping-staging-apps.js) -This script is intended to be used as a git "prepush" hook. If the current branch is master, it will exit unsuccesfully and prevent the push. +This script finds all Heroku staging apps and pings them to make sure they're always "warmed" and responsive to requests. + +--- + + +### [`prevent-pushes-to-main.js`](prevent-pushes-to-main.js) + +This script is intended to be used as a git "prepush" hook. If the current branch is main, it will exit unsuccesfully and prevent the push. --- @@ -220,6 +305,13 @@ This script is run as a git precommit hook (installed by husky after npm install --- +### [`preview-openapi-changes`](preview-openapi-changes) + + + +--- + + ### [`purge-fastly`](purge-fastly) Run this script to manually purge the [Fastly cache](https://github.com/github/docs-internal#fastly-cdn). Note this script requires a `FASTLY_SERVICE_ID` and `FASTLY_TOKEN` in your `.env` file. @@ -234,6 +326,17 @@ Run this script to manually purge the [Fastly cache](https://github.com/github/d --- +### [`reconcile-category-dirs-with-ids.js`](reconcile-category-dirs-with-ids.js) + +An automated test checks for discrepancies between category directory names and slugified category titles as IDs. + +If the test fails, a human needs to run this script to update the directory names and add appropriate redirects. + +**This script is not currently supported on Windows.** + +--- + + ### [`reconcile-filenames-with-ids.js`](reconcile-filenames-with-ids.js) An automated test checks for discrepancies between filenames and [autogenerated heading IDs](https://www.npmjs.com/package/remark-autolink-headings). If the test fails, a human needs to run this script to update the filenames. @@ -247,14 +350,6 @@ An automated test checks for discrepancies between filenames and [autogenerated Run this script after an Enterprise deprecation to remove Liquid statements and frontmatter that contain the deprecated Enterprise version. See the Enterprise deprecation issue template for instructions. -You can run this script on either the help docs or the developer docs. To run it on the help docs, enter: - -`script/remove-deprecated-enterprise-version-markup.js` - -To run it on the developer docs, provide a path to your developer docs checkout as an argument. You can use a tilde to represent your home directory. For example: - -`script/remove-deprecated-enterprise-version-markup.js ~/Desktop/internal-developer.github.com/` - --- @@ -310,7 +405,7 @@ Run this script to standardize frontmatter fields in all content files, per the ### [`sync-algolia-search-indices.js`](sync-algolia-search-indices.js) -This script is run automatically via GitHub Actions on every push to `master` to generate searchable data and upload it to our Algolia account. It can also be run manually. For more info see [search.md](../search.md) +This script is run automatically via GitHub Actions on every push to `master` to generate searchable data and upload it to our Algolia account. It can also be run manually. For more info see [contributing/search.md](contributing/search.md) --- @@ -351,6 +446,13 @@ This script is used by other scripts to update temporary AWS credentials and aut --- +### [`update-versioning-in-files.js`](update-versioning-in-files.js) + + + +--- + + ### [`upload-enterprise-images-to-s3.js`](upload-enterprise-images-to-s3.js) Run this script to: [upload individual files to S3](https://github.com/github/product-documentation/blob/master/doc-team-workflows/workflow-information-for-all-writers/adding-individual-images-to-earlier-verisons-of-enterprise.md) or: [upload a batch of files to S3 for a new Enterprise release](https://github.com/github/product-documentation/blob/master/doc-team-workflows/working-on-enterprise-releases/information-for-all-writers/storing-a-batch-of-assets-on-s3-for-a-new-release.md). Run `upload-enterprise-images-to-s3.js --help` for usage details. diff --git a/script/anonymize-branch.js b/script/anonymize-branch.js new file mode 100755 index 0000000000..e5da59f3d4 --- /dev/null +++ b/script/anonymize-branch.js @@ -0,0 +1,29 @@ +#!/usr/bin/env node + +// [start-readme] +// +// Flatten all the commits in the current branch into a single anonymized @Octomerger commit +// +// Usage: script/anonymize-branch.js [base-branch] +// Example: script/anonymize-branch.js "nothing to see here" +// If the optional [base-branch] argument is omitted, it will default to `main` +// +// [end-readme] + +process.env.GIT_AUTHOR_NAME = process.env.GIT_COMMITTER_NAME = 'Octomerger Bot' +process.env.GIT_AUTHOR_EMAIL = process.env.GIT_COMMITTER_EMAIL = '63058869+Octomerger@users.noreply.github.com' + +const { execSync: exec } = require('child_process') +const path = require('path') +const args = process.argv.slice(2) +const message = args[0] +const base = args[1] || 'main' + +if (!message || !message.length) { + console.error(`Specify a new commit message in quotes. Example:\n\nscript/${path.basename(module.filename)} "new commit"`) + process.exit() +} + +exec(`git reset $(git merge-base ${base} HEAD)`) +exec('git add -A') +exec(`git commit -m "${message}"`) diff --git a/script/new-versioning/update-frontmatter.js b/script/new-versioning/update-frontmatter.js index e5d8ef3b89..f76379fd20 100755 --- a/script/new-versioning/update-frontmatter.js +++ b/script/new-versioning/update-frontmatter.js @@ -10,7 +10,7 @@ const dirsToProcess = ['content', 'translations'] const allFiles = flatten(dirsToProcess.map(dir => { return walk(path.join(process.cwd(), dir), { includeBasePath: true, directories: false }) .filter(file => !file.endsWith('README.md')) - .filter(file => !file.endsWith('LICENSE')) + .filter(file => !(file.endsWith('LICENSE') || file.endsWith('LICENSE-CODE'))) // we only want to process frontmatter in content files in translations, so skip data files // this is very brittle but works well enough for this script // (note data files are updated in script/new-versioning/update-content.js) diff --git a/script/remove-deprecated-enterprise-version-markup.js b/script/remove-deprecated-enterprise-version-markup.js index 33133949d0..8a746c6d80 100755 --- a/script/remove-deprecated-enterprise-version-markup.js +++ b/script/remove-deprecated-enterprise-version-markup.js @@ -52,7 +52,7 @@ console.log(`Next oldest version: ${nextOldestVersion}\n`) // gather content and data files const contentFiles = walk(contentPath, { includeBasePath: true, directories: false }) .filter(file => file.endsWith('.md')) - .filter(file => !(file.endsWith('README.md') || file === 'LICENSE')) + .filter(file => !(file.endsWith('README.md') || file === 'LICENSE' || file === 'LICENSE-CODE')) const dataFiles = walk(dataPath, { includeBasePath: true, directories: false }) .filter(file => file.includes('data/reusables') || file.includes('data/variables'))