Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

pkgdown website? #426

Closed
maelle opened this issue Mar 26, 2019 · 12 comments
Closed

pkgdown website? #426

maelle opened this issue Mar 26, 2019 · 12 comments

Comments

@maelle
Copy link
Member

maelle commented Mar 26, 2019

👋 here! I was wondering whether you'd like to add a pkgdown website to your package. If so, we have a brand-new package with rOpenSci styling, and some guidance on how to use it: https://ropensci.github.io/rotemplate/

Any comment welcome, and I'd be glad to help if needed!

@elinw
Copy link
Collaborator

elinw commented Mar 27, 2019

Great thanks! As a matter of fact, it's one of our reach goals for the v2 release. First we have to finish rewriting the vignettes/creating new ones.

@jules32
Copy link
Contributor

jules32 commented Mar 27, 2019 via email

@elinw
Copy link
Collaborator

elinw commented Mar 27, 2019

Hi @jules32 feel free to jump in! Really there is no reason not to create a v1 site and then when we release we can switch it over to v2.

@jules32
Copy link
Contributor

jules32 commented Mar 27, 2019 via email

@maelle
Copy link
Member Author

maelle commented Mar 27, 2019

Note that if you set up Travis deploy of the pkgdown website (some links about this in rotemplate README), the website will keep in sync with edits of vignettes/reference pages. :-)

@elinw
Copy link
Collaborator

elinw commented Mar 31, 2019

@jules32 @michaelquinn32 added the pkgdown infrastructure and fixed things up. What would be great is any help, any time adding or improving the materials there (which come via the vignettes, documentation etc). I know on other pkgdown sites I've added some things that are not in those specific files too. So please jump right in especially as we are getting so close to v2 release.

@maelle
Copy link
Member Author

maelle commented Apr 1, 2019

Might I also suggest adding function grouping? See https://ropensci.github.io/dev_guide/building.html#function-grouping + pkgdown::template_reference() 🙂

@elinw elinw closed this as completed in 8eac51a Apr 1, 2019
@elinw
Copy link
Collaborator

elinw commented Apr 1, 2019

@maelle I did a 1.0.6-rc tag so it should be building now. Maybe we can keep the discussion here, so I'll reopen.

@elinw elinw reopened this Apr 1, 2019
@maelle
Copy link
Member Author

maelle commented Apr 1, 2019

@elinw where can I view the website?

@elinw
Copy link
Collaborator

elinw commented Apr 1, 2019

Well apparently the build failed. https://travis-ci.org/ropensci/skimr
I didn't really look at this, just merged what @michaelquinn32 had done. Will have to look at this more later in the day.

But ...https://ropensci.github.io/skimr/

@michaelquinn32
Copy link
Collaborator

There's going to be more work on the site, but we can close this now that the proper site is released.

@jules32
Copy link
Contributor

jules32 commented Apr 3, 2019

Amazing! Congratulations! Thanks so much @elinw and @michaelquinn32 and I'm sorry I couldn't contribute right now, I didn't realize the time schedule. I am so impressed and thankful for all the work you are doing with this and I'll help in the future as I can. ❤️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants