634263 - update kuma installation & docs

Status: RESOLVED FIXED

(developer.mozilla.org Graveyard :: Wiki pages, defect, P1)

Description

[Luke Crouch [:groovecoder]]

Kuma docs borrow all the Kitsune language. Need to walk thru the docs setting up Kuma and update them.

Comment 1

[Luke Crouch [:groovecoder]]

Les, can you do quick read over the kuma docs and see if they line up with what you did for the vagrant stuff? Then we can close this bug and fix the docs as we go.

Comment 2

[Les Orchard [:lorchard]]

(In reply to comment #1)
> Les, can you do
> quick read over the kuma docs and see if they line up with what you did for
> the vagrant stuff? Then we can close this bug and fix the docs as we go.

Well... the installation process there is almost completely different with respect to what I did for vagrant. It uses RHEL/CentOS packages and sets up DekiWiki. Not sure they really compare

Comment 3

[Les Orchard [:lorchard]]

(In reply to comment #2)
> (In reply to comment #1)
> > Les, can you do
> > quick read over the kuma docs and see if they line up with what you did for
> > the vagrant stuff? Then we can close this bug and fix the docs as we go.
> 
> Well... the installation process there is almost completely different with
> respect to what I did for vagrant. It uses RHEL/CentOS packages and sets up
> DekiWiki. Not sure they really compare

I'm assuming you're talking about docs/installation.rst?

Comment 4

[Luke Crouch [:groovecoder]]

> I'm assuming you're talking about docs/installation.rst?

that and anything else in docs/*.rst.

so you made, e.g., an rpm for the kuma code?

Comment 5

[Les Orchard [:lorchard]]

(In reply to comment #4)
> > I'm assuming you're talking about docs/installation.rst?
> 
> that and anything else in docs/*.rst.
> 
> so you made, e.g., an rpm for the kuma code?

No, the kuma code starts from github, and most of the dependencies come from RPMs. I've got a first stab at a README for OS X here:

https://github.com/mozilla/kuma/blob/master/README-vagrant.md

Probably needs to be updated and converted to RST, if that's what we're using. Basically the installation process there, though is:

git clone git://github.com/mozilla/kuma.git
cd kuma
git submodule update --init --recursive
# install VirtualBox 4.0
gem install vagrant
vagrant up

Comment 6

[Luke Crouch [:groovecoder]]

ongoing

Comment 7

[Nickolay_Ponomarev]

With the changes in https://github.com/mozilla/kuma/pull/207 I was able to follow the instructions in installation.rst to set up the dev environment on Mac OS X.

I opened a pull-request https://github.com/mozilla/kuma/pull/234 that makes a few more improvements to the docs, after which I think this bug can be closed.

Comment 8

[[github robot]]

Commit pushed to master at https://github.com/mozilla/kuma

https://github.com/mozilla/kuma/commit/20a72efddebf9702cea587356ce9d4ea1cb55ef1
fix bug 634263: updates to installation docs

* installation.rst markup fixes.

* Create development.rst with common tips.

* Also move tips that apply to vagrant VM from installation.rst to
  development.rst.

* Move README-vagrant.md to docs/ and convert to rst.
  Per https://bugzilla.mozilla.org/show_bug.cgi?id=634263#c5

* Improve installation-vagrant.rst docs.

    * Note that core kuma devs use this method.
    * Don't insist on using gem, while pointing to vagrantup.com, since they
      recommend using DMGs
    * Advice again using the same working directory as for the local
      installation, since that wipes out settings_local.py and breaks
      because of symlinks (e.g. media/uploads) that are host-dependent.
    * Fix the puppet manifest filename to match reality (dev-vagrant.pp)
    * Mention dekiwiki availability, link to development.rst

* Update vagrant motd to mention the proper way to run tests.