Pkgdown #412
Pkgdown #412
Conversation
cderv
left a comment
cderv
left a comment
There was a problem hiding this comment.
- I am not sure why but there is section duplication in this page.
https://rticles-pkg.netlify.app/reference/rjournal_article.html
Maybe a pkgdown issue regarding how we wrote the documentation 🤔
-
Should we still keep regrouping most of functions' documentation in one place ?https://rticles-pkg.netlify.app/reference/index.html#section-journal-templates
Does it make it harder to navigate ? I feeling it could be. -
We got a very wide (vertically) footer due to the number of contributor... should we try to do something about it ?
This shows also on the right in main page with the number of contributor. https://rticles-pkg.netlify.app/index.html I need to see how we can tweak that in pkgdown maybeScreenshot
-
Somehow the date is missing in the release note page https://rticles-pkg.netlify.app/news/index.html
it should be https://pkgs.rstudio.com/rmarkdown/news/index.html
I need to see why -
I wonder if we should simplify the index page to be different from the README on github. Have only the main information like other website and move some information on how to contribute in an article. https://rticles-pkg.netlify.app/index.html#how-to-contribute
This would allow me to write more about it too.
It could be in contributing guide too (https://rticles-pkg.netlify.app/contributing) but is anyone really reading this ? Would it stand out enough ?
Probably new pkgdown solves some of this issue maybe but I did not looked at it yet.
cderv
left a comment
cderv
left a comment
There was a problem hiding this comment.
Some other comments on the content of the PR now, with suggestions and questions.
I'll work on the gallery.
.github/workflows/pkgdown.yaml
Outdated
| branches: | ||
| - main | ||
| - master | ||
| - pkgdown # rm this |
There was a problem hiding this comment.
- Adding this as a reminder to remove before merging
.github/workflows/pkgdown.yaml
Outdated
| uses: nwtgck/actions-netlify@v1.1 | ||
| with: | ||
| publish-dir: 'reference' | ||
| production-branch: pkgdown # change this back to master |
There was a problem hiding this comment.
- Adding this as a reminder task to change this
* Adding to `.Rbuildignore`
Co-authored-by: Christophe Dervieux <christophe.dervieux@gmail.com>
and only a Getting started articles for pkgdown website
`quillt::use_coc()`
- Build from template skeleton.Rmd - Caching mechanism to only rebuild when any of the template file has changed.
This is not done when installing from Config/Needs/website
* Ignore examples.yml
not installed because it is a suggested package
Merge branch 'test-pkgdown' into apreshill-pkgdown # Conflicts: # vignettes/articles/examples.Rmd
This require special quiltt update rstudio/quillt#39
cderv
left a comment
cderv
left a comment
There was a problem hiding this comment.
Ok so we have now:
- Logo added
- Author list reduced in footer (requires rstudio/quillt#39)
- Gallery modified, still using GIF but with size reduced (72 ppi, max 400px width)
We can surely optimize more the GIF if this is still an issue for website performance. Using mp4 is another option as it seems to reduce size of file, and better practive for website.
Site is almost good to go live.
2 participants
Hi @cderv -
Deployed site here: https://rticles-pkg.netlify.app/
To do:
examples gallery
hex sticker
setup Netlify secrets in this repo
edit GH workflow to deploy from master
officially add to listing page for pkgs.rstudio.com