Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 24357f3

Browse files
committed
First pass at updating docs for Collections
1 parent 02e56f9 commit 24357f3

File tree

5 files changed

+101
-29
lines changed
  • .github
    • PULL_REQUEST_TEMPLATE.md
  • CONTRIBUTING.md
  • README.md
  • docs
    • API.md
    • styleguide.md

5 files changed

+101
-29
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
- [ ] I followed the contributing guidelines: https://github.com/github/explore/blob/master/CONTRIBUTING.md
22

33
I am:
4-
- [ ] Suggesting edits to an existing Topic page
5-
- [ ] Curating a new Topic page
4+
- [ ] Suggesting edits to an existing topic or collection
5+
- [ ] Curating a new topic or collection
66

7-
***********EDITING AN EXISTING TOPIC PAGE************
7+
***********EDITING AN EXISTING TOPIC OR COLLECTION************
88

99
I'm suggesting these edits to an existing topic:
1010
- [ ] Image (and my file is `*.png`, square, dimensions 288x288)
@@ -13,12 +13,12 @@ I'm suggesting these edits to an existing topic:
1313
Please explain why these changes are necessary:
1414

1515

16-
************CURATING A NEW TOPIC PAGE************
16+
************CURATING A NEW TOPIC OR COLLECTION************
1717

1818
- [ ] 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]`)
1919
- [ ] My folder contains a `*.png` image (if applicable) and `index.md`
2020
- [ ] All required fields in my `index.md` conform to the Style Guide and API docs: https://github.com/github/explore/tree/master/docs
2121

22-
Please explain why you think this Topic page should be curated:
22+
Please explain why you think this topic or collection should be curated:
2323

2424
**Please note: we will close your PR without comment if you do not check the boxes above and provide ALL requested information.**

CONTRIBUTING.md

Lines changed: 63 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,87 @@
11
# Contributing
22

3-
Hi there! We're excited you've got ideas for an existing or new topic page. Your help makes Explore valuable to others in your community.
3+
Hi there! We're excited you've got ideas to improve topics and collections. Your helping the community discover valuable information.
44

55
This project adheres to the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.
66

7-
There are a few ways you can contribute: improving an existing topic page, or curating a new topic page.
7+
There are a few ways you can contribute:
8+
9+
- Improving an existing topic or collection
10+
- Curating a new topic topic or collection
811

912
As you write content, check out the [Style Guide](./docs/styleguide.md) to learn what each field means, and how they should be formatted. Following the style guide will improve the chances of your contribution being accepted.
1013

11-
Note: updates won't immediately appear once we've merged your PR. We pull in these changes regularly to GitHub.
14+
Note: Updates won't immediately appear once we've merged your PR. We pull in these changes regularly to GitHub.
1215

13-
## Improving an existing topic page
16+
## Improving an existing topic or collection
1417

15-
If a topic page already exists, it will be listed in the [topics directory](https://github.com/github/explore/tree/master/topics). The topic name should match its URL, e.g. `https://github.com/topics/rails` corresponds to the [`rails` folder](https://github.com/github/explore/tree/master/topics/rails).
18+
If a topic or collection already exists, it will be listed in its respective directory:
1619

17-
To improve an existing topic page, please **open a pull request** with your proposed changes:
20+
- [Topics](https://github.com/github/explore/tree/master/topics)
21+
- [Collections](https://github.com/github/explore/tree/master/collections)
1822

19-
* To update the image, replace the image inside the topic's folder
20-
* To update the content, edit the `index.md` inside the topic's folder
23+
The topic or collection name should match its URL, e.g. `https://github.com/topics/rails` corresponds to the [`topics/rails` directory](https://github.com/github/explore/tree/master/topics/rails).
2124

22-
The [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) provides guidance on the information you need to include.
25+
To make an improvement, please **open a pull request** with your proposed changes:
2326

24-
**Please fill out the pull request template completely.** If you do not fill out the template, your PR will be closed.
27+
### Update the image
28+
29+
To update the image, simply replace the image inside the topic or collection's directory
30+
31+
### Update text & links
32+
33+
To update text and links, edit the `index.md` inside the topic or collection's directory. These files are formatted using a combination of [front matter](https://jekyllrb.com/docs/frontmatter/) and simple body content.
34+
35+
For **topics**, you'll notice that, in examples like "[algolia](https://raw.githubusercontent.com/github/explore/master/topics/algolia/index.md)," data like the topic's canonical URL, Wikipedia URL, or display name are called out in key-value pairs; while its detailed description is accounted for in the body of the document.
36+
37+
_/topics/algolia/index.md_:
38+
```
39+
---
40+
aliases: algoliasearch, algolia-search
41+
related: instantsearch, instant-search
42+
created_by: Nicolas Dessaigne, Julien Lemoine
43+
display_name: Algolia
44+
github_url: https://github.com/algolia/
45+
logo: algolia.png
46+
released: October 23, 2012
47+
short_description: Algolia is a hosted search API for web and mobile applications.
48+
topic: algolia
49+
url: https://www.algolia.com/
50+
wikipedia_url: https://en.wikipedia.org/wiki/Algolia
51+
---
52+
Algolia is a hosted API for building search into web and mobile applications, with typo-tolerance, fully configurable relevance, and other tools for making great search experiences.
53+
```
2554

26-
## Curating a new topic page
55+
---
56+
57+
Similarly, **collections** like "[music](https://raw.githubusercontent.com/github/explore/master/collections/music/index.md)" call out things like their author and display name in key-value pairs -- with a detailed description in the body of the document. Most importantly, though, collections identify their individual collection items in a comma-separated string value for the key "items."
58+
59+
_/collections/music/index.md_:
60+
61+
```
62+
---
63+
items: beetbox/beets, scottschiller/SoundManager2, CreateJS/SoundJS, musescore/MuseScore, tomahawk-player/tomahawk, cashmusic/platform, mopidy/mopidy, AudioKit/AudioKit, Soundnode/soundnode-app, gillesdemey/Cumulus, metabrainz/picard, overtone/overtone, samaaron/sonic-pi
64+
display_name: Music
65+
created_by: jonrohan
66+
---
67+
Drop the code bass with these musically themed repositories.
68+
```
69+
70+
---
71+
72+
The [pull request template](./.github/PULL_REQUEST_TEMPLATE.md) also provides guidance on the information you need to include.
73+
74+
**Please fill out the pull request template completely.** If you do not fill out the template, your PR will be closed.
2775

28-
If a topic page is not yet curated, it will NOT be listed in the [topics directory](https://github.com/github/explore/tree/master/topics). The default layout on `https://github.com/topics/foo` looks like this:
76+
## Curating a new topic or collection
2977

30-
![topic page](https://user-images.githubusercontent.com/1840802/30932236-c9c397d2-a37b-11e7-94be-5c9847ea2d71.png)
78+
If a topic or collection is not yet curated, it will NOT be listed in its respective directory.
3179

32-
We are likely to consider suggestions to curate a topic page that is valuable to GitHub's community. Valuable topics include those that are already [widely used by repositories](https://help.github.com/articles/classifying-your-repository-with-topics/), or a topic that currently lacks important information. When suggesting content for a topic page, please consider how to make your contribution broadly useful and relevant to others, rather than serving a specific use case.
80+
We are likely to consider suggestions to curate a topic or collection that is valuable to GitHub's community. Valuable topics, for example, include those that are already [widely used by repositories](https://help.github.com/articles/classifying-your-repository-with-topics/), or a topic that currently lacks important information. When suggesting content, please consider how to make your contribution broadly useful and relevant to others, rather than serving a specific use case.
3381

3482
Please note that all suggestions must adhere to GitHub's [Community Guidelines](https://help.github.com/articles/github-community-guidelines/) and [Terms of Service](https://help.github.com/articles/github-terms-of-service/). Per our Terms of Service, [you are responsible](https://help.github.com/articles/github-terms-of-service/#d-user-generated-content) for the content you contribute, and you must have the rights to use it.
3583

36-
To propose a new topic page, please **open an pull request** with your proposed changes. The [API docs](./docs/API.md) and [style guide](./docs/styleguide.md) provide guidance on the information you need to include and how it should be formatted.
84+
To propose a new topic or collection, please **open an pull request** with your proposed additions. The [API docs](./docs/API.md) and [style guide](./docs/styleguide.md) provide guidance on the information you need to include and how it should be formatted.
3785

3886
This repository includes [a list of the most-used GitHub topics that don't yet have extra context](topics-todo.md). If your pull request adds one of these topics, please update topics-todo.md so that the topic is checked (marked complete).
3987

README.md

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,17 @@
22

33
[![Build Status](https://travis-ci.org/github/explore.svg?branch=master)](https://travis-ci.org/github/explore)
44

5-
<img src="https://user-images.githubusercontent.com/1840802/31236555-436777c4-a9a9-11e7-8377-c5c4c4c7722e.png" width="650" />
5+
This repository houses all of the community-curated content for GitHub Topics and Collections.
66

7-
Topic pages, curated by the community.
7+
[Topics](https://help.github.com/articles/about-topics/) help you explore repositories in a particular subject area, learn more about that subject, and find projects to contribute to.
88

9-
[Topics](https://help.github.com/articles/about-topics/) help you explore repositories in a particular subject area, learn more about a subject area, and find projects to contribute to.
9+
[Collections](http://github.com/collections) help you discover hand-picked repositories, developers, organizations, videos, and articles that share a common theme.
1010

11-
If you want to suggest edits to an existing topic page, or curate a new topic page, read our [contributing guide](CONTRIBUTING.md) to get started. You can [review a list of popular topics that need more context](topics-todo.md) to get an idea of where to start.
11+
If you want to suggest edits to an existing topic page or collection, or curate a new one, read our [contributing guide](CONTRIBUTING.md) to get started. You can also [review a list of popular topics that need more context](topics-todo.md) to get an idea of where to start.
1212

1313
## Running tests
1414

15-
There are some lint tests in place to ensure each topic is formatted in the way we expect. Travis
16-
CI will run the tests automatically. If you want to run the tests yourself locally, you will need
17-
Ruby and Bundler installed.
15+
There are some lint tests in place to ensure each topic is formatted in the way we expect. Travis CI will run the tests automatically. If you want to run the tests yourself locally, you will need Ruby and Bundler installed.
1816

1917
You can run the tests using:
2018

docs/API.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Making edits to a topic page
1+
## Making edits to a topic
22

33
If you're making edits to a topic page, the following fields are available for use. Not all fields are required.
44

@@ -64,3 +64,29 @@ Acceptable formatting:
6464

6565
### The body of your document
6666
(required) A longer description of the topic, which will appear on its topic page. Must be 1,000 characters or less. Should not be the same as `short_description`. Some Markdown is allowed, such as links. Emoji are allowed.
67+
68+
## Making edits to a collection
69+
70+
If you're making edits to a collection, the following fields are available for use. Not all fields are required.
71+
72+
### items
73+
A comma-separated string containing any of the following values:
74+
75+
- GitHub repository path (e.g. `defunkt/dotjs`)
76+
- GitHub username (e.g. `defunkt`)
77+
- GitHub organization (e.g. `github`)
78+
- Any web URL (e.g. `https://product.hubspot.com/blog/git-and-github-tutorial-for-beginners`)
79+
- Any YouTube video URL (e.g. `https://www.youtube.com/watch?v=0fKg7e37bQE`)
80+
81+
A complete `items` key-value pair might look like:
82+
83+
`items: pybee/batavia, Homebrew/brew, https://www.youtube.com/watch?v=dSl_qnWO104`
84+
85+
### created_by
86+
(if applicable) GitHub username of the person and/or organization that authored the collection.
87+
88+
### display_name
89+
(required) The collection name that will be displayed on its page (ex. `How to choose (and contribute to) your first open source project`). Should use proper noun capitalization. Emoji are not allowed.
90+
91+
### The body of your document
92+
(required) A longer description of the collection, which will appear on its page. Must be 1,000 characters or less. Some Markdown is allowed, such as links. Emoji are allowed.

docs/styleguide.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Always use the [Oxford comma](https://en.wikipedia.org/wiki/Serial_comma).
2424
Include and spell out the month. Include the day number without the "th" or "nd" at the end, for example: October 12.
2525

2626
### Exclamation points
27-
Avoid exclamation points in topic pages.
27+
Avoid exclamation points in topic pages and collections.
2828

2929
### GitHub
3030
Always use correct capitalization when referring to "GitHub" or "Git". Never use "GitHub" or "Git" as a verb.

0 commit comments

Comments
(0)