Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change layout to enable use in mkdocs #3

Open
wants to merge 5 commits into
base: docs
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -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
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
2 changes: 1 addition & 1 deletion config.md → docs/config.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions dockercli.md → docs/dockercli.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
6 changes: 3 additions & 3 deletions quickstart.md → docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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.
Expand Down
8 changes: 6 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -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'
Expand Down Expand Up @@ -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
Expand Down
35 changes: 35 additions & 0 deletions mkdocs_ec.yml
Original file line number Diff line number Diff line change
@@ -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