939842 - [meta] Create competent developer documentation

Status: RESOLVED INCOMPLETE

(Webmaker Graveyard :: General, defect)

Description

[Kieran Sedgwick (:sedge)]

It's time to document our ecosystem. 

This meta-bug represents the goal of having clear, detailed documentation for how to set up our servers and tools for development.  The target user is one who could contribute, if only they could install things locally.

Follow-up bugs will be filed as needed, and marked as blockers to this bug until the docs are complete.

Comment 1

[Kieran Sedgwick (:sedge)]

Attachment: Rough work || https://gingkoapp.com/webmaker-docs

Comment 2

[Kieran Sedgwick (:sedge)]

Attachment: Mac OS X Instructions | https://wiki.mozilla.org/Webmaker/Code#Setup_Option_2a:_.28Mac_OS_X.29_Local_Native_Installation

Instructions for setting up the dev environment on Mac OS X. Short and sweet, delegating to server READMEs where possible.

Comment 3

[David Humphrey (:humph)]

Comment on attachment 8339456 [details]
Mac OS X Instructions | https://wiki.mozilla.org/Webmaker/Code#Setup_Option_2a:_.28Mac_OS_X.29_Local_Native_Installation

This looks good.  A few things I notice:

* You should separate Mac-specific things from general installation things.  For example, the discussion of .env files, READMEs, order of installing apps, etc. are all the same on every platform.  You should document OS-specific things, then move on to general installation things.

* Re: XCode -- you only need the command line tools, not all of XCode.  It's a lot smaller and a lot simpler to setup that way

Comment 4

[Kieran Sedgwick (:sedge)]

Attachment: https://wiki.mozilla.org/Webmaker/Code#Setup_Option_2:_Local_Native_Installation

Updated according to your review and I also added Ubuntu installation instructions.

Comment 5

[Kieran Sedgwick (:sedge)]

Comment on attachment 8343125 [details]
https://wiki.mozilla.org/Webmaker/Code#Setup_Option_2:_Local_Native_Installation

I've now factored out the developer section into some sub wiki pages. I'll be reviewing these sections next, but for now check out the Developer Environment Guide and the changes to the main page

Comment 6

[Chris DeCairos (:cade)]

Closing this bug as part of the Deprecation of the Webmaker Product on Bugzilla. If this issue needs to re resolved in another manner, re-file it in a new Product or find the associated project on Github (http://github.com/mozilla) and file an issue there.

see bug 1347718