Documentation updates

draft_specifications
meerkat 2021-10-31 23:15:27 +11:00
parent 4284922908
commit 5ff155ee5f
5 changed files with 35 additions and 12 deletions

View File

@ -30,7 +30,6 @@ assist in reconciling the document contents once received. Refer to the
[source programming folders](source/) for more details or [Tools](tools.md) for more general
information
[!div class="op_single_selector"]
- [Java](source/java/README.md)
- [golang](source/golang/README.md)
- [python](source/python/README.md)

View File

@ -1,6 +1,6 @@
# Documentation
**martiLQ** stands for metadata reconcilation for transfer information.
**martiLQ** stands for metadata reconcilation for transfer information, load quality
Before starting with **martiLQ** it is advisable to understand if it is right for
your organisation's needs. Information is available in a number of short
@ -13,12 +13,16 @@ can adjust if they resonate with your circumstances,
## Index
1. [What is martiLQ](what.md)
2. [Who would use martiLQ](who.md)
1. [Objective](objective.md)
2. [martiLQ](martiLQ.md)
3. [Why you would use martiLQ](why.md)
4. [When would you start using martiLQ](when.md)
5. [Load quality metrics support](quality.md)
6. [Comparison of martiLQ definition](comparison.md)
7. [References](references.md)
4. [What is martiLQ](what.md)
5. [When would you start using martiLQ](when.md)
6. [Who would use martiLQ](who.md)
7. [Resources definition](resources.md)
8. [Attributes definition](attributes.md)
9. [Custom definition](custom.md)
10. [Load quality metrics support](quality.md)
11. [Comparison of martiLQ definition](comparison.md)
12. [References](references.md)
[!INCLUDE [martiLQ High Level Definition](martiLQ.md)]

View File

@ -1,3 +1,9 @@
# Place maker
A future home for a docker image for
using the **martiLQ** framework.
The plan is to use Golang binary with local configuration file
to generate or reconcile a **martiLQ** definition into a Docker image.
This is more as a demonstrate of capabioities of **martiLQ** in cloud scenarios.

View File

@ -1,3 +1,3 @@
# Place maker
# .NET Place maker
A future home for C# code for **martiLQ**

View File

@ -1,3 +1,17 @@
# Place maker
# Golang
There is a working prototype of the **martiLQ** framework in Go.
Check out the source code under [client](client/)
The prototype is able to:
* Initialise by creating a config file
* Create a JSON **martiLQ** definition file based on files in a directory
__TO COME__
Publish of Golan package is yet to occur. A binary executable will also be
published for Linux and Windows of the prototype.
This will occur after merge of code into ``main`` branch.