Add github-api topic#39
Conversation
|
/cc @kdaigle for input on the description |
|
My schedule won't allow me to look at this today. @bswinnerton can you review this? |
bswinnerton
left a comment
There was a problem hiding this comment.
This looks great, @cheshire137! Thank you for adding this topic, I think it'll be a great addition ✨ .
I left a small suggestion that I think you can absolutely ignore.
| short_description: The GitHub API allows you to build applications that integrate with GitHub. | ||
| topic: github-api | ||
| --- | ||
| The GitHub API provides endpoints for users to consume GitHub data as well as make changes on a user's behalf. The latest version is v4, the GraphQL API. The GitHub GraphQL API v4 represents an architectural and conceptual shift from the GitHub REST API v3. |
There was a problem hiding this comment.
This looks fantastic, @cheshire137. What do you think of adding a few words on what makes the GraphQL API different? Maybe something like:
The GitHub GraphQL API v4 represents an architectural and conceptual shift from the GitHub REST API v3 and allows for users to craft queries of the exact data they need.
MikeMcQuaid
left a comment
There was a problem hiding this comment.
Makes sense to me, thanks @cheshire137!
# What is GitHub Pages? You can use GitHub Pages to host a website about yourself, your organization, or your project directly from a repository on GitHub. ## About GitHub Pages GitHub Pages is a static site hosting service that takes HTML, CSS, and JavaScript files straight from a repository on GitHub, optionally runs the files through a build process, and publishes a website. You can see examples of GitHub Pages sites in the [GitHub Pages examples collection](https://github.com/collections/github-pages-examples). ## Types of GitHub Pages sites There are two types of GitHub Pages sites. Sites associated with a user or organization account, and sites for a specific project. <table> <thead> <tr> <th>Property</th> <th>User and organization sites</th> <th>Project sites</th> </tr> </thead> <tbody> <tr> <th>Source files</th> <td>Must be stored in a repository named <code><owner>.github.io</code>, where <code><owner></code> is the personal or organization account name</td> <td>Stored in a folder within the repository that contains the project&github#39;s code</td> </tr> <tr> <th>Limits</th> <td>Maximum of one pages site per account</td> <td>Maximum of one pages site per repository</td> </tr> <tr> <th>Default site location</th> <td><code>http(s)://<owner>.github.io</code></td> <td><code>http(s)://<owner>.github.io/<repositoryname></code></td> </tr> </tbody> </table> ### Hosting on your own custom domain You can host your site on GitHub's `github.io` domain or your own custom domain. See [Configuring a custom domain for your GitHub Pages site](/en/pages/configuring-a-custom-domain-for-your-github-pages-site). ## Data collection When a GitHub Pages site is visited, the visitor's IP address is logged and stored for security purposes, regardless of whether the visitor has signed into GitHub or not. For more information about GitHub's security practices, see [GitHub Privacy Statement](/en/site-policy/privacy-policies/github-privacy-statement). ## Further reading * [GitHub Pages](https://github.com/skills/github-pages) on GitHub Skills * [REST API endpoints for repositories](/en/rest/repos#pages) * [Configuring a publishing source for your GitHub Pages site](/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site) * [About custom domains and GitHub Pages](/en/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages#using-a-custom-domain-across-multiple-repositories)
I am:
Suggesting edits to an existing Topic page
Curating a new Topic page
I've formatted my changes as a new folder directory, named for the topic as it appears in the URL on GitHub (e.g.
https://github.com/topics/[NAME])My folder contains a
*.pngimage (if applicable) andindex.mdAll required fields in my
index.mdconform to the Style Guide and API docs: https://github.com/github/explore/tree/master/docsPlease explain why you think this Topic page should be curated:
https://github.com/topics/github-api has 644 repositories currently, and I think it will continue to grow. We can show helpful information, like a link to the API docs, in the sidebar if we curate this topic.