diff --git a/Gemfile.lock b/Gemfile.lock index 7b45adca96..954c176c38 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -12,9 +12,9 @@ GEM ffi (1.15.5) forwardable-extended (2.6.0) http_parser.rb (0.8.0) - i18n (1.9.1) + i18n (1.10.0) concurrent-ruby (~> 1.0) - jekyll (4.2.1) + jekyll (4.2.2) addressable (~> 2.4) colorator (~> 1.0) em-websocket (~> 0.5) @@ -29,7 +29,7 @@ GEM rouge (~> 3.0) safe_yaml (~> 1.0) terminal-table (~> 2.0) - jekyll-sass-converter (2.1.0) + jekyll-sass-converter (2.2.0) sassc (> 2.0.1, < 3.0) jekyll-toc (0.17.1) jekyll (>= 3.9) @@ -45,13 +45,13 @@ GEM rb-fsevent (~> 0.10, >= 0.10.3) rb-inotify (~> 0.9, >= 0.9.10) mercenary (0.4.0) - mini_portile2 (2.7.1) - nokogiri (1.13.1) - mini_portile2 (~> 2.7.0) + mini_portile2 (2.8.0) + nokogiri (1.13.3) + mini_portile2 (~> 2.8.0) racc (~> 1.4) - nokogiri (1.13.1-arm64-darwin) + nokogiri (1.13.3-arm64-darwin) racc (~> 1.4) - nokogiri (1.13.1-x86_64-darwin) + nokogiri (1.13.3-x86_64-darwin) racc (~> 1.4) pathutil (0.16.2) forwardable-extended (~> 2.6) diff --git a/_config.yml b/_config.yml index a43861fc7c..b05d4f62aa 100644 --- a/_config.yml +++ b/_config.yml @@ -543,4 +543,15 @@ docs: - name: Contextionary folder: contextionary - name: Weaviate Clients - folder: weaviate-clients \ No newline at end of file + folder: weaviate-clients + learn: + - name: Vector search engines + folder: vector-search-engines + - name: Getting started with Weaviate + folder: getting-started + - name: Using Weaviate when it's running + folder: using-weaviate + - name: Weaviate Modules + folder: weaviate-modules + - name: Working with neural search frameworks + folder: neural-search-frameworks \ No newline at end of file diff --git a/_includes/learn-header.html b/_includes/learn-header.html new file mode 100644 index 0000000000..c9c1964814 --- /dev/null +++ b/_includes/learn-header.html @@ -0,0 +1,35 @@ + + + + \ No newline at end of file diff --git a/_includes/learn-menu.html b/_includes/learn-menu.html new file mode 100644 index 0000000000..77785f6ba2 --- /dev/null +++ b/_includes/learn-menu.html @@ -0,0 +1,47 @@ +
+
+
+ + {% assign sorted_documentation = site.pages | sort: 'menu-order' | group_by: 'solution' %} + {% for guides in sorted_documentation %} + {% if guides.name == page.solution %} + + {% for menuItem in site.docs[guides.name] %} + {% assign sorted_menus = site.pages | group_by: 'sub-menu' %} + {% for menu in sorted_menus %} + {% if menuItem.name == menu.name && guides.name == page.solution %} +
+ {{ menu.name }} +
+
    + {% assign sorted_sub_menus = site.pages | sort: 'menu-order' %} + {% for guide in sorted_sub_menus %} + {% if menu.name == guide.sub-menu %} + {% if page.solution == guide.solution %} + {% if guide.menu-order > 0 %} +
  • + {{guide.title}} +
    • + {% endif %} + {% endif %} + {% endif %} + {% endfor %} +
+ {% endif %} + {% endfor %} + {% endfor %} + {% endif %} + {% endfor %} +
+
+
diff --git a/_includes/learn-toc.html b/_includes/learn-toc.html new file mode 100644 index 0000000000..53aa9ba358 --- /dev/null +++ b/_includes/learn-toc.html @@ -0,0 +1,16 @@ +
+
+ + + + + {% if page.toc == true %} + +
+ Table of Contents +
+ {{ content | toc_only }} + {% endif %} + +
+
\ No newline at end of file diff --git a/_includes/nav.html b/_includes/nav.html index f942b4793c..c96821f079 100644 --- a/_includes/nav.html +++ b/_includes/nav.html @@ -130,13 +130,9 @@
- All Resources -
+ Learn - Coming Soon! + - - - show all - diff --git a/_layouts/layout-learn.html b/_layouts/layout-learn.html new file mode 100644 index 0000000000..8e0767297d --- /dev/null +++ b/_layouts/layout-learn.html @@ -0,0 +1,43 @@ + + + + + {% include head.html %} + + + + {% include learn-header.html %} + + +
+
+
+ + {% include learn-menu.html %} + +
+ +

{{ page.title }}

+ +

+ {{ page.intro }} +

+ +
+ +
+ {{ content }} +
+
+ + {% include learn-toc.html %} + +
+
+
+ + {% include javascript.html %} + + + + diff --git a/learn/getting-started/how-to-get-weaviate-running.md b/learn/getting-started/how-to-get-weaviate-running.md new file mode 100644 index 0000000000..97a1fae03d --- /dev/null +++ b/learn/getting-started/how-to-get-weaviate-running.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Getting started with Weaviate +title: How to get Weaviate running? +description: How to get Weaviate running? +tags: ['Getting Started'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +# Coming soon! +For now, check the [documentation about getting started](https://weaviate.io/developers/weaviate/current/getting-started/index.html). + +# More resources + +{% include docs-support-links.html %} diff --git a/learn/getting-started/index.md b/learn/getting-started/index.md new file mode 100644 index 0000000000..53ad8bc428 --- /dev/null +++ b/learn/getting-started/index.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Getting started with Weaviate +title: Getting Started with Weaviate +description: Getting Started with Weaviate +tags: ['Weaviate', 'Getting Started', 'Installation'] +menu-order: 0 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +For now, check the [documentation about getting started](https://weaviate.io/developers/weaviate/current/getting-started/index.html). + + +## More Resources + +{% include docs-support-links.html %} \ No newline at end of file diff --git a/learn/index.md b/learn/index.md new file mode 100644 index 0000000000..1edef16466 --- /dev/null +++ b/learn/index.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: index +title: Weaviate Learn +description: Learn about Vector search engines and Weaviate +tags: ['Weaviate', 'Learn'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +Learn about vector databases, Natural Language Processing, search engines, structured filtering and more topics of your interest! + + +## More resources + +{% include docs-support-links.html %} diff --git a/learn/neural-search-frameworks/index.md b/learn/neural-search-frameworks/index.md new file mode 100644 index 0000000000..37a1101678 --- /dev/null +++ b/learn/neural-search-frameworks/index.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Working with neural search frameworks +title: Working with neural search frameworks +description: Working with neural search frameworks +tags: ['Weaviate', 'Neural search'] +menu-order: 0 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +For now, check the [documentation about Weaviate](https://weaviate.io/developers/weaviate/current/). + +## More Resources + +{% include docs-support-links.html %} \ No newline at end of file diff --git a/learn/neural-search-frameworks/working-with-neural-search-frameworks.md b/learn/neural-search-frameworks/working-with-neural-search-frameworks.md new file mode 100644 index 0000000000..2c914dc96d --- /dev/null +++ b/learn/neural-search-frameworks/working-with-neural-search-frameworks.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Working with neural search frameworks +title: Working with neural search frameworks +description: Working with neural search frameworks +tags: ['Neural search frameworks'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +# Coming soon! +For now, check the [documentation about Weaviate](https://weaviate.io/developers/weaviate/current/). + +# More resources + +{% include docs-support-links.html %} diff --git a/learn/using-weaviate/how-to-work-with-weaviate.md b/learn/using-weaviate/how-to-work-with-weaviate.md new file mode 100644 index 0000000000..b1fb80fb5c --- /dev/null +++ b/learn/using-weaviate/how-to-work-with-weaviate.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Using Weaviate when it's running +title: How to work with Weaviate when it's running? +description: How to work with Weaviate when it's running? +tags: ['Weaviate'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +# Coming soon! +For now, check the [documentation about how to work with Weaviate](https://weaviate.io/developers/weaviate/current/tutorials/how-to-query-data.html). + +# More resources + +{% include docs-support-links.html %} diff --git a/learn/using-weaviate/index.md b/learn/using-weaviate/index.md new file mode 100644 index 0000000000..91d3e58eb2 --- /dev/null +++ b/learn/using-weaviate/index.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Using Weaviate when it's running +title: Using Weaviate when it's running +description: Using Weaviate when it's running +tags: ['Weaviate'] +menu-order: 0 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +For now, check the [documentation about how to work with Weaviate](https://weaviate.io/developers/weaviate/current/tutorials/how-to-query-data.html). + +## More Resources + +{% include docs-support-links.html %} \ No newline at end of file diff --git a/learn/vector-search-engines/index.md b/learn/vector-search-engines/index.md new file mode 100644 index 0000000000..bcc6b8c63c --- /dev/null +++ b/learn/vector-search-engines/index.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Vector search engines +title: Vector search engines +description: Vector search engines +tags: ['Weaviate', 'Vector search'] +menu-order: 0 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +For now, check the [documentation about Weaviate](https://weaviate.io/developers/weaviate/current/). + + +## More Resources + +{% include docs-support-links.html %} \ No newline at end of file diff --git a/learn/vector-search-engines/when-do-i-need-a-vector-search-engine.md b/learn/vector-search-engines/when-do-i-need-a-vector-search-engine.md new file mode 100644 index 0000000000..120a9ad2f7 --- /dev/null +++ b/learn/vector-search-engines/when-do-i-need-a-vector-search-engine.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Vector search engines +title: When do I need a Vector Search Engine? +description: When do I need a Vector Search Engine? +tags: ['Vector Search Engine'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +# Coming soon! +For now, check the [documentation about Weaviate](https://weaviate.io/developers/weaviate/current/). + + +# More resources + +{% include docs-support-links.html %} diff --git a/learn/weaviate-modules/how-to-choose-the-right-module.md b/learn/weaviate-modules/how-to-choose-the-right-module.md new file mode 100644 index 0000000000..da61be219d --- /dev/null +++ b/learn/weaviate-modules/how-to-choose-the-right-module.md @@ -0,0 +1,19 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Weaviate Modules +title: How to choose the right Weaviate module (or not)? +description: How to choose the right Weaviate module (or not)? +tags: ['Modules'] +menu-order: 1 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +## Coming soon! +For now, check the [documentation about Weaviate Modules](https://weaviate.io/developers/weaviate/current/modules/index.html). + +## More resources + +{% include docs-support-links.html %} diff --git a/learn/weaviate-modules/how-to-create-custom-modules.md b/learn/weaviate-modules/how-to-create-custom-modules.md new file mode 100644 index 0000000000..1136f85c08 --- /dev/null +++ b/learn/weaviate-modules/how-to-create-custom-modules.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Weaviate Modules +title: How to create custom modules? +description: How to create custom modules? +tags: ['Modules'] +menu-order: 2 +open-graph-type: article +og-img: img/og/og-learn.png +toc: true +--- + +## Coming soon! +For now, check the [documentation about custom Weaviate Modules](https://weaviate.io/developers/weaviate/current/modules/custom-modules.html). + + +## More resources + +{% include docs-support-links.html %} diff --git a/learn/weaviate-modules/index.md b/learn/weaviate-modules/index.md new file mode 100644 index 0000000000..fd38cecac5 --- /dev/null +++ b/learn/weaviate-modules/index.md @@ -0,0 +1,20 @@ +--- +layout: layout-learn +solution: learn +sub-menu: Weaviate Modules +title: Weaviate Modules +description: Weaviate Modules +tags: ['Weaviate', 'Modules'] +menu-order: 0 +open-graph-type: article +og-img: img/og/og-learn.png +toc: false +--- + +## Coming soon! +For now, check the [documentation about Weaviate Modules](https://weaviate.io/developers/weaviate/current/modules/index.html). + + +## More Resources + +{% include docs-support-links.html %} \ No newline at end of file