cc-ing a list...
---------- Forwarded message ---------- From: Lukasz Szybalski Date: Tue, Apr 29, 2008 at 11:05 AM Subject: Re: [TurboGears] #1646: Documentation Strategy To: Christopher Arndt On Tue, Apr 29, 2008 at 10:27 AM, Christopher Arndt <[EMAIL PROTECTED]> wrote: > Hi Lukasz, > > Lukasz Szybalski schrieb: > > > I am staring to play with sphinx and index.rst for tg 1.0 > > > > I found that the information is really spread out. > > Example: > > install > > > > > 4. 1.0/Install > > These are the standard generic installation instrauctions. They should work > for every supported system. > > > > 3. 1.0/DebianInstall > > > > 7. 1.0/InstallDebian > > 8. 1.0/InstallFreeBSD > > 9. 1.0/InstallMac > > 10. 1.0/InstallNix > > > > 14. 1.0/InstallUbuntu > > 15. 1.0/InstallWindows > > > > These are system-specific instructions. They are necessary because > different system come with different requirements and pre-installed > features. I'm not sure how much duplication happens on these pages, but one could put them all in one page "installation with table of content that would list these specific platforms" similar thing that python docs do. > > > 13. 1.0/InstallTroubleshooting > > 5. 1.0/InstallBehindProxy > > These are for specific installation problems. They have grown over time as > people encounter problems. > > > 18. 1.0/Uninstall > > This is not about installation but de-installation > > > 11. 1.0/InstallNonRoot > > > 16. 1.0/InstallingFromSubversion > > 17. 1.0/OfflineInstall > > 12. 1.0/InstallOldVersions > > 6. 1.0/InstallBeta > > These are for alternative installation methods. > > > > 1. 1.0/DataBaseInstallation > > 2. 1.0/DatabaseInstallation > > These are concerned with database installation, not with core TG > installation. > > > > > 19. 1.1/RoughDocs/Install > > > > This for TG version 1.1 > > > > > 23. HelpOnInstalling > > 24. HelpOnInstalling/AolServer > > 25. HelpOnInstalling/ApacheOnLinux > > 26. HelpOnInstalling/ApacheOnLinuxFtp > > 27. HelpOnInstalling/ApacheOnMacOsx > > 28. HelpOnInstalling/ApacheOnWin32 > > 29. HelpOnInstalling/ApacheWithModPython > > 30. HelpOnInstalling/BasicInstallation > > 31. HelpOnInstalling/FastCgi > > 32. HelpOnInstalling/InternetInformationServer > > 33. HelpOnInstalling/MinimalWiki > > 34. HelpOnInstalling/StandaloneServer > > 35. HelpOnInstalling/TroubleShooting > > 36. HelpOnInstalling/TwistedWeb > > 37. HelpOnInstalling/WebLogic > > 38. HelpOnInstalling/WikiInstanceCreation > > 39. HelpOnPackageInstaller > > 40. MoinMoin/InstallDocs > > Could we move them to /1.1/HelpOnInstalling/WebLogic /1.1/....... I think that is how sphinx downloads the docs for versions. It looks at first argument. 1.0,1.1,2.0 > > > These are MoinMoin documents. They have nothing to do with TurboGears at > all. > > > > > 41. roughdocs/uninstall > > 42. ru/1.0/OfflineInstall > > > > These are Russian translations. > > > > > Can I condense these that deal with install to max 5 pages? > > > > Please don't override any of these pages directly. How about you create a > page first that lists / links to all installation related pages and gives a > 1-sentence description. Maybe as a Sphinx toctree? You can then submit this > new page as an attachment to a trac ticket (or put in somewhere on the wiki > below RoughDocs and post a link) and I will commit it to Subversion. > I think it will be easier for me to create a subpage in roughdocs and work from there. I wish there was some webpage that had moin vs rst syntax examples. I know moinmoin I don't know rst that well. > For example: > > * `Installation <1.0/Install>`_ - Standard generic installation > instructions. Read this first! > > * System-specific installation instructions > > * `Windows installation <1.0/InstallWindows>`_ > Windows-specific installation instructions > * `Unix/Linux installation <1.0/InstallNix>`_ > ... > * ... > > * Alternative installation methods > > * `Installation without root-Access <1.0/InstallNonRoot>`_ > How to instal TurboGears without root-Access in your homedirectory > or a virtua environment. > * ... > > ... and so on. > > When we have donw that, we can weed out duplication. --~--~---------~--~----~------------~-------~--~----~ You received this message because you are subscribed to the Google Groups "TurboGears Docs" group. To post to this group, send email to [email protected] To unsubscribe from this group, send email to [EMAIL PROTECTED] For more options, visit this group at http://groups.google.com/group/turbogears-docs?hl=en -~----------~----~----~----~------~----~------~--~---
