Docs in-repo vs. github wiki

[Andrew Wilkins]

On Sat, May 23, 2015 at 3:27 AM, Nate Finch <nate.finch at canonical.com>
wrote:

> 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.
>

Sounds good. I'd like to see the contents of the juju/juju/docs directory
on the wiki, cross-referenced. It'd be nice to build up docs about the
model, and about how various pieces (e.g. bootstrap) work.

My initial concern was that it might mean I can't access things on my
machine, without the Internet, but the wiki is Git-based so that's no
problem.


> Thoughts?
>
> -Nate
>
>
>
>
> --
> Juju-dev mailing list
> Juju-dev at lists.ubuntu.com
> Modify settings or unsubscribe at:
> https://lists.ubuntu.com/mailman/listinfo/juju-dev
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju-dev/attachments/20150525/1a5d9c80/attachment.html>