From 2708a9b77218f4faf0729f41dcc5c3c12103ed9a Mon Sep 17 00:00:00 2001 From: Elizabeth Paige Harper Date: Tue, 28 May 2024 10:30:11 -0400 Subject: [PATCH] update docs --- docs/overview-img/todo.png | Bin 0 -> 1643 bytes docs/overview.adoc | 14 +++++++------- docs/overview.html | 19 ++++++++++++------- 3 files changed, 19 insertions(+), 14 deletions(-) create mode 100644 docs/overview-img/todo.png diff --git a/docs/overview-img/todo.png b/docs/overview-img/todo.png new file mode 100644 index 0000000000000000000000000000000000000000..e764eb0a3c941a490a91e5756ce439e99ba5f2e0 GIT binary patch literal 1643 zcmV-x29)`UP)PDiz}5ij{0@J6C&X zQWR7wW@(`Y*@L2zGKz>+^MS6)W@#&{=Cr$W`s1Fnp1phS?98+?M9c@n+k2VM%E24QGKjVlWpV4vhlJ0b*(`fCEqrXBWdcH96P7SZ>?NF>hiZJdgk$ zNQJ#cLaQDlD}HLBUvD^D362L}2)IR0o`Ry~&{hw_tKcYrqj?Y@U6`a7x5JgCiW~=y zSo!cko`NEP2praY#X!6O*K~+D$dH7!E>wE(nS_2W+^E+{IOD+NO88!>VTgcZ?Qs1< z*q2fO>tKMnneAHt$6=xeQvdXvF~7}x-buA_9EMaw)M8;@D~|6AOf6IYbNJtZ@ZfIX z!=Tj%m8s<`VW$hz3|)0Hj4sEi40a`;SjqV21Qb_8RKUp?^o~G7Jq%aKn*{7Ol`Q?W zKZhMPXBM>U!y)1PVmPM{gkcd!4DRZbAzTaK!X(o%7}j+VES8c13=Es-;--R-!VEjW zg|EU)+5@>3Muu+S!e*dF$+$HJE0m7PJdjBkt0@(5vJ_gi3(?R9qbNWoG0b+}EV`fR z!WIvf0IMwXTU?l#DgsGAOgM%;bc-u(CW4MU0nO@mTnv6RHr)iw3R=A3Ob)s*(ztJO zVW=|dT>_>WVK^;Z#`tL97j-)=20POV5EhsfBH=SiB3FeySOoX$>ost1rnnq9rmvH5 zz?{p-FDcJjW>M#W?w)OhhqbtS!S)Lo;;Qh|HDQ~}hzS>l213IL0higFsv>Bx2ZwIgn_WNx{5Oyu(;*K{j0JFyH_rpjiLR$>4Y#el?~?MB!3> zGYDF2O!tSr5-uody}AxA$p%*#L;-Y0ucXoe=C~qYq>|)2uJ7yd;3?o)0ex&6%=3xw ztEHWQ?ZA{wamC>;J>G3XZ-eJyu<_6u<9e-O&v&GO>h^4Kg$c;XKvkoSM#S+z$k!2f zRIYGIXi)!uW|dY%;EcR@-64(55NW!&tT|V>T-AKZS_75vlX2V8Lpl!E8427+X`pK9 zL0lQ9*jl}HhBVjf>qYQ~ZM_FG3|n@y!R0}N2QnTQk7h{t3hATGMRJ+2>Zv%)1IQAnH$P=Epy zAeVJnx(&!QVNuM8u`0iuCt)=yI^RH>gw=gu>4HF;K2@m{Qa*i`go=f*C)K)tOIJ^U zlLM`OZZJ7jb+TRyGAiMu>|9$$1uRLx-|_ScZxRge*^VWq%UF zAkfh^p;LF;l8sIWwgrYyOBn6K?*{&&3$RDP4S}^aF{lnZ31)ZPNF;9qc8dUC5*E5p z-_vxZ;Qc0`7XR6UNvKhIV17=5!T5`ovBf5%0P2X(x1d-Shas8l>B6VLV-`zWRSW&{ zL024J#&?6a0{ww;4s7+{le{XS9>&UlmoP%WUnz^Pc#c7x*pjN^- p0fz+CRKmN322BA9P=Nn9`~yf3c%^V`=nMb=002ovPDHLkV1g#y`m+E4 literal 0 HcmV?d00001 diff --git a/docs/overview.adoc b/docs/overview.adoc index d61ad35c..4e56171b 100644 --- a/docs/overview.adoc +++ b/docs/overview.adoc @@ -4,6 +4,7 @@ :icons: font :source-highlighter: highlightjs :gh-icon: image:overview-img/github.svg[width=18] +:todo: image:overview-img/todo.png[width=64] The VEuPathDB Dataset Installer system (VDI) is an asynchronous, event driven, pluggable, data ingestion platform built to transform and publish data from an @@ -12,7 +13,6 @@ S3 compatible object store into any number of target systems. .System Overview image::overview-img/outline.svg[align=center] - ''' @@ -21,6 +21,8 @@ absolute point of truth from which all system state is derived. From this origin point, VDI can start from a blank slate and rebuild a state identical to any other VDI instance attached to that object store or a replica. +{todo} There should be some bridge between these 2 paragraphs. + VDI's goal as a platform is to be able to take data of any number of varying types from the source object store and publish that data to any number of relevant target systems. To accomplish that goal, VDI uses external @@ -84,8 +86,8 @@ received in any order, how or when they are acted on is discussed in the [#import-lane] === Import: Data Preprocessing -// TODO: flow chart showing import-ready zip going to plugin and install-ready -// zip returning to minio +{todo} flow chart showing import-ready zip going to plugin and install-ready zip +returning to minio After raw data is uploaded into the object store, the 'first' step (called the "import" step) is to perform data validation and optionally reformatting. @@ -154,8 +156,8 @@ relevant target systems. The -// TODO: the plugin has install meta in it -// TODO: the plugin has check compatibility in it +{todo} the plugin has install meta in it + +{todo} the plugin has check compatibility in it [#sharing-lane] @@ -997,5 +999,3 @@ needing to wait for the full reconciliation run which runs much less frequently. == Document TODOs * VDI's direct (non-plugin) communication with target systems (oracle) -* meta.json contents -* manifest.json contents \ No newline at end of file diff --git a/docs/overview.html b/docs/overview.html index 59e60a0b..fb79188f 100644 --- a/docs/overview.html +++ b/docs/overview.html @@ -554,6 +554,9 @@

VDI: VEuPathDB Dataset Installer

other VDI instance attached to that object store or a replica.

+

todo There should be some bridge between these 2 paragraphs.

+
+

VDI’s goal as a platform is to be able to take data of any number of varying types from the source object store and publish that data to any number of relevant target systems. To accomplish that goal, VDI uses external @@ -650,6 +653,10 @@

Lanes

Import: Data Preprocessing

+

todo flow chart showing import-ready zip going to plugin and install-ready zip +returning to minio

+
+

After raw data is uploaded into the object store, the 'first' step (called the "import" step) is to perform data validation and optionally reformatting.

@@ -747,6 +754,10 @@

Install Data: Dataset Content Installation

The

+
+

todo the plugin has install meta in it
+todo the plugin has check compatibility in it

+

Sharing

@@ -1784,12 +1795,6 @@

Document TODOs

  • VDI’s direct (non-plugin) communication with target systems (oracle)

    • -
  • -

    meta.json contents

    -
    • -
  • -

    manifest.json contents

    -
    • @@ -1797,7 +1802,7 @@

    Document TODOs