Skip to content

Add github-api topic#39

Merged
cheshire137 merged 3 commits into
masterfrom
add-github-api-topic
Oct 18, 2017
Merged

Add github-api topic#39
cheshire137 merged 3 commits into
masterfrom
add-github-api-topic

Conversation

@cheshire137
Copy link
Copy Markdown
Member

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 *.png image (if applicable) and index.md

  • All required fields in my index.md conform to the Style Guide and API docs: https://github.com/github/explore/tree/master/docs

Please 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.

@cheshire137 cheshire137 self-assigned this Oct 12, 2017
@cheshire137
Copy link
Copy Markdown
Member Author

/cc @kdaigle for input on the description

@kdaigle
Copy link
Copy Markdown
Member

kdaigle commented Oct 13, 2017

My schedule won't allow me to look at this today. @bswinnerton can you review this?

Copy link
Copy Markdown

@bswinnerton bswinnerton left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread topics/github-api/index.md Outdated
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.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copy link
Copy Markdown
Contributor

@MikeMcQuaid MikeMcQuaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense to me, thanks @cheshire137!

@cheshire137 cheshire137 merged commit 86858a7 into master Oct 18, 2017
@cheshire137 cheshire137 deleted the add-github-api-topic branch October 18, 2017 16:35
mahdiallai added a commit to mahdiallai/explore that referenced this pull request May 22, 2026
# 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>&lt;owner&gt;.github.io</code>, where <code>&lt;owner&gt;</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)://&lt;owner&gt;.github.io</code></td>
<td><code>http(s)://&lt;owner&gt;.github.io/&lt;repositoryname&gt;</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)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants