Organizing the wiki
We've been gradually building up articles on the wiki, which is good because wiki == good, but it can be a bit overwhelming for someone new because they won't know where to start.
I propose reorganizing the articles under the Development section: I don't want to constrain things too much, but I think slotting things in more clearly will be helpful for both new and old alike.
We're partway there because of the fine work people have put into Dev Getting Started, but I want to sit down and rethink the split a bit.
What I have in mind is to split up the pages into one-time steps and steps that have to be repeated over and over again, and revise how things are arranged and highlighted in Dev Getting Started. So instead of having a Bugzilla page and a Github page and etc, we have something like the following:
-
-
- one-time setup
- dev environment (scratch installation / getting a hack)
- bugzilla (registering, username conventions)
- github (forking etc)
- CLA
- working on stuff (the basics)
- programming guidelines
- finding things
- claiming a bug -> submitting a pull request, including conventions etc
- editing in case of a review
- updating code (dev maintenance)
- one-time setup
-
This is more specific resources. Everything under here to be a subpage of /Development?
- everything in the getting started section
- submitting hotfixes on a release branch /Development/Release
- setting up various modules /Development/Setup? Tools? Server?
- schwartz /Development/Setup/Schwartz
- gearman
- search / sphinx
- memcache
- howto /Development/Howto
- new userprop
- database table (create, edit)
- edit a database table
- memcache
- beta feature
- enable shop items
- enable paid time
- stuff under /admin (/admin/pay, etc)
- explain stuff under /dev (/dev/classes, /dev/eventoutput, etc)
-
The examples provided aren't definitive, just examples of what we have and need off the top of my head. There are plenty of articles on the wiki that aren't yet in this list but could fit (most probably under /Development).
Would this structure be helpful for you? What would be most useful to highlight in Dev Getting Started? I'd like to request that we focus on overall structure before specific page suggestions as much as we can, so that it's easier for people to find what they need in the pages we already have.