Clean up and sort developer documentation

This commit is contained in:
Axon 2015-09-26 03:16:18 +00:00
parent bd877ddc54
commit 6345b676cd
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
35 changed files with 55 additions and 73 deletions

View File

@ -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

View File

@ -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/)

View File

@ -1,8 +0,0 @@
---
layout: doc
title: Trusted_parts
permalink: /doc/Trusted_parts/
redirect_from: /wiki/Trusted_parts/
---

View File

@ -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?

View File

@ -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

View File

@ -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

9
doc.md
View File

@ -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/)