Skip to content

Latest commit

 

History

History
61 lines (40 loc) · 3.34 KB

usage.md

File metadata and controls

61 lines (40 loc) · 3.34 KB

How to use

Take a look below for some of the ways you can use Community Toolbox,

Embed an issues list

Community Toolbox lets you view issues of a specific repository for embedding on another site, with the following URL:

https://code.publiclab.org/examples/embed.html#o=orgname&r=repository

For issues with a specific label, use, for example:

https://code.publiclab.org/examples/embed.html#o=orgname&r=repository&f=first-timers-only

To embed these on your site, use an <iframe> like this:

<iframe src="https://code.publiclab.org/examples/embed.html#o=orgname&r=repository" style="border:none;" width="100%" height="600px"></iframe>

For more options, see Configuration below.

Org-wide issues

You can also use Community Toolbox to display issues for a given label across an entire organization. Use all for the r parameter to get the view of all repositories' data, like this:

https://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://code.publiclab.org/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 look 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 look 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://code.publiclab.org/examples/embed.html#r=all&l=help-wanted

Configuration

These lines 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:

https://code.publiclab.org/ is run from our GitHub Pages system, so it's equivalent to https://publiclab.github.io/community-toolbox/