Update doc developer

doc/src/README.md

@@ -55,9 +55,9 @@ The documentation keeps track of libmicrovmi's [integration status](https://wenz
 
 ## Documentation
 
-Our documentation is available in `doc/` as an [`mdbook`](https://rust-lang.github.io/mdBook/) 📖
+Our documentation is hosted online at [![online_docs](https://img.shields.io/badge/Online-Documentation-green)](https://wenzel.github.io/libmicrovmi/)
 
-[![online_docs](https://img.shields.io/badge/Online-Documentation-green)](https://wenzel.github.io/libmicrovmi/)
+You can find it at `doc/` as an [`mdbook`](https://rust-lang.github.io/mdBook/) 📖
 
 To build the docs locally:
 ~~~

doc/src/SUMMARY.md

@@ -27,4 +27,7 @@
 
 # Developer
 
+- [libmicrovmi](./developer/libmicrovmi.md)
 - [Python](./developer/python.md)
+- [Tests](./developer/tests.md)
+- [Release](./developer/release.md)

doc/src/developer/libmicrovmi.md

@@ -0,0 +1,36 @@
+# libmicrovmi
+
+## Compiling the crate
+
+Compiling the crate without any driver:
+~~~
+cargo build
+~~~
+
+## Enabling drivers
+
+Enabling Xen and KVM drivers:
+~~~
+cargo build --features xen,kvm
+~~~
+
+Please look at the [drivers](https://wenzel.github.io/libmicrovmi/reference/drivers.html) section
+for each driver's requirements.
+
+## Running the examples
+
+Specifing no example will list all available examples:
+~~~
+cargo run --example
+~~~
+
+To run the `mem-dump` example, and include the Xen driver:
+~~~
+cargo run --features xen --example mem-dump
+~~~
+
+To pass arbitrary arguments to an example:
+~~~
+cargo run --example mem-dump -- --help
+cargo run --features kvm --example mem-dump -- --vm_name win10 ----kvm_unix_socket /tmp/introspector
+~~~

doc/src/developer/release.md

@@ -0,0 +1,25 @@
+# Release Management
+
+libmicrovmi project release is handled in the [CI](https://github.com/Wenzel/libmicrovmi/blob/master/.github/workflows/ci.yml), on Github Actions.
+
+If a commit is pushed with a tag matching `v*`, the `release` job of the CI is executed,
+as well as all jobs depending on it.
+
+Release CI related jobs
+
+- `release`: create a Github release
+  - `release_debian`: add a Debian package to the Github release
+  - `release_book`: build and publish the book
+  - `publish`: publish the crate on crates.io
+  - `publis_pypi`: publish the Python bindings on PyPI
+
+## How to make a new release
+
+Release and tags are managed using the [cargo-release](https://github.com/sunng87/cargo-release) tool.
+
+~~~
+$ cargo release --no-dev-version --workspace <patch / minor / major> # will publish both libmicrovmi and the python bindings
+~~~
+
+Note: `cargo-release` can handle the publication on crates.io, but we prefer to manage everything in one place, using the CI.
+Therefore, publishing has been explicitely disabled in `Cargo.toml` for this tool, so no mistakes can happen.

doc/src/developer/tests.md

@@ -0,0 +1,24 @@
+# Integration tests
+
+Instructions for all tests:
+- Update the values in `tests/common/config.rs` according to your environment
+- `cargo test -- --nocapture`: displays the `log` output, useful for debugging
+
+## KVM
+
+**Requirements**
+- virtual machine already configured to be introspected by KVM-VMI
+- VM snapshot with live state
+- [libkvmi](https://github.com/bitdefender/libkvmi)
+- [`virsh`](https://libvirt.org/manpages/virsh.html) tool: (`libvirt-clients` package)
+
+
+The VM state between each test is handled by the following commands:
+- setup: `virsh snapshot-revert <vm_name> --current --running`
+- teardown: `virsh destroy <vm_name>`
+
+**Execution**
+
+~~~
+cargo test --feature kvm
+~~~

doc/src/reference/integration_status.md

@@ -85,7 +85,5 @@ volatility3 could inspect and run its forensics plugins on live memory by
 adding a new URL handler.
 
 - [project](https://github.com/volatilityfoundation/volatility3)
-- [issue](https://github.com/Wenzel/libmicrovmi/issues/161)
-- [fork](https://github.com/Wenzel/volatility3/tree/vm_introspection_handler) (Note: use the `vm_introspection_handler` branch)
 - compatibility: ✅
-
+- [tutorial](https://wenzel.github.io/libmicrovmi/tutorial/integration/volatility3.html)

python/release.toml

@@ -0,0 +1,4 @@
+# cargo-release config file
+
+# don't create pymicrovmi-vxxx tag
+disable-tag = true

tests/README.md

@@ -1,24 +1,3 @@
 # Integration Tests
 
-Instructions for all tests:
-- Update the values in `tests/common/config.rs` according to your environment
-- `cargo test -- --nocapture`: displays the `log` output, useful for debugging
-
-## KVM
-
-**Requirements**
-- virtual machine already configured to be introspected by KVM-VMI
-- VM snapshot with live state
-- [libkvmi](https://github.com/bitdefender/libkvmi)
-- [`virsh`](https://libvirt.org/manpages/virsh.html) tool: (`libvirt-clients` package)
-
-
-The VM state between each test is handled by the following commands:
-- setup: `virsh snapshot-revert <vm_name> --current --running`
-- teardown: `virsh destroy <vm_name>`
-
-**Execution**
-
-~~~
-cargo test --feature kvm
-~~~
+[documentation](https://wenzel.github.io/libmicrovmi/developer/tests.html)

utilities/release.toml

@@ -0,0 +1,4 @@
+# cargo-release config file
+
+# internal crate, skip release process
+disable-release = true