Permalink
Browse files

bring docs back home

  • Loading branch information...
rhelmer committed Nov 15, 2011
1 parent a8b4020 commit 2f0f714995cc04e2f76c01b8ab76198fb33c8f31
Showing with 6,025 additions and 77 deletions.
  1. +1 −0 .gitignore
  2. +4 −4 README
  3. +130 −0 docs/Makefile
  4. BIN docs/ProcessedDumpStorage.1.0.png
  5. +0 −8 docs/README.txt
  6. BIN docs/Socorro.directory.diagram.2.2.png
  7. BIN docs/SocorroSchema.Aggregate.20090722.png
  8. BIN docs/SocorroSchema.CrashData.20090722.png
  9. BIN docs/SocorroSchema_2_0.png
  10. +369 −0 docs/codeanddatabaseupdate.rst
  11. +37 −0 docs/codingconventions.rst
  12. +55 −0 docs/collector.rst
  13. +132 −0 docs/commonconfig.rst
  14. +216 −0 docs/conf.py
  15. +87 −0 docs/crashmover.rst
  16. +62 −0 docs/crashreprofilteringreport.rst
  17. +36 −0 docs/databaseadminfunctions.rst
  18. +374 −0 docs/databaseschema.rst
  19. +107 −0 docs/databasesetup.rst
  20. +136 −0 docs/databasetablesbysource.rst
  21. +116 −0 docs/deferredcleanup.rst
  22. +22 −0 docs/deferredjobstorage.rst
  23. +25 −0 docs/deployment.rst
  24. +27 −0 docs/development.rst
  25. +183 −0 docs/diskperformancetests.rst
  26. +89 −0 docs/dumpingdumptables.rst
  27. +12 −0 docs/filesystem.rst
  28. +112 −0 docs/glossary.rst
  29. +45 −0 docs/index.rst
  30. +123 −65 INSTALL → docs/installation.rst
  31. +173 −0 docs/jsondumpstorage.rst
  32. +170 −0 docs/make.bat
  33. +158 −0 docs/middleware.rst
  34. +173 −0 docs/monitor.rst
  35. +62 −0 docs/overview.rst
  36. +29 −0 docs/package.rst
  37. +87 −0 docs/processeddumpstorage.rst
  38. +19 −0 docs/processor.rst
  39. +107 −0 docs/reportdatabasedesign.rst
  40. +12 −0 docs/reporter.rst
  41. +40 −0 docs/requirements.rst
  42. BIN docs/schema.original.png
  43. BIN docs/schema.partitioned.001.png
  44. +427 −0 docs/schema.rst
  45. +26 −0 docs/server.rst
  46. +90 −0 docs/signaturegeneration.rst
  47. +70 −0 docs/standalone.rst
  48. +21 −0 docs/standardjobstorage.rst
  49. +64 −0 docs/throttling.rst
  50. +32 −0 docs/tools/rstrip.py
  51. +49 −0 docs/topcrashersbysignature.rst
  52. +113 −0 docs/topcrashersbyurl.rst
  53. +332 −0 docs/ui.rst
  54. +204 −0 docs/uiinstallation.rst
  55. +39 −0 docs/uitroubleshooting.rst
  56. +86 −0 docs/unittesting.rst
  57. +869 −0 docs/upgrade.rst
  58. +73 −0 docs/writingdocs.rst
View
@@ -13,3 +13,4 @@ socorro-virtualenv
socorro/unittest/database/logs/
socorro/unittest/testlib/logs/
stackwalk/
+docs/_build/
View
8 README
@@ -1,14 +1,14 @@
Socorro
A server for collecting, processing, and displaying crash reports from
-clients using the Breakpad libraries.
+clients using the Breakpad libraries - http://code.google.com/p/google-breakpad/
-https://github.com/mozilla/socorro
-http://code.google.com/p/google-breakpad/
+See http://socorro.readthedocs.org/en/latest/installation.html for installation instructions.
Socorro mailing list:
https://lists.mozilla.org/listinfo/tools-socorro
Socorro/Breakpad IRC channel:
irc://irc.mozilla.org/breakpad
-See the INSTALL file for installation instructions.
+You can find the Socorro documentation online at http://socorro.readthedocs.org
+The documentation source is in ./docs/
View
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = _build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/Socorro.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/Socorro.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/Socorro"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/Socorro"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
Binary file not shown.
View
@@ -1,8 +0,0 @@
-The Socorro documentation is in a separate module:
-https://github.com/mozilla/socorro-docs
-
-The docs can be read online using Read The Docs:
-http://socorro.readthedocs.org
-
-If you are interested in writing docs please see:
-http://socorro.readthedocs.org/en/latest/writingdocs.html
Binary file not shown.
Binary file not shown.
Binary file not shown.
View
Binary file not shown.
Oops, something went wrong.

0 comments on commit 2f0f714

Please sign in to comment.