From aadb35d62f38bff08c96820eb75cb033325b309e Mon Sep 17 00:00:00 2001 From: Andrew David Wong Date: Mon, 20 Jun 2016 13:56:20 -0700 Subject: [PATCH] Move all developer documentation to main index QubesOS/qubes-issues#2070 --- {developers => basics_dev}/code-signing.md | 0 {developers => basics_dev}/coding-style.md | 0 {developers => basics_dev}/contributing.md | 0 {developers => basics_dev}/devel-books.md | 0 {developers => basics_dev}/devel-faq.md | 0 {developers => basics_dev}/doc-guidelines.md | 0 {developers => basics_dev}/license.md | 0 {developers => basics_dev}/reporting-bugs.md | 0 {developers => basics_dev}/source-code.md | 0 {developers => basics_dev}/style-guide.md | 0 {developers => basics_dev}/system-doc.md | 0 {developers => basics_dev}/usability-ux.md | 0 {basics => basics_user}/user-faq.md | 0 .../building-archlinux-template.md | 0 .../building-non-fedora-template.md | 0 .../development-workflow.md | 0 {developers/building => building}/kde-dom0.md | 0 {developers/building => building}/pvusb.md | 0 .../qubes-builder-details.md | 0 .../building => building}/qubes-builder.md | 0 .../qubes-r3-building.md | 0 .../automated-tests.md | 0 .../debugging => debugging}/profiling.md | 0 .../debugging => debugging}/test-bench.md | 0 .../debugging => debugging}/vm-interface.md | 0 .../windows-debugging.md | 0 doc.md | 49 +++++++++++++++++-- .../dom0-secure-updates.md | 0 {developers/services => services}/dvm-impl.md | 0 .../services => services}/qfilecopy.md | 0 .../services => services}/qfileexchgd.md | 0 {developers/services => services}/qmemman.md | 0 {developers/services => services}/qrexec2.md | 0 {developers/services => services}/qrexec3.md | 0 .../fundamentals => system}/architecture.md | 0 {developers/fundamentals => system}/gui.md | 0 .../fundamentals => system}/networking.md | 0 .../security-critical-code.md | 0 .../template-implementation.md | 0 39 files changed, 46 insertions(+), 3 deletions(-) rename {developers => basics_dev}/code-signing.md (100%) rename {developers => basics_dev}/coding-style.md (100%) rename {developers => basics_dev}/contributing.md (100%) rename {developers => basics_dev}/devel-books.md (100%) rename {developers => basics_dev}/devel-faq.md (100%) rename {developers => basics_dev}/doc-guidelines.md (100%) rename {developers => basics_dev}/license.md (100%) rename {developers => basics_dev}/reporting-bugs.md (100%) rename {developers => basics_dev}/source-code.md (100%) rename {developers => basics_dev}/style-guide.md (100%) rename {developers => basics_dev}/system-doc.md (100%) rename {developers => basics_dev}/usability-ux.md (100%) rename {basics => basics_user}/user-faq.md (100%) rename {developers/building => building}/building-archlinux-template.md (100%) rename {developers/building => building}/building-non-fedora-template.md (100%) rename {developers/building => building}/development-workflow.md (100%) rename {developers/building => building}/kde-dom0.md (100%) rename {developers/building => building}/pvusb.md (100%) rename {developers/building => building}/qubes-builder-details.md (100%) rename {developers/building => building}/qubes-builder.md (100%) rename {developers/building => building}/qubes-r3-building.md (100%) rename {developers/debugging => debugging}/automated-tests.md (100%) rename {developers/debugging => debugging}/profiling.md (100%) rename {developers/debugging => debugging}/test-bench.md (100%) rename {developers/debugging => debugging}/vm-interface.md (100%) rename {developers/debugging => debugging}/windows-debugging.md (100%) rename {developers/services => services}/dom0-secure-updates.md (100%) rename {developers/services => services}/dvm-impl.md (100%) rename {developers/services => services}/qfilecopy.md (100%) rename {developers/services => services}/qfileexchgd.md (100%) rename {developers/services => services}/qmemman.md (100%) rename {developers/services => services}/qrexec2.md (100%) rename {developers/services => services}/qrexec3.md (100%) rename {developers/fundamentals => system}/architecture.md (100%) rename {developers/fundamentals => system}/gui.md (100%) rename {developers/fundamentals => system}/networking.md (100%) rename {developers/fundamentals => system}/security-critical-code.md (100%) rename {developers/fundamentals => system}/template-implementation.md (100%) diff --git a/developers/code-signing.md b/basics_dev/code-signing.md similarity index 100% rename from developers/code-signing.md rename to basics_dev/code-signing.md diff --git a/developers/coding-style.md b/basics_dev/coding-style.md similarity index 100% rename from developers/coding-style.md rename to basics_dev/coding-style.md diff --git a/developers/contributing.md b/basics_dev/contributing.md similarity index 100% rename from developers/contributing.md rename to basics_dev/contributing.md diff --git a/developers/devel-books.md b/basics_dev/devel-books.md similarity index 100% rename from developers/devel-books.md rename to basics_dev/devel-books.md diff --git a/developers/devel-faq.md b/basics_dev/devel-faq.md similarity index 100% rename from developers/devel-faq.md rename to basics_dev/devel-faq.md diff --git a/developers/doc-guidelines.md b/basics_dev/doc-guidelines.md similarity index 100% rename from developers/doc-guidelines.md rename to basics_dev/doc-guidelines.md diff --git a/developers/license.md b/basics_dev/license.md similarity index 100% rename from developers/license.md rename to basics_dev/license.md diff --git a/developers/reporting-bugs.md b/basics_dev/reporting-bugs.md similarity index 100% rename from developers/reporting-bugs.md rename to basics_dev/reporting-bugs.md diff --git a/developers/source-code.md b/basics_dev/source-code.md similarity index 100% rename from developers/source-code.md rename to basics_dev/source-code.md diff --git a/developers/style-guide.md b/basics_dev/style-guide.md similarity index 100% rename from developers/style-guide.md rename to basics_dev/style-guide.md diff --git a/developers/system-doc.md b/basics_dev/system-doc.md similarity index 100% rename from developers/system-doc.md rename to basics_dev/system-doc.md diff --git a/developers/usability-ux.md b/basics_dev/usability-ux.md similarity index 100% rename from developers/usability-ux.md rename to basics_dev/usability-ux.md diff --git a/basics/user-faq.md b/basics_user/user-faq.md similarity index 100% rename from basics/user-faq.md rename to basics_user/user-faq.md diff --git a/developers/building/building-archlinux-template.md b/building/building-archlinux-template.md similarity index 100% rename from developers/building/building-archlinux-template.md rename to building/building-archlinux-template.md diff --git a/developers/building/building-non-fedora-template.md b/building/building-non-fedora-template.md similarity index 100% rename from developers/building/building-non-fedora-template.md rename to building/building-non-fedora-template.md diff --git a/developers/building/development-workflow.md b/building/development-workflow.md similarity index 100% rename from developers/building/development-workflow.md rename to building/development-workflow.md diff --git a/developers/building/kde-dom0.md b/building/kde-dom0.md similarity index 100% rename from developers/building/kde-dom0.md rename to building/kde-dom0.md diff --git a/developers/building/pvusb.md b/building/pvusb.md similarity index 100% rename from developers/building/pvusb.md rename to building/pvusb.md diff --git a/developers/building/qubes-builder-details.md b/building/qubes-builder-details.md similarity index 100% rename from developers/building/qubes-builder-details.md rename to building/qubes-builder-details.md diff --git a/developers/building/qubes-builder.md b/building/qubes-builder.md similarity index 100% rename from developers/building/qubes-builder.md rename to building/qubes-builder.md diff --git a/developers/building/qubes-r3-building.md b/building/qubes-r3-building.md similarity index 100% rename from developers/building/qubes-r3-building.md rename to building/qubes-r3-building.md diff --git a/developers/debugging/automated-tests.md b/debugging/automated-tests.md similarity index 100% rename from developers/debugging/automated-tests.md rename to debugging/automated-tests.md diff --git a/developers/debugging/profiling.md b/debugging/profiling.md similarity index 100% rename from developers/debugging/profiling.md rename to debugging/profiling.md diff --git a/developers/debugging/test-bench.md b/debugging/test-bench.md similarity index 100% rename from developers/debugging/test-bench.md rename to debugging/test-bench.md diff --git a/developers/debugging/vm-interface.md b/debugging/vm-interface.md similarity index 100% rename from developers/debugging/vm-interface.md rename to debugging/vm-interface.md diff --git a/developers/debugging/windows-debugging.md b/debugging/windows-debugging.md similarity index 100% rename from developers/debugging/windows-debugging.md rename to debugging/windows-debugging.md diff --git a/doc.md b/doc.md index cbfdcbd8..406170f6 100644 --- a/doc.md +++ b/doc.md @@ -10,6 +10,9 @@ redirect_from: - /wiki/QubesDocs/ --- +User Documentation +================== + The Basics ---------- @@ -170,11 +173,12 @@ Presentation Slides * [[PDF] LinuxCon 2014 -- Qubes OS R2 Tutorial](/attachment/wiki/slides/LinuxCon_2014_Qubes_Tutorial.pdf) * [[PDF] LinuxCon 2014 -- Qubes OS Keynote](/attachment/wiki/slides/LinuxCon_2014_Qubes_Keynote.pdf) +Developer Documentation +======================= -For Developers --------------- +The Basics +---------- - * [System Documentation](/doc/system-doc/) * [Developers' FAQ](/doc/devel-faq/) * [Feature Development Tracker](/qubes-issues/) * [Reporting Security Issues](/security/) @@ -189,3 +193,42 @@ For Developers * [Style Guide](/doc/style-guide/) * [Usability & UX](/doc/usability-ux/) +System +------ + * [Qubes OS Architecture Overview](/doc/architecture/) + * [Qubes OS Architecture Spec v0.3 [PDF]](/attachment/wiki/QubesArchitecture/arch-spec-0.3.pdf) + (The original 2009 document that started this all...) + * [Security-critical elements of Qubes OS](/doc/security-critical-code/) + * [Qrexec: command execution in VMs](/doc/qrexec3/) + * [Qubes GUI virtualization protocol](/doc/gui/) + * [Networking in Qubes](/doc/networking/) + * [Implementation of template sharing and updating](/doc/template-implementation/) + +Services +-------- + * [Inter-domain file copying](/doc/qfilecopy/) (deprecates [`qfileexchgd`](/doc/qfileexchgd/)) + * [Dynamic memory management in Qubes](/doc/qmemman/) + * [Implementation of DisposableVMs](/doc/dvm-impl/) + * [Article about disposable VMs](http://theinvisiblethings.blogspot.com/2010/06/disposable-vms.html) + * [Dom0 secure update mechanism](/doc/dom0-secure-updates/) + * VM secure update mechanism (forthcoming) + +Debugging +--------- + * [Profiling python code](/doc/profiling/) + * [Test environment in separate machine for automatic tests](/doc/test-bench/) + * [Automated tests](/doc/automated-tests/) + * [VM-dom0 internal configuration interface](/doc/vm-interface/) + * [Debugging Windows VMs](/doc/windows-debugging/) + +Building +-------- + * [Building Qubes](/doc/qubes-builder/) (["API" Details](/doc/qubes-builder-details/)) + * [Development Workflow](/doc/development-workflow/) + * [KDE Dom0 packages for Qubes](/doc/kde-dom0/) + * [Building Qubes OS 3.0 ISO](/doc/qubes-r3-building/) + * [Building USB passthrough support (experimental)](/doc/pvusb/) + * [Building a TemplateVM based on a new OS (ArchLinux example)](/doc/building-non-fedora-template/) + * [Building the Archlinux Template](/doc/building-archlinux-template/) + + diff --git a/developers/services/dom0-secure-updates.md b/services/dom0-secure-updates.md similarity index 100% rename from developers/services/dom0-secure-updates.md rename to services/dom0-secure-updates.md diff --git a/developers/services/dvm-impl.md b/services/dvm-impl.md similarity index 100% rename from developers/services/dvm-impl.md rename to services/dvm-impl.md diff --git a/developers/services/qfilecopy.md b/services/qfilecopy.md similarity index 100% rename from developers/services/qfilecopy.md rename to services/qfilecopy.md diff --git a/developers/services/qfileexchgd.md b/services/qfileexchgd.md similarity index 100% rename from developers/services/qfileexchgd.md rename to services/qfileexchgd.md diff --git a/developers/services/qmemman.md b/services/qmemman.md similarity index 100% rename from developers/services/qmemman.md rename to services/qmemman.md diff --git a/developers/services/qrexec2.md b/services/qrexec2.md similarity index 100% rename from developers/services/qrexec2.md rename to services/qrexec2.md diff --git a/developers/services/qrexec3.md b/services/qrexec3.md similarity index 100% rename from developers/services/qrexec3.md rename to services/qrexec3.md diff --git a/developers/fundamentals/architecture.md b/system/architecture.md similarity index 100% rename from developers/fundamentals/architecture.md rename to system/architecture.md diff --git a/developers/fundamentals/gui.md b/system/gui.md similarity index 100% rename from developers/fundamentals/gui.md rename to system/gui.md diff --git a/developers/fundamentals/networking.md b/system/networking.md similarity index 100% rename from developers/fundamentals/networking.md rename to system/networking.md diff --git a/developers/fundamentals/security-critical-code.md b/system/security-critical-code.md similarity index 100% rename from developers/fundamentals/security-critical-code.md rename to system/security-critical-code.md diff --git a/developers/fundamentals/template-implementation.md b/system/template-implementation.md similarity index 100% rename from developers/fundamentals/template-implementation.md rename to system/template-implementation.md