search

BirdsCanada / naturecounts

R package to access data from the NatureCounts platform by Bird Studies Canada
https://birdscanada.github.io/naturecounts/
12 stars 4 forks source link

naturecounts online documentation outline #2

Open denislepage opened 5 years ago

denislepage commented 5 years ago

We should try to start drafting an outline for the instruction book for the package. Not sure it this issue is the best place to start this for now, or if we already have something in the works.

steffilazerte commented 5 years ago

How about I give you a preview of the 'default' site (and all the information it contains) first? That way you'll have a better sense of what needs to be added.

To serve the website, I'll need you to configure the repository. If you go to the Settings, scroll down to "GitHub Pages" and change the source to "master branch/docs folder". Then when I push the changes it'll populate a site at https://BirdStudiesCanada.github.io/naturecounts.

Official instructions here: https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages#publishing-your-github-pages-site-from-a-docs-folder-on-your-master-branch

denislepage commented 5 years ago

OK, done.

steffilazerte commented 5 years ago

Great, it's already up and running, so take a look and see what you think. There is a preliminary article/tutorial/vignette about Species Codes under the Article heading.

The cool thing about this article is that it is a vignette, so is also listed in the R package with vignette(package = "naturecounts")

steffilazerte commented 5 years ago

Hi Denis, if you think the site layout will work, we can start a list here of Articles/Tutorials to include (we can both edit this comment). This is roughly what I've been thinking about, in no particular order. Add/edit this comment as you see fit!

steffilazerte commented 1 month ago

@DMEthier @dimimarkou, I just stumbled on this old issue. Perhaps some of these ideas are still valid?