From 260f924840cc8463e9bb13b93003d610366279fb Mon Sep 17 00:00:00 2001 From: Olivier Lambert Date: Thu, 14 Aug 2014 12:58:34 +0200 Subject: [PATCH] reorg folders --- README.md | 14 +- data-model.dot | 62 -- .../administration}/README.md | 0 .../administration}/assets/gosettings.png | Bin .../administration}/assets/loginbad.png | Bin .../administration}/assets/loginok.png | Bin .../administration}/assets/servers.png | Bin .../administration}/assets/users.png | Bin .../administration}/assets/welcome.png | Bin {architecture => doc/architecture}/README.md | 0 .../architecture/architecture.md | 0 .../architecture}/assets/with-xo.jpg | Bin .../architecture}/assets/without-xo.jpg | Bin .../architecture}/assets/xo-arch.jpg | Bin {installation => doc/installation}/README.md | 0 .../installation}/installation_freebsd.md | 0 .../installation}/manual_installation.md | 0 .../installation}/xoa_installation.md | 0 {known_bugs => doc/known_bugs}/README.md | 0 {layout => doc/layout}/README.md | 0 {layout => doc/layout}/assets/filter.png | Bin {layout => doc/layout}/assets/iconmain.png | Bin {layout => doc/layout}/assets/navbar.png | Bin {layout => doc/layout}/assets/navbarhome.png | Bin .../layout}/assets/navbarselected.png | Bin .../layout}/assets/quickactions.png | Bin {layout => doc/layout}/assets/submenus.png | Bin {recipies => doc/recipies}/README.md | 0 {recipies => doc/recipies}/apache-reverse.md | 0 {vm_usage => doc/vm_usage}/README.md | 0 .../vm_usage}/assets/actionbar.png | Bin {vm_usage => doc/vm_usage}/assets/clone.png | Bin .../vm_usage}/assets/confirmdeletevm.png | Bin .../vm_usage}/assets/consoleicon.png | Bin .../vm_usage}/assets/consoleview.png | Bin .../vm_usage}/assets/createvm.png | Bin {vm_usage => doc/vm_usage}/assets/edit.png | Bin .../vm_usage}/assets/edit_snap.png | Bin .../vm_usage}/assets/editpanel.png | Bin {vm_usage => doc/vm_usage}/assets/log.png | Bin .../vm_usage}/assets/mastercheckbox.png | Bin .../vm_usage}/assets/migrate1.png | Bin .../vm_usage}/assets/migrate2.png | Bin .../vm_usage}/assets/more_menu.png | Bin .../vm_usage}/assets/removelogicon.png | Bin .../vm_usage}/assets/snapshoticon.png | Bin .../vm_usage}/assets/snapshotpanel.png | Bin .../vm_usage}/assets/totemplate.png | Bin .../vm_usage}/assets/vmdelete.png | Bin {vm_usage => doc/vm_usage}/assets/vmview.png | Bin imgs/xo-server.svg | 580 ------------------ xapi.md | 11 - 52 files changed, 7 insertions(+), 660 deletions(-) delete mode 100644 data-model.dot rename {administration => doc/administration}/README.md (100%) rename {administration => doc/administration}/assets/gosettings.png (100%) rename {administration => doc/administration}/assets/loginbad.png (100%) rename {administration => doc/administration}/assets/loginok.png (100%) rename {administration => doc/administration}/assets/servers.png (100%) rename {administration => doc/administration}/assets/users.png (100%) rename {administration => doc/administration}/assets/welcome.png (100%) rename {architecture => doc/architecture}/README.md (100%) rename architecture.md => doc/architecture/architecture.md (100%) rename {architecture => doc/architecture}/assets/with-xo.jpg (100%) rename {architecture => doc/architecture}/assets/without-xo.jpg (100%) rename {architecture => doc/architecture}/assets/xo-arch.jpg (100%) rename {installation => doc/installation}/README.md (100%) rename {installation => doc/installation}/installation_freebsd.md (100%) rename {installation => doc/installation}/manual_installation.md (100%) rename {installation => doc/installation}/xoa_installation.md (100%) rename {known_bugs => doc/known_bugs}/README.md (100%) rename {layout => doc/layout}/README.md (100%) rename {layout => doc/layout}/assets/filter.png (100%) rename {layout => doc/layout}/assets/iconmain.png (100%) rename {layout => doc/layout}/assets/navbar.png (100%) rename {layout => doc/layout}/assets/navbarhome.png (100%) rename {layout => doc/layout}/assets/navbarselected.png (100%) rename {layout => doc/layout}/assets/quickactions.png (100%) rename {layout => doc/layout}/assets/submenus.png (100%) rename {recipies => doc/recipies}/README.md (100%) rename {recipies => doc/recipies}/apache-reverse.md (100%) rename {vm_usage => doc/vm_usage}/README.md (100%) rename {vm_usage => doc/vm_usage}/assets/actionbar.png (100%) rename {vm_usage => doc/vm_usage}/assets/clone.png (100%) rename {vm_usage => doc/vm_usage}/assets/confirmdeletevm.png (100%) rename {vm_usage => doc/vm_usage}/assets/consoleicon.png (100%) rename {vm_usage => doc/vm_usage}/assets/consoleview.png (100%) rename {vm_usage => doc/vm_usage}/assets/createvm.png (100%) rename {vm_usage => doc/vm_usage}/assets/edit.png (100%) rename {vm_usage => doc/vm_usage}/assets/edit_snap.png (100%) rename {vm_usage => doc/vm_usage}/assets/editpanel.png (100%) rename {vm_usage => doc/vm_usage}/assets/log.png (100%) rename {vm_usage => doc/vm_usage}/assets/mastercheckbox.png (100%) rename {vm_usage => doc/vm_usage}/assets/migrate1.png (100%) rename {vm_usage => doc/vm_usage}/assets/migrate2.png (100%) rename {vm_usage => doc/vm_usage}/assets/more_menu.png (100%) rename {vm_usage => doc/vm_usage}/assets/removelogicon.png (100%) rename {vm_usage => doc/vm_usage}/assets/snapshoticon.png (100%) rename {vm_usage => doc/vm_usage}/assets/snapshotpanel.png (100%) rename {vm_usage => doc/vm_usage}/assets/totemplate.png (100%) rename {vm_usage => doc/vm_usage}/assets/vmdelete.png (100%) rename {vm_usage => doc/vm_usage}/assets/vmview.png (100%) delete mode 100644 imgs/xo-server.svg delete mode 100644 xapi.md diff --git a/README.md b/README.md index bdaba6e1b..6eb2e05b7 100644 --- a/README.md +++ b/README.md @@ -10,14 +10,14 @@ __XO is evolving fast, so check the [known bugs](./known-bugs.md) file first.__ ## Documentation -* [Installation](./installation/README.md) -* [Administration](./administration/README.md) -* [Layout](./layout/README.md) -* [VM Usage](./vm_usage/README.md) -* [Recipies](./recipies/README.md) -* [Known bugs](./known_bugs/README.md) +* [Installation](./doc/installation/README.md) +* [Administration](./doc/administration/README.md) +* [Layout](./doc/layout/README.md) +* [VM Usage](./doc/vm_usage/README.md) +* [Recipies](./doc/recipies/README.md) +* [Known bugs](./doc/known_bugs/README.md) -Would you like to know more? +Would you like to know more? Check this: * [How to contribute?](./contributing.md) * [Architecture overview](./architecture/README.md) diff --git a/data-model.dot b/data-model.dot deleted file mode 100644 index 08c8f9e72..000000000 --- a/data-model.dot +++ /dev/null @@ -1,62 +0,0 @@ -digraph { - edge [weight = 1] - - // Special node. - xo [color = "#064d99"] - - // Main hierarchy. - { - edge [weight = 2] // Force the main hierarchy to be straight. - node [pin = true] - - host -> PIF - host -> SR - host -> task - host -> VM - - pool -> host - pool -> SR - pool -> VM - - SR -> VDI - - VM -> VIF - - xo -> pool - } - - // Link objects. - { - edge [color = "#4e9a06"] - node [color = "#4e9a06"] - - VBD -> VDI - VBD -> VM - - network -> PIF - network -> VIF - - PBD -> host - PBD -> SR - } - - // Main objects have messages. - { - edge [color = "#e9b96e"] - node [color = "#e9b96e"] - - { - host - pool - SR - VM - } -> message - } - - // Future links. - { - edge [color = red, style = dotted] - - xo -> host - } -} diff --git a/administration/README.md b/doc/administration/README.md similarity index 100% rename from administration/README.md rename to doc/administration/README.md diff --git a/administration/assets/gosettings.png b/doc/administration/assets/gosettings.png similarity index 100% rename from administration/assets/gosettings.png rename to doc/administration/assets/gosettings.png diff --git a/administration/assets/loginbad.png b/doc/administration/assets/loginbad.png similarity index 100% rename from administration/assets/loginbad.png rename to doc/administration/assets/loginbad.png diff --git a/administration/assets/loginok.png b/doc/administration/assets/loginok.png similarity index 100% rename from administration/assets/loginok.png rename to doc/administration/assets/loginok.png diff --git a/administration/assets/servers.png b/doc/administration/assets/servers.png similarity index 100% rename from administration/assets/servers.png rename to doc/administration/assets/servers.png diff --git a/administration/assets/users.png b/doc/administration/assets/users.png similarity index 100% rename from administration/assets/users.png rename to doc/administration/assets/users.png diff --git a/administration/assets/welcome.png b/doc/administration/assets/welcome.png similarity index 100% rename from administration/assets/welcome.png rename to doc/administration/assets/welcome.png diff --git a/architecture/README.md b/doc/architecture/README.md similarity index 100% rename from architecture/README.md rename to doc/architecture/README.md diff --git a/architecture.md b/doc/architecture/architecture.md similarity index 100% rename from architecture.md rename to doc/architecture/architecture.md diff --git a/architecture/assets/with-xo.jpg b/doc/architecture/assets/with-xo.jpg similarity index 100% rename from architecture/assets/with-xo.jpg rename to doc/architecture/assets/with-xo.jpg diff --git a/architecture/assets/without-xo.jpg b/doc/architecture/assets/without-xo.jpg similarity index 100% rename from architecture/assets/without-xo.jpg rename to doc/architecture/assets/without-xo.jpg diff --git a/architecture/assets/xo-arch.jpg b/doc/architecture/assets/xo-arch.jpg similarity index 100% rename from architecture/assets/xo-arch.jpg rename to doc/architecture/assets/xo-arch.jpg diff --git a/installation/README.md b/doc/installation/README.md similarity index 100% rename from installation/README.md rename to doc/installation/README.md diff --git a/installation/installation_freebsd.md b/doc/installation/installation_freebsd.md similarity index 100% rename from installation/installation_freebsd.md rename to doc/installation/installation_freebsd.md diff --git a/installation/manual_installation.md b/doc/installation/manual_installation.md similarity index 100% rename from installation/manual_installation.md rename to doc/installation/manual_installation.md diff --git a/installation/xoa_installation.md b/doc/installation/xoa_installation.md similarity index 100% rename from installation/xoa_installation.md rename to doc/installation/xoa_installation.md diff --git a/known_bugs/README.md b/doc/known_bugs/README.md similarity index 100% rename from known_bugs/README.md rename to doc/known_bugs/README.md diff --git a/layout/README.md b/doc/layout/README.md similarity index 100% rename from layout/README.md rename to doc/layout/README.md diff --git a/layout/assets/filter.png b/doc/layout/assets/filter.png similarity index 100% rename from layout/assets/filter.png rename to doc/layout/assets/filter.png diff --git a/layout/assets/iconmain.png b/doc/layout/assets/iconmain.png similarity index 100% rename from layout/assets/iconmain.png rename to doc/layout/assets/iconmain.png diff --git a/layout/assets/navbar.png b/doc/layout/assets/navbar.png similarity index 100% rename from layout/assets/navbar.png rename to doc/layout/assets/navbar.png diff --git a/layout/assets/navbarhome.png b/doc/layout/assets/navbarhome.png similarity index 100% rename from layout/assets/navbarhome.png rename to doc/layout/assets/navbarhome.png diff --git a/layout/assets/navbarselected.png b/doc/layout/assets/navbarselected.png similarity index 100% rename from layout/assets/navbarselected.png rename to doc/layout/assets/navbarselected.png diff --git a/layout/assets/quickactions.png b/doc/layout/assets/quickactions.png similarity index 100% rename from layout/assets/quickactions.png rename to doc/layout/assets/quickactions.png diff --git a/layout/assets/submenus.png b/doc/layout/assets/submenus.png similarity index 100% rename from layout/assets/submenus.png rename to doc/layout/assets/submenus.png diff --git a/recipies/README.md b/doc/recipies/README.md similarity index 100% rename from recipies/README.md rename to doc/recipies/README.md diff --git a/recipies/apache-reverse.md b/doc/recipies/apache-reverse.md similarity index 100% rename from recipies/apache-reverse.md rename to doc/recipies/apache-reverse.md diff --git a/vm_usage/README.md b/doc/vm_usage/README.md similarity index 100% rename from vm_usage/README.md rename to doc/vm_usage/README.md diff --git a/vm_usage/assets/actionbar.png b/doc/vm_usage/assets/actionbar.png similarity index 100% rename from vm_usage/assets/actionbar.png rename to doc/vm_usage/assets/actionbar.png diff --git a/vm_usage/assets/clone.png b/doc/vm_usage/assets/clone.png similarity index 100% rename from vm_usage/assets/clone.png rename to doc/vm_usage/assets/clone.png diff --git a/vm_usage/assets/confirmdeletevm.png b/doc/vm_usage/assets/confirmdeletevm.png similarity index 100% rename from vm_usage/assets/confirmdeletevm.png rename to doc/vm_usage/assets/confirmdeletevm.png diff --git a/vm_usage/assets/consoleicon.png b/doc/vm_usage/assets/consoleicon.png similarity index 100% rename from vm_usage/assets/consoleicon.png rename to doc/vm_usage/assets/consoleicon.png diff --git a/vm_usage/assets/consoleview.png b/doc/vm_usage/assets/consoleview.png similarity index 100% rename from vm_usage/assets/consoleview.png rename to doc/vm_usage/assets/consoleview.png diff --git a/vm_usage/assets/createvm.png b/doc/vm_usage/assets/createvm.png similarity index 100% rename from vm_usage/assets/createvm.png rename to doc/vm_usage/assets/createvm.png diff --git a/vm_usage/assets/edit.png b/doc/vm_usage/assets/edit.png similarity index 100% rename from vm_usage/assets/edit.png rename to doc/vm_usage/assets/edit.png diff --git a/vm_usage/assets/edit_snap.png b/doc/vm_usage/assets/edit_snap.png similarity index 100% rename from vm_usage/assets/edit_snap.png rename to doc/vm_usage/assets/edit_snap.png diff --git a/vm_usage/assets/editpanel.png b/doc/vm_usage/assets/editpanel.png similarity index 100% rename from vm_usage/assets/editpanel.png rename to doc/vm_usage/assets/editpanel.png diff --git a/vm_usage/assets/log.png b/doc/vm_usage/assets/log.png similarity index 100% rename from vm_usage/assets/log.png rename to doc/vm_usage/assets/log.png diff --git a/vm_usage/assets/mastercheckbox.png b/doc/vm_usage/assets/mastercheckbox.png similarity index 100% rename from vm_usage/assets/mastercheckbox.png rename to doc/vm_usage/assets/mastercheckbox.png diff --git a/vm_usage/assets/migrate1.png b/doc/vm_usage/assets/migrate1.png similarity index 100% rename from vm_usage/assets/migrate1.png rename to doc/vm_usage/assets/migrate1.png diff --git a/vm_usage/assets/migrate2.png b/doc/vm_usage/assets/migrate2.png similarity index 100% rename from vm_usage/assets/migrate2.png rename to doc/vm_usage/assets/migrate2.png diff --git a/vm_usage/assets/more_menu.png b/doc/vm_usage/assets/more_menu.png similarity index 100% rename from vm_usage/assets/more_menu.png rename to doc/vm_usage/assets/more_menu.png diff --git a/vm_usage/assets/removelogicon.png b/doc/vm_usage/assets/removelogicon.png similarity index 100% rename from vm_usage/assets/removelogicon.png rename to doc/vm_usage/assets/removelogicon.png diff --git a/vm_usage/assets/snapshoticon.png b/doc/vm_usage/assets/snapshoticon.png similarity index 100% rename from vm_usage/assets/snapshoticon.png rename to doc/vm_usage/assets/snapshoticon.png diff --git a/vm_usage/assets/snapshotpanel.png b/doc/vm_usage/assets/snapshotpanel.png similarity index 100% rename from vm_usage/assets/snapshotpanel.png rename to doc/vm_usage/assets/snapshotpanel.png diff --git a/vm_usage/assets/totemplate.png b/doc/vm_usage/assets/totemplate.png similarity index 100% rename from vm_usage/assets/totemplate.png rename to doc/vm_usage/assets/totemplate.png diff --git a/vm_usage/assets/vmdelete.png b/doc/vm_usage/assets/vmdelete.png similarity index 100% rename from vm_usage/assets/vmdelete.png rename to doc/vm_usage/assets/vmdelete.png diff --git a/vm_usage/assets/vmview.png b/doc/vm_usage/assets/vmview.png similarity index 100% rename from vm_usage/assets/vmview.png rename to doc/vm_usage/assets/vmview.png diff --git a/imgs/xo-server.svg b/imgs/xo-server.svg deleted file mode 100644 index b5e5d3b45..000000000 --- a/imgs/xo-server.svg +++ /dev/null @@ -1,580 +0,0 @@ - - - -image/svg+xml - - User - - - - - - - - - - - - - - - - - - Xen Orchestra Server - - Xen Server - - -XML-RPC - - - - - - - - - - - - - Interface(TCP)JSON-RPC - - - - - - - Interface(Web Socket)JSON-RPC - - View - - - - - - - - - - - - - - - XO - - - - - - - Xapi - - - - - - - Users - - - - - - - Tokens - - - - - - - Servers - - Model - - - - - - - - - - - - - - API - - Controller - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/xapi.md b/xapi.md deleted file mode 100644 index 1ca737197..000000000 --- a/xapi.md +++ /dev/null @@ -1,11 +0,0 @@ -# Questions - -Why some objects are linked by `OpaqueRef` and others by `UUID`? - -Why values in `event.class` are lowercased? - -Why isn't `event.snapshot` undocumented? - -Why some of the `VM_metrics` are documented but not working anymore? (RRD seems the right way) - -Why does `event.next` hang up when the pool master is changed instead of the proper error?