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

Add README with basic documentation? #1626

Closed
nickrobinson251 opened this issue Jun 28, 2019 · 5 comments
Closed

Add README with basic documentation? #1626

nickrobinson251 opened this issue Jun 28, 2019 · 5 comments
Assignees

Comments

@nickrobinson251
Copy link
Contributor

This could clarify both

  • what the General registry is, how one is expected to interact with it as a package developer (i.e. Registrator, optionally TagBot, but also you can make PRs to edit files directly)
  • how to do a few things beyond tagging a new release e.g. how do I rename a package? How do I "blacklist" a version?
@nickrobinson251
Copy link
Contributor Author

could also point to https://julialang.github.io/Pkg.jl/v1/registries/

and maybe the things mention in the second bullet point above actually belong on that page?

@StefanKarpinski
Copy link
Contributor

Sure, seems like a good idea.

@ericphanson
Copy link
Member

I made a PR with some basic docs here: #3567. I was more focused on giving explanations for common “waiting for author” holds, from what I’ve seen looking at registrator PRs, than blacklisting and things like that though (which I don’t actually know how to do).

@StefanKarpinski StefanKarpinski self-assigned this Sep 20, 2019
@DilumAluthge
Copy link
Member

Can we add a link in the README to https://github.com/JuliaRegistries/RegistryCI.jl? And maybe we can have a note saying that to report issues with automerge, please open an issue in the RegistryCI.jl repo (not the General registry repo)?

@DilumAluthge
Copy link
Member

Fixed by #6335.

Of course, we can (and should) continue to expand and improve the README, see e.g. #3567

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