From 5fbf73b03f90c50189f13edb4a2d8f5bf26242ae Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Fri, 18 Jul 2014 14:32:46 -0700 Subject: [PATCH 1/5] Move glossary to main documentation index --- docs/development.rst | 1 - docs/index.rst | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development.rst b/docs/development.rst index 594c885aff..7a10eea3ba 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -10,7 +10,6 @@ Development Discussions codingconventions newdeveloperguide - glossary unittesting seleniumtesting crashreprofilteringreport diff --git a/docs/index.rst b/docs/index.rst index 43dd3b25c6..b46fa31ef4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,6 +40,7 @@ Contents: database generic_app writingdocs + glossary Indices and tables From 3b73c10c6dacb24fd9f486eb0f313dd3a5b2bb8a Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Fri, 18 Jul 2014 14:36:34 -0700 Subject: [PATCH 2/5] Move glossary referenced docs under glossary. Change index toctree to point to glossary index. --- docs/{ => glossary}/collector.rst | 0 docs/{ => glossary}/crashmover.rst | 0 docs/{ => glossary}/deferredcleanup.rst | 0 docs/{ => glossary}/deferredjobstorage.rst | 0 docs/{ => glossary}/filesystem.rst | 0 docs/{glossary.rst => glossary/index.rst} | 0 docs/{ => glossary}/jsondumpstorage.rst | 0 docs/{ => glossary}/monitor.rst | 0 docs/{ => glossary}/processeddumpstorage.rst | 0 docs/{ => glossary}/reporter.rst | 0 docs/{ => glossary}/signaturegeneration.rst | 0 docs/{ => glossary}/standardjobstorage.rst | 0 docs/{ => glossary}/topcrashersbysignature.rst | 0 docs/{ => glossary}/topcrashersbyurl.rst | 0 docs/index.rst | 2 +- 15 files changed, 1 insertion(+), 1 deletion(-) rename docs/{ => glossary}/collector.rst (100%) rename docs/{ => glossary}/crashmover.rst (100%) rename docs/{ => glossary}/deferredcleanup.rst (100%) rename docs/{ => glossary}/deferredjobstorage.rst (100%) rename docs/{ => glossary}/filesystem.rst (100%) rename docs/{glossary.rst => glossary/index.rst} (100%) rename docs/{ => glossary}/jsondumpstorage.rst (100%) rename docs/{ => glossary}/monitor.rst (100%) rename docs/{ => glossary}/processeddumpstorage.rst (100%) rename docs/{ => glossary}/reporter.rst (100%) rename docs/{ => glossary}/signaturegeneration.rst (100%) rename docs/{ => glossary}/standardjobstorage.rst (100%) rename docs/{ => glossary}/topcrashersbysignature.rst (100%) rename docs/{ => glossary}/topcrashersbyurl.rst (100%) diff --git a/docs/collector.rst b/docs/glossary/collector.rst similarity index 100% rename from docs/collector.rst rename to docs/glossary/collector.rst diff --git a/docs/crashmover.rst b/docs/glossary/crashmover.rst similarity index 100% rename from docs/crashmover.rst rename to docs/glossary/crashmover.rst diff --git a/docs/deferredcleanup.rst b/docs/glossary/deferredcleanup.rst similarity index 100% rename from docs/deferredcleanup.rst rename to docs/glossary/deferredcleanup.rst diff --git a/docs/deferredjobstorage.rst b/docs/glossary/deferredjobstorage.rst similarity index 100% rename from docs/deferredjobstorage.rst rename to docs/glossary/deferredjobstorage.rst diff --git a/docs/filesystem.rst b/docs/glossary/filesystem.rst similarity index 100% rename from docs/filesystem.rst rename to docs/glossary/filesystem.rst diff --git a/docs/glossary.rst b/docs/glossary/index.rst similarity index 100% rename from docs/glossary.rst rename to docs/glossary/index.rst diff --git a/docs/jsondumpstorage.rst b/docs/glossary/jsondumpstorage.rst similarity index 100% rename from docs/jsondumpstorage.rst rename to docs/glossary/jsondumpstorage.rst diff --git a/docs/monitor.rst b/docs/glossary/monitor.rst similarity index 100% rename from docs/monitor.rst rename to docs/glossary/monitor.rst diff --git a/docs/processeddumpstorage.rst b/docs/glossary/processeddumpstorage.rst similarity index 100% rename from docs/processeddumpstorage.rst rename to docs/glossary/processeddumpstorage.rst diff --git a/docs/reporter.rst b/docs/glossary/reporter.rst similarity index 100% rename from docs/reporter.rst rename to docs/glossary/reporter.rst diff --git a/docs/signaturegeneration.rst b/docs/glossary/signaturegeneration.rst similarity index 100% rename from docs/signaturegeneration.rst rename to docs/glossary/signaturegeneration.rst diff --git a/docs/standardjobstorage.rst b/docs/glossary/standardjobstorage.rst similarity index 100% rename from docs/standardjobstorage.rst rename to docs/glossary/standardjobstorage.rst diff --git a/docs/topcrashersbysignature.rst b/docs/glossary/topcrashersbysignature.rst similarity index 100% rename from docs/topcrashersbysignature.rst rename to docs/glossary/topcrashersbysignature.rst diff --git a/docs/topcrashersbyurl.rst b/docs/glossary/topcrashersbyurl.rst similarity index 100% rename from docs/topcrashersbyurl.rst rename to docs/glossary/topcrashersbyurl.rst diff --git a/docs/index.rst b/docs/index.rst index b46fa31ef4..b95db1b12f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -40,7 +40,7 @@ Contents: database generic_app writingdocs - glossary + glossary/index Indices and tables From 2e79b04ad1a4d1991ffe632f740d93a94cb15d45 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Fri, 18 Jul 2014 14:40:12 -0700 Subject: [PATCH 3/5] Update link in development docs to jsondumpstorage Move required images under glossary directory. --- docs/development.rst | 2 +- docs/{ => glossary}/ProcessedDumpStorage.1.0.png | Bin .../Socorro.directory.diagram.2.2.png | Bin 3 files changed, 1 insertion(+), 1 deletion(-) rename docs/{ => glossary}/ProcessedDumpStorage.1.0.png (100%) rename docs/{ => glossary}/Socorro.directory.diagram.2.2.png (100%) diff --git a/docs/development.rst b/docs/development.rst index 7a10eea3ba..09045b0c99 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -15,7 +15,7 @@ Development Discussions crashreprofilteringreport diskperformancetests dumpingdumptables - jsondumpstorage + glossary/jsondumpstorage processeddumpstorage fs database diff --git a/docs/ProcessedDumpStorage.1.0.png b/docs/glossary/ProcessedDumpStorage.1.0.png similarity index 100% rename from docs/ProcessedDumpStorage.1.0.png rename to docs/glossary/ProcessedDumpStorage.1.0.png diff --git a/docs/Socorro.directory.diagram.2.2.png b/docs/glossary/Socorro.directory.diagram.2.2.png similarity index 100% rename from docs/Socorro.directory.diagram.2.2.png rename to docs/glossary/Socorro.directory.diagram.2.2.png From e33931b865a67264bc34047f9fc3bdc78ee439a9 Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Fri, 18 Jul 2014 14:42:19 -0700 Subject: [PATCH 4/5] Rename 'Development Discussions' to 'Contributing' --- docs/{development.rst => contributing.rst} | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) rename docs/{development.rst => contributing.rst} (77%) diff --git a/docs/development.rst b/docs/contributing.rst similarity index 77% rename from docs/development.rst rename to docs/contributing.rst index 09045b0c99..5d1b84136f 100644 --- a/docs/development.rst +++ b/docs/contributing.rst @@ -1,9 +1,9 @@ -.. index:: development +.. index:: contributing -.. _development-chapter: +.. _contributing-chapter: -Development Discussions -======================= +Contributing +============ .. toctree:: :maxdepth: 2 From 2205d4b5d461df62c034f4fdf17f02841c969d6a Mon Sep 17 00:00:00 2001 From: Trevor Bramwell Date: Fri, 18 Jul 2014 14:45:01 -0700 Subject: [PATCH 5/5] Fix reference in index to development document Fixes bug 1040248 --- docs/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index b95db1b12f..b5c8c5a4ac 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -36,7 +36,7 @@ Contents: crashstorage crontabber throttling - development + contributing database generic_app writingdocs