diff --git a/doc/source/architecture.rst b/doc/source/architecture.rst index 150c030..83e5a81 100644 --- a/doc/source/architecture.rst +++ b/doc/source/architecture.rst @@ -44,7 +44,7 @@ High level architecture +--------------------------+ * **Dynamic schema parser** - parses an input from the user and prepares the data which can be consumed by Allocation solver -* **Allocation solver** - an algorithm which takes dynamic schema and produces a static schema +* **Allocation solver** - algorithm which takes dynamic schema and produces a static schema * **Solution convertor** - a result which is produced by solver, should be parsed and converted into `Bareon `_ consumable format, for example for `Logical Volume `_ Solution convertor should generate a physical volume for each disk, where it's allocated Dynamic schema parser @@ -122,7 +122,7 @@ From Hardware Information example we can see that the node has 4096 megabytes of $ram / 2, 4096) -In order to implement an algorithm of swap size calculation we use `YAQL `_, which is small but powerful enough query language. Any value of the parameter which matches to **yaql=yaql expression** will be evaluated using YAQL, execution result will be passed as is to the Solver. +In order to implement algorithm of swap size calculation we use `YAQL `_, which is small but powerful enough query language. Any value of the parameter which matches to **yaql=yaql expression** will be evaluated using YAQL, execution result will be passed as is to the Solver. Allocation solver ----------------- diff --git a/doc/source/index.rst b/doc/source/index.rst index fd48dd0..07fa23a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,8 +3,8 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to bareon-dynamic-allocator's documentation! -======================================================== +Welcome to bareon-allocator's documentation! +============================================ Contents: diff --git a/doc/source/usage.rst b/doc/source/usage.rst index aa12e5d..8d8f070 100644 --- a/doc/source/usage.rst +++ b/doc/source/usage.rst @@ -1,7 +1,5 @@ -======== +===== Usage -======== +===== -To use bareon-dynamic-allocator in a project:: - - import bareon_dynamic_allocator +Has not been released yet, see example of usage in **run.sh** file.