From 0a0c7c59b7186df72eea3f2b099532ca05bc0bac Mon Sep 17 00:00:00 2001 From: Stein Magnus Jodal Date: Thu, 13 Sep 2012 15:17:10 +0200 Subject: [PATCH] docs: Merge development docs into a single document --- docs/changes.rst | 4 +- .../contributing.rst => development.rst} | 39 +++++++++++++++++-- docs/development/index.rst | 9 ----- docs/development/roadmap.rst | 34 ---------------- docs/index.rst | 2 +- docs/installation/index.rst | 2 +- 6 files changed, 40 insertions(+), 50 deletions(-) rename docs/{development/contributing.rst => development.rst} (81%) delete mode 100644 docs/development/index.rst delete mode 100644 docs/development/roadmap.rst diff --git a/docs/changes.rst b/docs/changes.rst index de447dee..c6b7e0ac 100644 --- a/docs/changes.rst +++ b/docs/changes.rst @@ -860,8 +860,8 @@ In the last two months, Mopidy's MPD frontend has gotten lots of stability fixes and error handling improvements, proper support for having the same track multiple times in a playlist, and support for IPv6. We have also fixed the choppy playback on the libspotify backend. For the road ahead of us, we got an -updated :doc:`release roadmap ` with our goals for the 0.1 -to 0.3 releases. +updated :doc:`release roadmap ` with our goals for the 0.1 to 0.3 +releases. Enjoy the best alpha relase of Mopidy ever :-) diff --git a/docs/development/contributing.rst b/docs/development.rst similarity index 81% rename from docs/development/contributing.rst rename to docs/development.rst index 74e2f0b5..c5020bd9 100644 --- a/docs/development/contributing.rst +++ b/docs/development.rst @@ -1,11 +1,42 @@ -***************** -How to contribute -***************** +*********** +Development +*********** Development of Mopidy is coordinated through the IRC channel ``#mopidy`` at ``irc.freenode.net`` and through `GitHub `_. +Release schedule +================ + +We intend to have about one timeboxed feature release every month +in periods of active development. The feature releases are numbered 0.x.0. The +features added is a mix of what we feel is most important/requested of the +missing features, and features we develop just because we find them fun to +make, even though they may be useful for very few users or for a limited use +case. + +Bugfix releases, numbered 0.x.y, will be released whenever we discover bugs +that are too serious to wait for the next feature release. We will only release +bugfix releases for the last feature release. E.g. when 0.3.0 is released, we +will no longer provide bugfix releases for the 0.2 series. In other words, +there will be just a single supported release at any point in time. + + +Feature wishlist +================ + +We maintain our collection of sane or less sane ideas for future Mopidy +features as `issues `_ at GitHub +labeled with `the "wishlist" label +`_. Feel free to vote +up any feature you would love to see in Mopidy, but please refrain from adding +a comment just to say "I want this too!". You are of course free to add +comments if you have suggestions for how the feature should work or be +implemented, and you may add new wishlist issues if your ideas are not already +represented. + + Code style ========== @@ -125,6 +156,7 @@ statistics and uses pylint to check for errors and possible improvements in our code. So, if you're out of work, the code coverage and pylint data at the CI server should give you a place to start. + Protocol debugging ================== @@ -167,6 +199,7 @@ To ensure that Mopidy and MPD have comparable state it is suggested you setup both to use ``tests/data/library_tag_cache`` for their tag cache and ``tests/data`` for music/playlist folders. + Writing documentation ===================== diff --git a/docs/development/index.rst b/docs/development/index.rst deleted file mode 100644 index 321b3242..00000000 --- a/docs/development/index.rst +++ /dev/null @@ -1,9 +0,0 @@ -*********** -Development -*********** - -.. toctree:: - :maxdepth: 3 - - roadmap - contributing diff --git a/docs/development/roadmap.rst b/docs/development/roadmap.rst deleted file mode 100644 index 6280762c..00000000 --- a/docs/development/roadmap.rst +++ /dev/null @@ -1,34 +0,0 @@ -******* -Roadmap -******* - - -Release schedule -================ - -We intend to have about one timeboxed feature release every month -in periods of active development. The feature releases are numbered 0.x.0. The -features added is a mix of what we feel is most important/requested of the -missing features, and features we develop just because we find them fun to -make, even though they may be useful for very few users or for a limited use -case. - -Bugfix releases, numbered 0.x.y, will be released whenever we discover bugs -that are too serious to wait for the next feature release. We will only release -bugfix releases for the last feature release. E.g. when 0.3.0 is released, we -will no longer provide bugfix releases for the 0.2 series. In other words, -there will be just a single supported release at any point in time. - - -Feature wishlist -================ - -We maintain our collection of sane or less sane ideas for future Mopidy -features as `issues `_ at GitHub -labeled with `the "wishlist" label -`_. Feel free to vote -up any feature you would love to see in Mopidy, but please refrain from adding -a comment just to say "I want this too!". You are of course free to add -comments if you have suggestions for how the feature should work or be -implemented, and you may add new wishlist issues if your ideas are not already -represented. diff --git a/docs/index.rst b/docs/index.rst index 7e757de0..0af510d0 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -54,7 +54,7 @@ Development documentation .. toctree:: :maxdepth: 3 - development/index + development Indices and tables ================== diff --git a/docs/installation/index.rst b/docs/installation/index.rst index 766616ac..66b920f8 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -173,7 +173,7 @@ If you want to contribute to Mopidy, you should install Mopidy using Git. For an introduction to ``git``, please visit `git-scm.com `_. Also, please read our :doc:`developer documentation -`. +`. From AUR on ArchLinux