r-universe-org / help

Support and bug tracker for R-universe
https://docs.r-universe.dev/
8 stars 2 forks source link

Improve documentation for publishing packages to R-universe #270

Open JosiahParry opened 1 year ago

JosiahParry commented 1 year ago

Hi! New user here:

One thing I'm struggling with is understanding what the package publication process is. It's quite unclear to me. At first I was under the impression that there was just one R-universe that folks submitted packages to. Then, when I created my own R-universe it included the 2 packages I have on CRAN at the moment without a clear process (to me) for adding new non-CRAN packages.

This document made it seem that by including the R-universe in the URL of the DESCRIPTION file would include it in the universe. This did not work. I then found some slides from 2021 which I used. I then created a repo josiahparry/universe and included a package.json based on the slides. Then I found a semi-recent blog post which discourages the universe repo.

All that is to say, there isn't any clear onboarding document for new users 😅 An article on the basics for package developers

jeroen commented 1 year ago

Sorry it is unclear (the process is under development) 🙈

What you have now is correct! The packages from your packages.json will start appearing on https://github.com/r-universe/josiahparry and on https://josiahparry.r-universe.dev when they are finished building (in an hour or so).

You can check build progress here: https://github.com/r-universe/josiahparry/actions