From 00fdc7bdee4f27ad04237bae49aa87ef75a69fb4 Mon Sep 17 00:00:00 2001 From: Will Kahn-Greene Date: Tue, 12 Apr 2011 19:56:04 -0400 Subject: [PATCH] Fixes docs. * fixes some typos * tweaks some language issues that occured because I took Chris' stuff out of the context of the original READMEish structure * ditches installation for deploymenthowto and hackinghowto --- docs/deploymenthowto.rst | 5 +++++ docs/designdecisions.rst | 9 ++++----- docs/hackinghowto.rst | 5 +++++ docs/index.rst | 3 ++- docs/installation.rst | 5 ----- 5 files changed, 16 insertions(+), 11 deletions(-) create mode 100644 docs/deploymenthowto.rst create mode 100644 docs/hackinghowto.rst delete mode 100644 docs/installation.rst diff --git a/docs/deploymenthowto.rst b/docs/deploymenthowto.rst new file mode 100644 index 00000000..64baf5c8 --- /dev/null +++ b/docs/deploymenthowto.rst @@ -0,0 +1,5 @@ +================== + Deployment HOWTO +================== + +FIXME - write this! diff --git a/docs/designdecisions.rst b/docs/designdecisions.rst index f30c1ca5..b5992fc1 100644 --- a/docs/designdecisions.rst +++ b/docs/designdecisions.rst @@ -47,7 +47,7 @@ Why WSGI Minimalism Chris Webber on "Why WSGI Minimalism": - If you notice in the technology list above, I list a lot of + If you notice in the technology listI list a lot of components that are very `Django Project`_, but not actually Django components. What can I say, I really like a lot of the ideas in Django! Which leads to the question: why not just use @@ -144,12 +144,12 @@ Chris Webber on "Why MongoDB": dawg, I heard you liked plugins, so I put a database in your database so you can query while you query.) Gross. - I also don't want things to be too lose so that we forget or lose + I also don't want things to be too loose so that we forget or lose the structure of things, and that's one reason why I want to use MongoKit, because we can cleanly define a much structure as we want and verify that documents match that structure generally - without adding too much bloat or overhead (mongokit is a pretty - lightweight wrapper and doesn't inject extra mongokit-specific + without adding too much bloat or overhead (MongoKit is a pretty + lightweight wrapper and doesn't inject extra MongoKit-specific stuff into the database, which is nice and nicer than many other ORMs in that way). @@ -167,4 +167,3 @@ Will Kahn-Greene on "Why Sphinx": There are other doc systems out there, but given that GNU MediaGoblin is being written in Python, it makes sense to use Sphinx for now. - diff --git a/docs/hackinghowto.rst b/docs/hackinghowto.rst new file mode 100644 index 00000000..93cd5ddc --- /dev/null +++ b/docs/hackinghowto.rst @@ -0,0 +1,5 @@ +=============== + Hacking HOWTO +=============== + +FIXME - write this! diff --git a/docs/index.rst b/docs/index.rst index 6f96ff8c..965d5d7a 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -20,7 +20,8 @@ Contents: foreward softwarestack - installation + deploymenthowto + hackinghowto designdecisions diff --git a/docs/installation.rst b/docs/installation.rst deleted file mode 100644 index 2dfd467d..00000000 --- a/docs/installation.rst +++ /dev/null @@ -1,5 +0,0 @@ -============== - Installation -============== - -FIXME - this page is a stub! -- 2.25.1