JuliaLang/Pkg.jl

Official docs on package registration process

Open

#1,268 opened on Jul 27, 2019

View on GitHub
 (2 comments) (1 reaction) (1 assignee)Julia (296 forks)batch import
documentationhelp wanted

Repository metrics

Stars
 (665 stars)
PR merge metrics
 (Avg merge 20d 9h) (11 merged PRs in 30d)

Description

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

Contributor guide

Research direction
The issue requests adding official documentation for package registration process in Pkg.jl. Currently, the only sources are a Discourse thread and the Registrator README. The goal is to create a new doc page or section in the Pkg.jl documentation that covers steps for registering a package, linking to the General registry and Registrator.jl. Look at existing Pkg.jl docs structure and the linked references for content. No PRs are open yet.
Tech stack
None
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of Pkg.jlFamiliarity with Julia package registration
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70