From 6345b676cd48799da2af9bc3939a0f620098d1fe Mon Sep 17 00:00:00 2001 From: Axon Date: Sat, 26 Sep 2015 03:16:18 +0000 Subject: [PATCH] Clean up and sort developer documentation --- developers/ContributorsList.md | 16 ----- developers/SystemDoc.md | 71 ++++++++++--------- developers/Trusted_parts.md | 8 --- .../BuildingArchlinuxTemplate.md | 0 .../BuildingNonFedoraTemplate.md | 0 .../{ => building}/DevelopmentWorkflow.md | 0 .../{ => building}/InstallationIsoBuilding.md | 0 developers/{ => building}/KdeDom0.md | 0 developers/{ => building}/QubesBuilder.md | 0 .../{ => building}/QubesBuilderDetails.md | 0 developers/{ => building}/QubesR3Building.md | 0 developers/{ => building}/USBVM.md | 0 .../{ContributingHowto.md => contributing.md} | 8 ++- developers/{ => debugging}/AutomatedTests.md | 0 developers/{ => debugging}/Profiling.md | 0 developers/{ => debugging}/TestBench.md | 0 developers/{ => debugging}/VMInterface.md | 0 .../{ => debugging}/WindowsDebugging.md | 0 developers/{ => fundamentals}/GUIdocs.md | 0 .../{ => fundamentals}/QubesArchitecture.md | 0 developers/{ => fundamentals}/QubesNet.md | 0 .../SecurityCriticalCode.md | 0 .../TemplateImplementation.md | 0 developers/{QubesLicensing.md => license.md} | 8 ++- ...BugReportingGuide.md => reporting-bugs.md} | 8 ++- developers/{ => services}/DVMimpl.md | 0 .../{ => services}/Dom0SecureUpdates.md | 0 developers/{ => services}/Qfilecopy.md | 0 developers/{ => services}/Qfileexchgd.md | 0 developers/{ => services}/Qmemman.md | 0 developers/{ => services}/Qrexec.md | 0 .../{ => services}/Qrexec2Implementation.md | 0 developers/{ => services}/Qrexec3.md | 0 .../{ => services}/Qrexec3Implementation.md | 0 doc.md | 9 ++- 35 files changed, 55 insertions(+), 73 deletions(-) delete mode 100644 developers/ContributorsList.md delete mode 100644 developers/Trusted_parts.md rename developers/{ => building}/BuildingArchlinuxTemplate.md (100%) rename developers/{ => building}/BuildingNonFedoraTemplate.md (100%) rename developers/{ => building}/DevelopmentWorkflow.md (100%) rename developers/{ => building}/InstallationIsoBuilding.md (100%) rename developers/{ => building}/KdeDom0.md (100%) rename developers/{ => building}/QubesBuilder.md (100%) rename developers/{ => building}/QubesBuilderDetails.md (100%) rename developers/{ => building}/QubesR3Building.md (100%) rename developers/{ => building}/USBVM.md (100%) rename developers/{ContributingHowto.md => contributing.md} (94%) rename developers/{ => debugging}/AutomatedTests.md (100%) rename developers/{ => debugging}/Profiling.md (100%) rename developers/{ => debugging}/TestBench.md (100%) rename developers/{ => debugging}/VMInterface.md (100%) rename developers/{ => debugging}/WindowsDebugging.md (100%) rename developers/{ => fundamentals}/GUIdocs.md (100%) rename developers/{ => fundamentals}/QubesArchitecture.md (100%) rename developers/{ => fundamentals}/QubesNet.md (100%) rename developers/{ => fundamentals}/SecurityCriticalCode.md (100%) rename developers/{ => fundamentals}/TemplateImplementation.md (100%) rename developers/{QubesLicensing.md => license.md} (93%) rename developers/{BugReportingGuide.md => reporting-bugs.md} (95%) rename developers/{ => services}/DVMimpl.md (100%) rename developers/{ => services}/Dom0SecureUpdates.md (100%) rename developers/{ => services}/Qfilecopy.md (100%) rename developers/{ => services}/Qfileexchgd.md (100%) rename developers/{ => services}/Qmemman.md (100%) rename developers/{ => services}/Qrexec.md (100%) rename developers/{ => services}/Qrexec2Implementation.md (100%) rename developers/{ => services}/Qrexec3.md (100%) rename developers/{ => services}/Qrexec3Implementation.md (100%) diff --git a/developers/ContributorsList.md b/developers/ContributorsList.md deleted file mode 100644 index 31ef1af5..00000000 --- a/developers/ContributorsList.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -layout: doc -title: ContributorsList -permalink: /doc/ContributorsList/ -redirect_from: /wiki/ContributorsList/ ---- - -List of Qubes developers ------------------------- - -- Joanna Rutkowska (Invisible Things Lab) - initial idea, architecture, core, packaging - -- Rafal Wojtczuk (Invisible Things Lab) - architecture, gui virtualization, core - -- Tomasz Sterna (TLS) - installer - diff --git a/developers/SystemDoc.md b/developers/SystemDoc.md index 8f8aa192..9e8ace48 100644 --- a/developers/SystemDoc.md +++ b/developers/SystemDoc.md @@ -8,43 +8,44 @@ redirect_from: /wiki/SystemDoc/ System Documentation for Developers =================================== -1. Fundamentals: - 1. Qubes OS Architecture - 1. [Overview](/doc/QubesArchitecture/) - 2. [Architecture Spec v0.3 [PDF]](http://files.qubes-os.org/files/doc/arch-spec-0.3.pdf) (The original 2009 document that started this all...) - 2. [Security-critical elements of Qubes OS](/doc/SecurityCriticalCode/) - 3. Qubes RPC framework (qrexec): - 1. [The Qubes RPC/Service API](/doc/Qrexec/) - 2. Example for writing a qrexec service in Qubes OS [blog post](http://theinvisiblethings.blogspot.com/2013/02/converting-untrusted-pdfs-into-trusted.html) - 3. [qrexec implementation in Qubes R2](/doc/Qrexec2Implementation/) - 4. [qrexec implementation in Qubes R3/Odyssey](/doc/Qrexec3Implementation/) +Fundamentals +------------ + * [Qubes OS Architecture Overview](/doc/QubesArchitecture/) + * [Qubes OS Architecture Spec v0.3 [PDF]](http://files.qubes-os.org/files/doc/arch-spec-0.3.pdf) (The original 2009 document that started this all...) + * [Security-critical elements of Qubes OS](/doc/SecurityCriticalCode/) + * Qubes RPC: [`qrexec` v2](/doc/Qrexec/) ([R2 implementation](/doc/Qrexec2Implementation/)) + * Qubes RPC: [`qrexec` v3](/doc/Qrexec3/) ([R3 implementation](/doc/Qrexec3Implementation/)) (Odyssey) + * [Example for writing a `qrexec` service in Qubes OS (blog post)](http://theinvisiblethings.blogspot.com/2013/02/converting-untrusted-pdfs-into-trusted.html) + * [Qubes GUI virtualization protocol](/doc/GUIdocs/) + * [Networking in Qubes](/doc/QubesNet/) + * [Implementation of template sharing and updating](/doc/TemplateImplementation/) - 4. [Qubes GUI virtualization protocol](/doc/GUIdocs/) - 5. [Networking in Qubes](/doc/QubesNet/) - 6. [Implementation of template sharing and updating](/doc/TemplateImplementation/) +Services +-------- + * [Inter-domain file copying](/doc/Qfilecopy/) (deprecates [`qfileexchgd`](/doc/Qfileexchgd/)) + * [Dynamic memory management in Qubes](/doc/Qmemman/) + * [Implementation of DisposableVMs](/doc/DVMimpl/) + * [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html) + * [Dom0 secure update mechanism](/doc/Dom0SecureUpdates/) + * VM secure update mechanism (forthcoming) -2. Services: - 1. [Inter-domain file copying](/doc/Qfilecopy/) - 2. [Dynamic memory management in Qubes](/doc/Qmemman/) - 3. [Implementation of DisposableVMs](/doc/DVMimpl/) - 4. [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html) - 5. [Dom0 secure update mechanism](/doc/Dom0SecureUpdates/) - 6. [VM secure update mechanism?](/doc/VMSecureUpdates/) +Debugging +--------- + * [Profiling python code](/doc/Profiling/) + * [Test environment in separate machine for automatic tests](/doc/TestBench/) + * [Automated tests](/doc/AutomatedTests/) + * [VM-dom0 internal configuration interface](/doc/VMInterface/) + * [Debugging Windows VMs](/doc/WindowsDebugging/) -3. Debugging: - 1. [Profiling python code](/doc/Profiling/) - 2. [Test environment in separate machine for automatic tests](/doc/TestBench/) - 3. [Automated tests](/doc/AutomatedTests/) - 3. [VM-dom0 internal configuration interface](/doc/VMInterface/) - 4. [Debugging Windows VMs](/doc/WindowsDebugging/) - -4. Building: - 1. [Building Qubes](/doc/QubesBuilder/) - 2. [Development Workflow](/doc/DevelopmentWorkflow/) - 3. [KDE Dom0 packages for Qubes](/doc/KdeDom0/) - 4. [How to build Qubes installation ISO](/doc/InstallationIsoBuilding/) - 5. [Building USB passthrough support (experimental)](/doc/USBVM/) - 6. [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/BuildingNonFedoraTemplate/) - 7. [Building the Archlinux Template](/doc/BuildingArchlinuxTemplate/) +Building +-------- + * [Building Qubes](/doc/QubesBuilder/) (["API" Details](/doc/QubesBuilderDetails/)) + * [Development Workflow](/doc/DevelopmentWorkflow/) + * [KDE Dom0 packages for Qubes](/doc/KdeDom0/) + * [How to build Qubes installation ISO](/doc/InstallationIsoBuilding/) + * [Building Qubes OS 3.0 ISO](/doc/QubesR3Building/) + * [Building USB passthrough support (experimental)](/doc/USBVM/) + * [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/BuildingNonFedoraTemplate/) + * [Building the Archlinux Template](/doc/BuildingArchlinuxTemplate/) diff --git a/developers/Trusted_parts.md b/developers/Trusted_parts.md deleted file mode 100644 index 99d13d91..00000000 --- a/developers/Trusted_parts.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -layout: doc -title: Trusted_parts -permalink: /doc/Trusted_parts/ -redirect_from: /wiki/Trusted_parts/ ---- - - diff --git a/developers/BuildingArchlinuxTemplate.md b/developers/building/BuildingArchlinuxTemplate.md similarity index 100% rename from developers/BuildingArchlinuxTemplate.md rename to developers/building/BuildingArchlinuxTemplate.md diff --git a/developers/BuildingNonFedoraTemplate.md b/developers/building/BuildingNonFedoraTemplate.md similarity index 100% rename from developers/BuildingNonFedoraTemplate.md rename to developers/building/BuildingNonFedoraTemplate.md diff --git a/developers/DevelopmentWorkflow.md b/developers/building/DevelopmentWorkflow.md similarity index 100% rename from developers/DevelopmentWorkflow.md rename to developers/building/DevelopmentWorkflow.md diff --git a/developers/InstallationIsoBuilding.md b/developers/building/InstallationIsoBuilding.md similarity index 100% rename from developers/InstallationIsoBuilding.md rename to developers/building/InstallationIsoBuilding.md diff --git a/developers/KdeDom0.md b/developers/building/KdeDom0.md similarity index 100% rename from developers/KdeDom0.md rename to developers/building/KdeDom0.md diff --git a/developers/QubesBuilder.md b/developers/building/QubesBuilder.md similarity index 100% rename from developers/QubesBuilder.md rename to developers/building/QubesBuilder.md diff --git a/developers/QubesBuilderDetails.md b/developers/building/QubesBuilderDetails.md similarity index 100% rename from developers/QubesBuilderDetails.md rename to developers/building/QubesBuilderDetails.md diff --git a/developers/QubesR3Building.md b/developers/building/QubesR3Building.md similarity index 100% rename from developers/QubesR3Building.md rename to developers/building/QubesR3Building.md diff --git a/developers/USBVM.md b/developers/building/USBVM.md similarity index 100% rename from developers/USBVM.md rename to developers/building/USBVM.md diff --git a/developers/ContributingHowto.md b/developers/contributing.md similarity index 94% rename from developers/ContributingHowto.md rename to developers/contributing.md index 5efb0c21..be4bc2a7 100644 --- a/developers/ContributingHowto.md +++ b/developers/contributing.md @@ -1,8 +1,10 @@ --- layout: doc -title: ContributingHowto -permalink: /doc/ContributingHowto/ -redirect_from: /wiki/ContributingHowto/ +title: Contributing +permalink: /doc/contributing/ +redirect_from: +- "/doc/ContributingHowto/" +- "/wiki/ContributingHowto/" --- How can I contribute to the Qubes Project? diff --git a/developers/AutomatedTests.md b/developers/debugging/AutomatedTests.md similarity index 100% rename from developers/AutomatedTests.md rename to developers/debugging/AutomatedTests.md diff --git a/developers/Profiling.md b/developers/debugging/Profiling.md similarity index 100% rename from developers/Profiling.md rename to developers/debugging/Profiling.md diff --git a/developers/TestBench.md b/developers/debugging/TestBench.md similarity index 100% rename from developers/TestBench.md rename to developers/debugging/TestBench.md diff --git a/developers/VMInterface.md b/developers/debugging/VMInterface.md similarity index 100% rename from developers/VMInterface.md rename to developers/debugging/VMInterface.md diff --git a/developers/WindowsDebugging.md b/developers/debugging/WindowsDebugging.md similarity index 100% rename from developers/WindowsDebugging.md rename to developers/debugging/WindowsDebugging.md diff --git a/developers/GUIdocs.md b/developers/fundamentals/GUIdocs.md similarity index 100% rename from developers/GUIdocs.md rename to developers/fundamentals/GUIdocs.md diff --git a/developers/QubesArchitecture.md b/developers/fundamentals/QubesArchitecture.md similarity index 100% rename from developers/QubesArchitecture.md rename to developers/fundamentals/QubesArchitecture.md diff --git a/developers/QubesNet.md b/developers/fundamentals/QubesNet.md similarity index 100% rename from developers/QubesNet.md rename to developers/fundamentals/QubesNet.md diff --git a/developers/SecurityCriticalCode.md b/developers/fundamentals/SecurityCriticalCode.md similarity index 100% rename from developers/SecurityCriticalCode.md rename to developers/fundamentals/SecurityCriticalCode.md diff --git a/developers/TemplateImplementation.md b/developers/fundamentals/TemplateImplementation.md similarity index 100% rename from developers/TemplateImplementation.md rename to developers/fundamentals/TemplateImplementation.md diff --git a/developers/QubesLicensing.md b/developers/license.md similarity index 93% rename from developers/QubesLicensing.md rename to developers/license.md index 418e190c..45a9f47c 100644 --- a/developers/QubesLicensing.md +++ b/developers/license.md @@ -1,8 +1,10 @@ --- layout: doc -title: QubesLicensing -permalink: /doc/QubesLicensing/ -redirect_from: /wiki/QubesLicensing/ +title: License +permalink: /doc/license/ +redirect_from: +- "/doc/QubesLicensing/" +- "/wiki/QubesLicensing/" --- Qubes OS License diff --git a/developers/BugReportingGuide.md b/developers/reporting-bugs.md similarity index 95% rename from developers/BugReportingGuide.md rename to developers/reporting-bugs.md index 9ba46aed..306b19bd 100644 --- a/developers/BugReportingGuide.md +++ b/developers/reporting-bugs.md @@ -1,8 +1,10 @@ --- layout: doc -title: BugReportingGuide -permalink: /doc/BugReportingGuide/ -redirect_from: /wiki/BugReportingGuide/ +title: Reporting Bugs +permalink: /doc/reporting-bugs/ +redirect_from: +- "/doc/BugReportingGuide/" +- "/wiki/BugReportingGuide/" --- Bug Reporting Guide diff --git a/developers/DVMimpl.md b/developers/services/DVMimpl.md similarity index 100% rename from developers/DVMimpl.md rename to developers/services/DVMimpl.md diff --git a/developers/Dom0SecureUpdates.md b/developers/services/Dom0SecureUpdates.md similarity index 100% rename from developers/Dom0SecureUpdates.md rename to developers/services/Dom0SecureUpdates.md diff --git a/developers/Qfilecopy.md b/developers/services/Qfilecopy.md similarity index 100% rename from developers/Qfilecopy.md rename to developers/services/Qfilecopy.md diff --git a/developers/Qfileexchgd.md b/developers/services/Qfileexchgd.md similarity index 100% rename from developers/Qfileexchgd.md rename to developers/services/Qfileexchgd.md diff --git a/developers/Qmemman.md b/developers/services/Qmemman.md similarity index 100% rename from developers/Qmemman.md rename to developers/services/Qmemman.md diff --git a/developers/Qrexec.md b/developers/services/Qrexec.md similarity index 100% rename from developers/Qrexec.md rename to developers/services/Qrexec.md diff --git a/developers/Qrexec2Implementation.md b/developers/services/Qrexec2Implementation.md similarity index 100% rename from developers/Qrexec2Implementation.md rename to developers/services/Qrexec2Implementation.md diff --git a/developers/Qrexec3.md b/developers/services/Qrexec3.md similarity index 100% rename from developers/Qrexec3.md rename to developers/services/Qrexec3.md diff --git a/developers/Qrexec3Implementation.md b/developers/services/Qrexec3Implementation.md similarity index 100% rename from developers/Qrexec3Implementation.md rename to developers/services/Qrexec3Implementation.md diff --git a/doc.md b/doc.md index 1c962eee..85493cd7 100644 --- a/doc.md +++ b/doc.md @@ -138,15 +138,14 @@ Reference Pages For Developers -------------- - * [Developer Documentation](/doc/SystemDoc/) + * [System Documentation](/doc/SystemDoc/) * [Developers' FAQ](/doc/DevelFaq/) - * [How can I contribute to the Qubes project?](/doc/ContributingHowto/) - * [Bug Reporting Guide](/doc/BugReportingGuide/) + * [How to Contribute to the Qubes OS Project](/doc/contributing/) + * [Bug Reporting Guide](/doc/reporting-bugs/) * [Source Code](/doc/SourceCode/) * [Qubes OS Version Scheme](/doc/VersionScheme/) * [Coding Guidelines](/doc/CodingStyle/) * [Documentation Guidelines](/doc/doc-guidelines/) * [Books for Developers](/doc/DevelBooks/) * [Research Papers](/doc/QubesResearch/) - * [Architecture](/doc/QubesArchitecture/) - * [Licensing](/doc/QubesLicensing/) + * [Licensing](/doc/license/)