Hello!

I guess this will be one of the final RFC's per e-mail only. I accept that
:-)

On Mon, May 19, 2014 at 4:00 PM, Tibor Simko <[email protected]> wrote:

> Here are possible actions on them:
>
> Ad (1), move these to a new attractive Twitter Bootstrap powered web
> site for the project, like https://atom.io/


+1 This is simply cool.

(Speaking of atom I do have some invites available I believe, although I
cannot say if its any good as I do not own a Mac. Hit me up if you are
interested.)


> Ad (2), these are collaboratively edited guides, aka real wiki pages.
> Move to GitHub Wiki?  GitHub pages?  Other CMS?
>

GitHub pages maybe, as part of the (1) site or just GitHub wiki works too.


> Ad (3), these could come either built-in with the module sources (in
> reST), or else they may have evolved from earlier RFC, see next point.
>

Seems like we are moving towards more in-source docs with reST and sphinx.
I guess more verbose pages could be it's own .rst file under docs/ similar
to how the few HowTos created on pu are. See
https://github.com/jirikuncar/invenio/tree/pu/docs/developers


> Ad (4), we currently have some RFC-like discussions happening:
>
>   (4b) via GitHub issues, for example:
>        https://github.com/jirikuncar/invenio/issues/189
>
>   (4c) via Forum discussions, for example:
>        https://forum.invenio-software.org/t/is-pep257-good-for-you/39/last
>

I am for either GitHub issues or forum. Not sure what is best. GitHub is
somewhat closer to code and makes for easier referencing of issues and/or
code. Although the forum may be better for discussions. Hmm, I think my
money goes towards GitHub issues.


> Ad (5) and (6), these could be auto-generated on the new user-facing
> site (see (1) above) from GitHub.
>

Yay! This would be nice.

Cheers,
Jan

Reply via email to