Docs in-repo vs. github wiki

Nate Finch nate.finch at canonical.com
Fri May 22 19:27:08 UTC 2015


I just created a wiki page on the juju github repo to hold the information
I typed up about running and writing CI tests, from my experience of the
last week or so: https://github.com/juju/juju/wiki/ci-tests

It occurs to me that much of the documentation that we have in files inside
the repo might be more appropriate in the wiki, such as basically
everything here: https://github.com/juju/juju/tree/master/doc/contributions

The reason that I like the documentation to be in the wiki rather than in
files in the repo is that it lowers the barrier of entry to adding and
updating the documentation... plus it makes the files a lot more casually
browseable.

Certainly, if we have documentation that is likely to change per-branch,
then living in the repo makes sense... but I think that for things that are
likely to be long-lived, like contributing docs, development how-to docs,
etc, then the wiki has many benefits.

Thoughts?

-Nate
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20150522/3ef8d3c8/attachment.html>


More information about the Juju-dev mailing list