[meta] Create competent developer documentation

RESOLVED INCOMPLETE

Status

Webmaker
General
RESOLVED INCOMPLETE
5 years ago
a year ago

People

(Reporter: sedge, Unassigned)

Tracking

Details

Attachments

(2 attachments, 1 obsolete attachment)

(Reporter)

Description

5 years ago
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.
(Reporter)

Updated

5 years ago
Depends on: 939845
(Reporter)

Updated

5 years ago
Depends on: 939856
(Reporter)

Updated

5 years ago
Depends on: 939859
(Reporter)

Updated

5 years ago
Depends on: 939860
(Reporter)

Updated

5 years ago
Depends on: 939877
(Reporter)

Updated

5 years ago
Depends on: 939882
(Reporter)

Updated

5 years ago
Depends on: 939885
(Reporter)

Updated

5 years ago
Depends on: 939887
(Reporter)

Comment 2

5 years ago
Created attachment 8339456 [details]
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.
Attachment #8339456 - Flags: review?(david.humphrey)
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
Attachment #8339456 - Flags: review?(david.humphrey) → review-
(Reporter)

Comment 4

4 years ago
Created attachment 8343125 [details]
https://wiki.mozilla.org/Webmaker/Code#Setup_Option_2:_Local_Native_Installation

Updated according to your review and I also added Ubuntu installation instructions.
Attachment #8339456 - Attachment is obsolete: true
Attachment #8343125 - Flags: review?(david.humphrey)
(Reporter)

Updated

4 years ago
Attachment #8343125 - Flags: review?
(Reporter)

Updated

4 years ago
Attachment #8343125 - Flags: review?
(Reporter)

Comment 5

4 years ago
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
(Reporter)

Updated

4 years ago
Attachment #8343125 - Flags: review?(david.humphrey)
(Reporter)

Updated

3 years ago
Assignee: kieran.sedgwick → nobody
Status: ASSIGNED → NEW
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
Status: NEW → RESOLVED
Last Resolved: a year ago
Resolution: --- → INCOMPLETE
You need to log in before you can comment on or make changes to this bug.