Opened 15 years ago
Last modified 15 years ago
#237 closed task (FIXED)
Move Hacking How To Guides into Documentation
| Reported by: | Sam Kleinman | Owned by: | Sam Kleinman |
|---|---|---|---|
| Priority: | minor | Milestone: | 0.1.0 |
| Component: | documentation | Keywords: | |
| Cc: | Parent Tickets: |
Description
I'm working to update and revise a few documents from existing resources into our documentation (i.e. docs/).
http://wiki.mediagoblin.org/HackingHowto
https://gitorious.org/mediagoblin/pages/HackingWithVirtualenv
http://wiki.mediagoblin.org/Storage
http://wiki.mediagoblin.org/Processing
The goal here is to provide an introduction to hacking on MediaGoblin that outlines both "how to get all of the necessary components working," in order to begin hacking on GMG.
As part of this, I want to include sections that answer the questions, "what/where are the (popular) components that one might be interested in working on," (i.e. templates, db schema, configuration files, urlmapping.) and "why are things the way they are," (drawing from existing design documents.)
Change History (4)
comment:1 by , 15 years ago
comment:2 by , 15 years ago
| Milestone: | 0.0.5 → 0.1.0 |
|---|
comment:2 by , 15 years ago
| Status: | New → Closed |
|---|
Marking as closed; superseded by http://bugs.foocorp.net/issues/566 and http://bugs.foocorp.net/issues/311
comment:3 by , 14 years ago
The original url for this bug was http://bugs.foocorp.net/issues/565 .
Relations:
#238: related, #40: related

I think there's some confusion about what the docs/ documentation is all about. It's the manual for site administrators.
The wiki is where we're putting all the contributor-related documentation.
Given that, documentation related to how to contribute should all be in the wiki. Documentation related to configuring and deploying a production instance should be in the docs/ .
Does that make sense?