[Documentation] Proposal to add documentation on https://gem.coop/ #31
Description
Hey there gem.coop folks,
Josef recently linked from reddit, to the announcement at:
So far so fine \o/ - I'll check this in a little while when I
have some spare time available. There is one thing I think
could be improved in the coming weeks, though, and this is
the documentation. Right now the documentation is a little
bit spread out, e. g. in the updates primarily, to some extent
on the github tracker. What I think would be beneficial, is to
have useful, ideally short-to-the-point documentation (and
perhaps also longer documentation, in the long run, but right
now I'll just focus on short points of note for the documentation).
For instance, we can push a new gem via:
GEM_HOST_API_KEY=push_key gem push --host https://beta.gem.coop/@namespace
GEM_HOST_API_KEY=push_key RUBYGEMS_HOST=https://beta.gem.coop/@namespace rake release
I assume @namespace should be replaced via the specific namespace
that was registered, e. g. "foobar" would be @foobar. But then
how to view it? I guess also the same URL, but would we have to
use @? How about .gemspec files, could these also be used? And
so on, and so forth.
Right now the top links on gem.coop are:
"Home Updates Cooldowns Fellowship GitHub"
Could perhaps a new entry be added, "Documentation" or something like
that? Or perhaps a usage FAQ, with simple questions and simple answers?
I guess people may have more questions over time, so perhaps that could
be a starter to add more info. Of course other means of support may be
possible, be it email, Discord (or whatever is used) but not everyone
may have enough time or multi-task too much, so I think simple documentation
could be very helpful. The documentation could also include some short
articles if anyone feels like writing. And, also, in case people forget
something; in some days I may have forgotten some things already (I have
started to note down information into a local markdown file, aptly called
coop.md though). Thanks for reading this request.