From 5472365f352758b668733d30047d5e4a70734c2e Mon Sep 17 00:00:00 2001 From: Jeffrey Warren Date: Fri, 18 Oct 2019 17:15:06 +0200 Subject: [PATCH] Update usage.md --- docs/usage.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/docs/usage.md b/docs/usage.md index f79afd0c..267305c0 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -8,34 +8,36 @@ Take a look below for some of the ways you can use Community Toolbox, Community Toolbox lets you view issues of a specific repository for embedding on another site, with the following URL: ``` -http://code.publiclab.org/examples/embed.html#o=orgname&r=repository +https://code.publiclab.org/examples/embed.html#o=orgname&r=repository ``` For issues with a specific label, use, for example: ``` -http://code.publiclab.org/examples/embed.html#o=orgname&r=repository&l=first-timers-only +https://code.publiclab.org/examples/embed.html#o=orgname&r=repository&f=first-timers-only ``` To embed these on your site, use an ` + ``` +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: ``` -http://code.publiclab.org/#r=all +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://publiclab.github.io/community-toolbox/examples/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. @@ -44,13 +46,15 @@ The default is #r=all. This will look though all repositories and show only the 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 +https://code.publiclab.org/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: +https://code.publiclab.org/ is run from our GitHub Pages system, so it's equivalent to https://publiclab.github.io/community-toolbox/ + - **repository:** Using `r=` you can set the repository name to look at, like: http://code.publiclab.org#r=plots2 for https://github.com/publiclab/plots2 - **organization/user:** Using `o=` you can set the organization or user name to look at, like: http://code.publiclab.org#o=publiclab for https://github.com/publiclab - **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