IntenseFinance/nosqlbench
3
0
Fork 0
mirror of https://github.com/nosqlbench/nosqlbench.git synced 2025-02-25 18:55:28 -06:00
Code Issues Packages Projects Releases Wiki Activity

update app docs

Browse Source
This commit is contained in:
Jonathan Shook
2023-01-17 19:30:03 -06:00
parent 1ea5c8a1e5
commit 2847543aa5
2 changed files with 111 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
nbr/src/main/resources/export-docs.md Normal file
View File

@@ -0,0 +1,17 @@
# export-docs
This is the built-in app that allows NB5 to export docs for integration into other systems.
During a build of NB5, this app is used to auto-inject much of the content into the doc site.
Invoking it as `nb5 export-docs` creates (or overwrites) a file called `exported-docs.zip`,
containing the markdown source files for binding functions, bundled apps, specifications, and so on.
Using this mechanism ensures that:
1. NB5 contributors who build drivers, bindings, or other modular pieces can use idiomatic forms of
documentation, allowing them to work in one code base.
2. Contributors are encouraged to make integrated tests follow a literate programming pattern,
so that they work as examples as well as verification tools.
3. Users of NB5 will never see documentation which is included in integrated tests, because any
failing test will prevent a failed build from being published or considered for a release.
This is a relatively new mechanism that will be improved further.