Pkg.jl: Official docs on package registration process

Created on 27 Jul 2019  路  2Comments  路  Source: JuliaLang/Pkg.jl

Pkg.jl docs should cover package registration process. Looks like the only source of information on this is still a discourse thread (https://discourse.julialang.org/t/switching-package-registration-systems-soon/22677) and the Registrator README (https://github.com/JuliaRegistries/Registrator.jl/blob/master/README.md). Both sources are not liked to any official doc. (julia docs link to Pkg.jl docs on https://docs.julialang.org/en/v1/stdlib/Pkg/, but Registrator.jl is not linked to any docs, AFAIK).

Ref: https://github.com/JuliaRegistries/General/issues/1626

documentation help wanted

Most helpful comment

Yes, the discoverability of the documentation for this is terrible鈥擨 didn't realize quite how bad until @madeleineudell pointed it out to me along with several other very helpful bits of feedback (thanks, Madeleine!). Here are some of the notes I took.


Improvements:

  • Add info about how to register package in the manual section for Pkg
  • Manual Pkg section needs to link to the main Pkg.jl docs
  • Pkg.jl docs don鈥檛 even include docs for registration process
  • Pkg.jl repo doesn鈥檛 clearly indicate that the doc link is to docs
  • Include example workflows like https://medium.com/@Jernfrost/my-new-workflow-with-julia-1-0-99711103d97c but for various processes
  • The actual useful docs are at https://github.com/JuliaRegistries/Registrator.jl

Google search terms that should ideally work:

  • julia packages dev
  • julia package development
  • julia register package
  • julia general registry
  • julia register new version

All 2 comments

Yes, the discoverability of the documentation for this is terrible鈥擨 didn't realize quite how bad until @madeleineudell pointed it out to me along with several other very helpful bits of feedback (thanks, Madeleine!). Here are some of the notes I took.


Improvements:

  • Add info about how to register package in the manual section for Pkg
  • Manual Pkg section needs to link to the main Pkg.jl docs
  • Pkg.jl docs don鈥檛 even include docs for registration process
  • Pkg.jl repo doesn鈥檛 clearly indicate that the doc link is to docs
  • Include example workflows like https://medium.com/@Jernfrost/my-new-workflow-with-julia-1-0-99711103d97c but for various processes
  • The actual useful docs are at https://github.com/JuliaRegistries/Registrator.jl

Google search terms that should ideally work:

  • julia packages dev
  • julia package development
  • julia register package
  • julia general registry
  • julia register new version

Adding to the list of additional documentation: How to rename a package

Was this page helpful?
0 / 5 - 0 ratings

Related issues

omus picture omus  路  4Comments

jlperla picture jlperla  路  3Comments

GordStephen picture GordStephen  路  3Comments

GregPlowman picture GregPlowman  路  3Comments

KristofferC picture KristofferC  路  4Comments