internal-developer.github.com

developer.github.com is in maintenance mode

To escalate a problem

See More

If there is a serious problem with developer.github.com or the site is down, please read https://github.com/github/docs-team/blob/main/engineering/playbooks/docs-internal/escalation.md.

Current status

The content and tooling in this repository are no longer maintained.

In 2020, @github/docs-engineering migrated the content to https://github.com/github/docs-internal, where it is actively maintained and rendered at https://docs.github.com. Specifically: https://docs.github.com/developers, https://docs.github.com/rest, and https://docs.github.com/graphql.

Links to developer.github.com now redirect to docs.github.com, with one exception:

  1. The (out of date) developer changelog at https://developer.github.com/changes.

The issue to migrate them to the blog was https://github.com/github/blog/issues/1608

If you absolutely need to update developer.github.com

The tools once used to build, preview, test, and publish the files in master are no longer maintained and mostly decomissioned.

Any changes in this repo should be limited to important patches and bugfixes, not new content. Reach out to @github/docs-engineering with requests or questions about this.

Steps to publish an update

Note: Merging content changes to the master branch will not publish them. The Markdown files in master are just an artifact and no longer get compiled. The HTML files in gh-pages are what get rendered on the still-public developer.github.com pages.

  1. Check out the gh-pages branch.
  2. Create a feature branch for your changes.
  3. Update the HTML or asset file(s) you need to change and open a pull request. Note that all CI tests are expected to fail.
  4. @docs-engineering will be pinged for review via CODEOWNERS.
  5. Once the PR is approved, it can be merged into the gh-pages branch.
  6. Pages can take up to 10 minutes to finish building. You can see the status on the Pages tab of the repo settings.

For anything else…

Ping @github/docs, open an issue in https://github.com/github/docs-content, and/or check out https://github.com/github/docs-internal for the latest and greatest developer documentation!