Skip to content

Commit

Permalink
Add instructions for filtering by labels and repo using URL (publicla…
Browse files Browse the repository at this point in the history
  • Loading branch information
digitaldina authored and jywarren committed Nov 28, 2018
1 parent e5df31c commit dbde6bf
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,16 @@ You can also use Community Toolbox to display issues for a given label across an

http://code.publiclab.org/#r=all

## Repository specific issues
To find an issue in a specific repository, other than using the issues tab and the search bar, you can change the URL to filter through the issues! So if we look at the URL for embed.html:
https://publiclab.github.io/community-toolbox/examples/embed.html

To get to the issues of a specific repository, you can add a #r= then the name of the repository you want to looks through. For example, if you wanted to look through the issues in the plots2 repo, you would add #r=plots2 to the above URL.

The default is #r=all. This will looks though all repositories and show only the first-timer-only issues in all the repositories.
You can combine the above to search through specific issues in a specific repository. For example, you can add #r=all&l=help-wanted. The l= is where the name of the label on the issues you are looking for goes. Here's what that looks like in a full URL:
https://publiclab.github.io/community-toolbox/examples/embed.html#r=all&l=help-wanted

## Configuration

[These lines](https://github.com/publiclab/community-toolbox/blob/620c4d906be704ffaa5b40509796c18c393f83f4/index.html#L115-L118) allow configuration of the example to set **repository, organization** and **labels** to use, by adding to the URL hash in the format: `https://publiclab.github.io/community-toolbox/#r=all` (for the `r` parameter, as an example). So the options are:
Expand All @@ -37,7 +47,6 @@ http://code.publiclab.org/#r=all
* **first-timers-only label** - using `f=` you can set the label to use for `first-timers-only` or equivalent issues, like: http://code.publiclab.org#f=help-wanted for https://github.com/publiclab/plots2/labels/help-wanted
* **first timers only "candidates"** - using `c=` you can set the label to use for `fto-candidate` or equivalent issues (at Public Lab, we keep a queue of not-quite-ready-but-almost issues for newcomers, that have key information but aren't completely formatted to welcome yet), like: http://code.publiclab.org#c=fto-candidate for https://github.com/publiclab/plots2/labels/fto-candidate


## Developing

To develop and build out Community Toolbox, you'l need to have `npm` installed and to run `npm install` to get all the dependencies.
Expand Down

0 comments on commit dbde6bf

Please sign in to comment.