diff --git a/.gitignore b/.gitignore index b6cd1d6c124edad7f93da6b6150752ee49178070..66fb587076db8d13812c6d878fdefed7814febef 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ target/ .classpath .project .settings +site diff --git a/documentation/docs/comparing_the_alternatives.md b/docs/comparing_the_alternatives.md similarity index 97% rename from documentation/docs/comparing_the_alternatives.md rename to docs/comparing_the_alternatives.md index 958c3da0f3d7c4d689ca40aeebb5d3be1ae6642b..164a3b9cd56b1e200e28c9a17a3eb0a679301994 100644 --- a/documentation/docs/comparing_the_alternatives.md +++ b/docs/comparing_the_alternatives.md @@ -1,14 +1,3 @@ ---- -title: Comparing the Alternatives -permalink: comparing_the_alternatives.html -sidebar: main_sidebar -tags: [getting_started] -keywords: getting started -last_updated: October 30, 2016 -toc: true -folder: documentation ---- - There are several OGM/ORM options out there. For the purposes of this document we will focus only on those that have a stable release, or are close to a stable release. At the time of this writing those are: Tinkerpop Framed and Totorom. Benchmarks diff --git a/documentation/docs/core_annotations.md b/docs/core_annotations.md similarity index 100% rename from documentation/docs/core_annotations.md rename to docs/core_annotations.md diff --git a/documentation/docs/getting_started.md b/docs/getting_started.md similarity index 96% rename from documentation/docs/getting_started.md rename to docs/getting_started.md index 9bd3a8e901416be66a5d75d0f5975d54a17522b9..32144c25292a9a7ec1f6ac63482e53fe9c0b1bd1 100644 --- a/documentation/docs/getting_started.md +++ b/docs/getting_started.md @@ -1,14 +1,3 @@ ---- -title: Getting Started -permalink: getting_started.html -sidebar: main_sidebar -tags: [getting_started] -keywords: quick start, getting started -last_updated: October 30, 2016 -toc: true -folder: documentation ---- - Ferma provides three levels of type resolution: untyped, simple, and annotated. In untyped mode Ferma doesn't handle typing at all, instead the type must be explicitly indicated whenever querying. In simple mode Ferma provides type context encoded as graph element properties which ensures the same type comes out that goes in to a graph. In annotated mode all the features of simple mode are provided as well as enabling the use of annotations on abstract methods to instruct Ferma to dynamically construct byte code to implement the abstract methods at start up. ## Dependency diff --git a/documentation/docs/glossary.md b/docs/glossary.md similarity index 55% rename from documentation/docs/glossary.md rename to docs/glossary.md index f37c99e8ed2cd9ec2865e9d15a3237f60b2fd6c9..a6c332b1f4e17a817762f2b0a5f4e2f7cb10b8ed 100644 --- a/documentation/docs/glossary.md +++ b/docs/glossary.md @@ -1,13 +1,3 @@ ---- -title: Glossary -permalink: glossary.html -sidebar: main_sidebar -tags: [getting_started] -keywords: getting started -last_updated: October 30, 2016 -toc: true -folder: documentation ---- **Frame** - A class from the schema that represents an element from the graph. A frame usually extends either a VertexFrame or an EdgeFrame, though they are not required to do so. **Element** - Either a vertex or an edge in a graph. diff --git a/documentation/docs/images/ferma-logo-plain.svg b/docs/images/ferma-logo-plain.svg similarity index 100% rename from documentation/docs/images/ferma-logo-plain.svg rename to docs/images/ferma-logo-plain.svg diff --git a/documentation/docs/images/ferma-logo-text-plain.svg b/docs/images/ferma-logo-text-plain.svg similarity index 100% rename from documentation/docs/images/ferma-logo-text-plain.svg rename to docs/images/ferma-logo-text-plain.svg diff --git a/documentation/docs/images/ferma-logo-text-small.png b/docs/images/ferma-logo-text-small.png similarity index 100% rename from documentation/docs/images/ferma-logo-text-small.png rename to docs/images/ferma-logo-text-small.png diff --git a/documentation/docs/images/ferma-logo-text.pdf b/docs/images/ferma-logo-text.pdf similarity index 100% rename from documentation/docs/images/ferma-logo-text.pdf rename to docs/images/ferma-logo-text.pdf diff --git a/documentation/docs/images/ferma-logo-text.png b/docs/images/ferma-logo-text.png similarity index 100% rename from documentation/docs/images/ferma-logo-text.png rename to docs/images/ferma-logo-text.png diff --git a/documentation/docs/images/ferma-logo-text.ps b/docs/images/ferma-logo-text.ps similarity index 100% rename from documentation/docs/images/ferma-logo-text.ps rename to docs/images/ferma-logo-text.ps diff --git a/documentation/docs/images/ferma-logo-text.svg b/docs/images/ferma-logo-text.svg similarity index 100% rename from documentation/docs/images/ferma-logo-text.svg rename to docs/images/ferma-logo-text.svg diff --git a/documentation/docs/images/ferma-logo.pdf b/docs/images/ferma-logo.pdf similarity index 100% rename from documentation/docs/images/ferma-logo.pdf rename to docs/images/ferma-logo.pdf diff --git a/documentation/docs/images/ferma-logo.png b/docs/images/ferma-logo.png similarity index 100% rename from documentation/docs/images/ferma-logo.png rename to docs/images/ferma-logo.png diff --git a/documentation/docs/images/ferma-logo.ps b/docs/images/ferma-logo.ps similarity index 100% rename from documentation/docs/images/ferma-logo.ps rename to docs/images/ferma-logo.ps diff --git a/documentation/docs/images/ferma-logo.svg b/docs/images/ferma-logo.svg similarity index 100% rename from documentation/docs/images/ferma-logo.svg rename to docs/images/ferma-logo.svg diff --git a/documentation/docs/index.md b/docs/index.md similarity index 96% rename from documentation/docs/index.md rename to docs/index.md index 8eca2e52fc4edf2a242a2a3ab23a889940e7d7e4..cd01ca4a24dd009debb2003796d439c6b43704f8 100644 --- a/documentation/docs/index.md +++ b/docs/index.md @@ -1,13 +1,4 @@ ---- -title: Introduction -keywords: introduction -tags: [getting_started] -sidebar: main_sidebar -permalink: index.html -toc: false ---- - - + An ORM / OGM for the TinkerPop graph stack. diff --git a/documentation/mkdocs.yml b/mkdocs.yml similarity index 85% rename from documentation/mkdocs.yml rename to mkdocs.yml index b1b9288905ebebf68016a099160cbb8b34fe1a88..fa455535d16704b1a18436f8cd506a28ebb692d4 100644 --- a/documentation/mkdocs.yml +++ b/mkdocs.yml @@ -2,6 +2,7 @@ site_name: Ferma theme: material repo_name: 'GitHub' repo_url: 'https://github.com/Syncleus/Ferma' +site_dir: 'target/mkdocs' pages: - Home: index.md - Comparing the Alternatives: comparing_the_alternatives.md @@ -10,7 +11,9 @@ pages: - Glossary: glossary.md extra: version: '3.0.1' - logo: 'images/ferma-logo.png' + logo: 'images/ferma-logo.svg' + github: + download_release: true palette: primary: 'blue' accent: 'deep orange'