diff --git a/_config.yml b/_config.yml index b1792cc..6559429 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,4 @@ +source: docs remote_theme: just-the-docs/just-the-docs title: Gleaner Docs description: Documentation for Gleaner, Nabu and associated tools and resources diff --git a/CNAME b/docs/CNAME similarity index 100% rename from CNAME rename to docs/CNAME diff --git a/assets/d2/flow.d2 b/docs/assets/d2/flow.d2 similarity index 100% rename from assets/d2/flow.d2 rename to docs/assets/d2/flow.d2 diff --git a/assets/d2/flow.svg b/docs/assets/d2/flow.svg similarity index 100% rename from assets/d2/flow.svg rename to docs/assets/d2/flow.svg diff --git a/assets/d2/flow_orig.d2 b/docs/assets/d2/flow_orig.d2 similarity index 100% rename from assets/d2/flow_orig.d2 rename to docs/assets/d2/flow_orig.d2 diff --git a/assets/d2/notes.txt b/docs/assets/d2/notes.txt similarity index 100% rename from assets/d2/notes.txt rename to docs/assets/d2/notes.txt diff --git a/assets/images/CCADI.png b/docs/assets/images/CCADI.png similarity index 100% rename from assets/images/CCADI.png rename to docs/assets/images/CCADI.png diff --git a/assets/images/IOW.png b/docs/assets/images/IOW.png similarity index 100% rename from assets/images/IOW.png rename to docs/assets/images/IOW.png diff --git a/assets/images/blaze.png b/docs/assets/images/blaze.png similarity index 100% rename from assets/images/blaze.png rename to docs/assets/images/blaze.png diff --git a/assets/images/executableLayout.png b/docs/assets/images/executableLayout.png similarity index 100% rename from assets/images/executableLayout.png rename to docs/assets/images/executableLayout.png diff --git a/assets/images/fairquads.png b/docs/assets/images/fairquads.png similarity index 100% rename from assets/images/fairquads.png rename to docs/assets/images/fairquads.png diff --git a/assets/images/g9.png b/docs/assets/images/g9.png similarity index 100% rename from assets/images/g9.png rename to docs/assets/images/g9.png diff --git a/assets/images/g9.svg b/docs/assets/images/g9.svg similarity index 100% rename from assets/images/g9.svg rename to docs/assets/images/g9.svg diff --git a/assets/images/geocodes.png b/docs/assets/images/geocodes.png similarity index 100% rename from assets/images/geocodes.png rename to docs/assets/images/geocodes.png diff --git a/assets/images/geodexSearch.png b/docs/assets/images/geodexSearch.png similarity index 100% rename from assets/images/geodexSearch.png rename to docs/assets/images/geodexSearch.png diff --git a/assets/images/gleaner.png b/docs/assets/images/gleaner.png similarity index 100% rename from assets/images/gleaner.png rename to docs/assets/images/gleaner.png diff --git a/assets/images/gleaner_activity_diagram.png b/docs/assets/images/gleaner_activity_diagram.png similarity index 100% rename from assets/images/gleaner_activity_diagram.png rename to docs/assets/images/gleaner_activity_diagram.png diff --git a/assets/images/gleaner_ad1.png b/docs/assets/images/gleaner_ad1.png similarity index 100% rename from assets/images/gleaner_ad1.png rename to docs/assets/images/gleaner_ad1.png diff --git a/assets/images/gleaner_ad2.png b/docs/assets/images/gleaner_ad2.png similarity index 100% rename from assets/images/gleaner_ad2.png rename to docs/assets/images/gleaner_ad2.png diff --git a/assets/images/gleanerbasic.png b/docs/assets/images/gleanerbasic.png similarity index 100% rename from assets/images/gleanerbasic.png rename to docs/assets/images/gleanerbasic.png diff --git a/assets/images/gleaneroverview.png b/docs/assets/images/gleaneroverview.png similarity index 100% rename from assets/images/gleaneroverview.png rename to docs/assets/images/gleaneroverview.png diff --git a/assets/images/iow_activity_diagram.png b/docs/assets/images/iow_activity_diagram.png similarity index 100% rename from assets/images/iow_activity_diagram.png rename to docs/assets/images/iow_activity_diagram.png diff --git a/assets/images/jena.png b/docs/assets/images/jena.png similarity index 100% rename from assets/images/jena.png rename to docs/assets/images/jena.png diff --git a/assets/images/jenaLoad1.png b/docs/assets/images/jenaLoad1.png similarity index 100% rename from assets/images/jenaLoad1.png rename to docs/assets/images/jenaLoad1.png diff --git a/assets/images/jenaLoad2.png b/docs/assets/images/jenaLoad2.png similarity index 100% rename from assets/images/jenaLoad2.png rename to docs/assets/images/jenaLoad2.png diff --git a/assets/images/jenaSearch.png b/docs/assets/images/jenaSearch.png similarity index 100% rename from assets/images/jenaSearch.png rename to docs/assets/images/jenaSearch.png diff --git a/assets/images/minio.png b/docs/assets/images/minio.png similarity index 100% rename from assets/images/minio.png rename to docs/assets/images/minio.png diff --git a/assets/images/miniologin.png b/docs/assets/images/miniologin.png similarity index 100% rename from assets/images/miniologin.png rename to docs/assets/images/miniologin.png diff --git a/assets/images/miniostep1.png b/docs/assets/images/miniostep1.png similarity index 100% rename from assets/images/miniostep1.png rename to docs/assets/images/miniostep1.png diff --git a/assets/images/miniostep2.png b/docs/assets/images/miniostep2.png similarity index 100% rename from assets/images/miniostep2.png rename to docs/assets/images/miniostep2.png diff --git a/assets/images/miniostep3.png b/docs/assets/images/miniostep3.png similarity index 100% rename from assets/images/miniostep3.png rename to docs/assets/images/miniostep3.png diff --git a/assets/images/miniostep4.png b/docs/assets/images/miniostep4.png similarity index 100% rename from assets/images/miniostep4.png rename to docs/assets/images/miniostep4.png diff --git a/assets/images/oih.png b/docs/assets/images/oih.png similarity index 100% rename from assets/images/oih.png rename to docs/assets/images/oih.png diff --git a/assets/images/personnas.png b/docs/assets/images/personnas.png similarity index 100% rename from assets/images/personnas.png rename to docs/assets/images/personnas.png diff --git a/assets/images/polder.png b/docs/assets/images/polder.png similarity index 100% rename from assets/images/polder.png rename to docs/assets/images/polder.png diff --git a/assets/images/relations.png b/docs/assets/images/relations.png similarity index 100% rename from assets/images/relations.png rename to docs/assets/images/relations.png diff --git a/assets/images/simpleflow.png b/docs/assets/images/simpleflow.png similarity index 100% rename from assets/images/simpleflow.png rename to docs/assets/images/simpleflow.png diff --git a/assets/images/simplequery.png b/docs/assets/images/simplequery.png similarity index 100% rename from assets/images/simplequery.png rename to docs/assets/images/simplequery.png diff --git a/assets/resources/exampleGleanerConfig.yml b/docs/assets/resources/exampleGleanerConfig.yml similarity index 100% rename from assets/resources/exampleGleanerConfig.yml rename to docs/assets/resources/exampleGleanerConfig.yml diff --git a/assets/resources/implnet_set/gleaner.bin b/docs/assets/resources/implnet_set/gleaner.bin similarity index 100% rename from assets/resources/implnet_set/gleaner.bin rename to docs/assets/resources/implnet_set/gleaner.bin diff --git a/assets/resources/implnet_set/gleanerDocker.sh b/docs/assets/resources/implnet_set/gleanerDocker.sh similarity index 100% rename from assets/resources/implnet_set/gleanerDocker.sh rename to docs/assets/resources/implnet_set/gleanerDocker.sh diff --git a/assets/resources/implnet_set/gleanerconfig.yaml b/docs/assets/resources/implnet_set/gleanerconfig.yaml similarity index 100% rename from assets/resources/implnet_set/gleanerconfig.yaml rename to docs/assets/resources/implnet_set/gleanerconfig.yaml diff --git a/assets/resources/implnet_set/jsonldcontext.json b/docs/assets/resources/implnet_set/jsonldcontext.json similarity index 100% rename from assets/resources/implnet_set/jsonldcontext.json rename to docs/assets/resources/implnet_set/jsonldcontext.json diff --git a/cli.md b/docs/cli.md similarity index 100% rename from cli.md rename to docs/cli.md diff --git a/config.md b/docs/config.md similarity index 99% rename from config.md rename to docs/config.md index 592ae5e..d677c0e 100644 --- a/config.md +++ b/docs/config.md @@ -19,7 +19,7 @@ Examples of their formats respectively are: ### sitemap ```yaml - sourcetype: sitemap + sourcetype: sitemap name: unidata logo: "" url: https://www.unidata.ucar.edu/sitemap.xml diff --git a/dockercli.md b/docs/dockercli.md similarity index 99% rename from dockercli.md rename to docs/dockercli.md index cba5f58..d49de57 100644 --- a/dockercli.md +++ b/docs/dockercli.md @@ -222,7 +222,7 @@ Docker. For me, I had to use a real local IP address for my network, you might Hopefully you will see something like the following. -![Blazegrah](./assets/images/blaze.png) +![Blazegrah](assets/images/blaze.png) We loaded into the default _kb_ namespace, so we should be good there. We can see that is listed as the active namespace at the _Current Namespace: kb_ report. @@ -242,7 +242,7 @@ LIMIT 10 A very simple SPARQL to give us the first 10 results from the triplestore. If all has gone well, we should see something like: -![Blazegrah](./assets/images/simplequery.png) +![Blazegrah](assets/images/simplequery.png) You can explore more about SPARQL and the wide range of queries you can do with it at the W3C [SPARQL 1.1 Query Language](https://www.w3.org/TR/sparql11-query/) reference. diff --git a/faircontext.md b/docs/faircontext.md similarity index 100% rename from faircontext.md rename to docs/faircontext.md diff --git a/gleaner.md b/docs/gleaner.md similarity index 100% rename from gleaner.md rename to docs/gleaner.md diff --git a/index.md b/docs/index.md similarity index 100% rename from index.md rename to docs/index.md diff --git a/nabu.md b/docs/nabu.md similarity index 100% rename from nabu.md rename to docs/nabu.md diff --git a/quickstart.md b/docs/quickstart.md similarity index 99% rename from quickstart.md rename to docs/quickstart.md index 7c3d475..5013572 100644 --- a/quickstart.md +++ b/docs/quickstart.md @@ -10,7 +10,7 @@ nav_order: 6 This document provides a quick approach to the setup and use of gleaner. -![Simple Flow](./assets/images/simpleflow.png) +![Simple Flow](assets/images/simpleflow.png) The basic flow of Gleaner begins with a data source sitemap. That sitemap is read by Gleaner. Gleaner will leverage an object store, S3 compliant, and, if @@ -408,7 +408,7 @@ Docker. For me, I had to use a real local IP address for my network, you might Hopefully you will see something like the following. -![Blazegrah](./assets/images/blaze.png) +![Blazegrah](assets/images/blaze.png) We loaded into the default _kb_ namespace, so we should be good there. We can see that is listed as the active namespace at the _Current Namespace: kb_ report. @@ -428,7 +428,7 @@ LIMIT 10 A very simple SPARQL to give us the first 10 results from the triplestore. If all has gone well, we should see something like: -![Blazegrah](./assets/images/simplequery.png) +![Blazegrah](assets/images/simplequery.png) You can explore more about SPARQL and the wide range of queries you can do with it at the W3C [SPARQL 1.1 Query Language](https://www.w3.org/TR/sparql11-query/) reference. diff --git a/mkdocs.yml b/mkdocs.yml index cc9322b..b7e161a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: Gleaner Documentation -docs_dir: . + repo_url: https://github.com/gleanerio/gleanerdocs.github.io edit_uri: blob/docs/ #theme: 'material' @@ -41,11 +41,15 @@ nav: - Gleaner: index.md - Running: - - Quick Start: quicsktart.md + - Quick Start: quickstart.md - CLI: cli.md - Docker CLI: dockercli.md - Configuration: config.md - Applications: + - Gleaner: gleaner.md + - Nabu: nabu.md +# multi repo does not cascade so this breaks in EC docs... could do a specific version of this for ECdocs +# if we want to render gleaner docs from the gleaner repo. - Gleaner -JSONLD from Page: '!import https://github.com/gleanerio/gleaner?branch=dev_docs' - Nabu - Upload JSONLD to Graphstores: '!import https://github.com/gleanerio/nabu?branch=dev_docs' - Communities and Fair: faircontext.md diff --git a/mkdocs_ec.yml b/mkdocs_ec.yml new file mode 100644 index 0000000..f6a5662 --- /dev/null +++ b/mkdocs_ec.yml @@ -0,0 +1,35 @@ +# customized for the Earthcbe docs +# multi repo does not cascade so this breaks in EC docs... could do a specific version of this for ECdocs +# if we want to render gleaner docs from the gleaner repo. + +site_name: Gleaner Documentation + +repo_url: https://github.com/gleanerio/gleanerdocs.github.io +edit_uri: blob/docs_mkdocs/docs +#theme: 'material' +#theme: 'mkdocs' +theme: + name: material +# name: 'readthedocs' + features: + # - content.code.copy + - navigation.sections + +nav: + - Gleaner: index.md + + - Running: + - Quick Start: quickstart.md + - CLI: cli.md + - Docker CLI: dockercli.md + - Configuration: config.md + - Applications: + - Gleaner: gleaner.md + - Nabu: nabu.md +# multi repo does not cascade so this breaks in EC docs... could do a specific version of this for ECdocs +# if we want to render gleaner docs from the gleaner repo. +# - Gleaner -JSONLD from Page: '!import https://github.com/gleanerio/gleaner?branch=dev_docs' +# - Nabu - Upload JSONLD to Graphstores: '!import https://github.com/gleanerio/nabu?branch=dev_docs' + - Communities and Fair: faircontext.md + +