Skip to content

Commit

Permalink
adding Integrations docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@sebawita
sebawita committed Jun 20, 2024
1 parent 73d4987 commit 2b5b413
Show file tree
Hide file tree
Showing 8 changed files with 192 additions and 67 deletions.
29 changes: 29 additions & 0 deletions .vscode/markdown.code-snippets
View file
Original file line number Diff line number Diff line change
Expand Up @@ -251,4 +251,33 @@
],
"description": "For marking features as being added in a certain version"
},

"Integrations Tabs code": {
"prefix": "integrations-tabs-code",
"scope": "markdown",
"body": [
"<!-- Delete these imports if already imported in the file -->",
"import Tabs from '@theme/Tabs';",
"import TabItem from '@theme/TabItem';",
"",
"<Tabs groupId=\"languages\">",
"<TabItem value=\"py\" label=\"Python Client v4\">",
"",
"```python",
"# Python v4 example goes here",
"# note there is an empty line before this code snippet,",
"# without the empty line the code won't render",
"```",
"</TabItem>",
"<TabItem value=\"py3\" label=\"Python Client v3\">",
"",
"```python",
"# Python v3 example goes here",
"```",
"",
"</TabItem>",
"</Tabs>",
],
"description": "Adds the tabs section for code examples"
},
}
10 changes: 10 additions & 0 deletions developers/integrations/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: Home
sidebar_position: 0
image: og/integrations/home.jpg
# hide_table_of_contents: true
# hide_title: true
# tags: []
---

Integrations page - welcome message
32 changes: 32 additions & 0 deletions developers/integrations/llamaindex/index.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
title: LlamaIndex
sidebar_position: 0
image: og/docs/llamaindex.jpg
---

Integrations page - welcome message

:::note
`index.md` files is how you create a page that is a the root of the folder.
For example `llamaindex/index.md` is where the content for the page of the LlamaIndex folder goes.
:::

:::tip

```
sidebar_position: 0
```

`sidebar_position` on an `index.md` page tells docusaurus the nav position of the folder 😉

On any other page, it tells docusaurus the location of the page within the folder 🤔
:::

:::note
Make sure to generate a template for each new integrations folder ;)
Ask Sebastian for the Google Slides doc with the og template ;)

```
image: og/docs/llamaindex.jpg
```
:::
58 changes: 58 additions & 0 deletions developers/integrations/llamaindex/page-with-notes.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
title: LlamaIndex - some notes
sidebar_position: 1
image: og/docs/llamaindex.jpg
---
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

LlamaIndex - some notes

## First Code Examples

:::info
In VS Code you can use `integrations-tabs-code` code snippet to generate the code to show code with tabs.

Just start typing `inttab` and press `Enter`
:::

:::warning
Note, this will also add two imports for `Tabs` and `TabItem`.
You only need it once. Ideally, you should add it just under `---` on line 5.
:::

<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">

```python
# Python v4 example goes here
# note there is an empty line before this code snippet,
# without the empty line the code won't render
```
</TabItem>
<TabItem value="py3" label="Python Client v3">

```python
# Python v3 example goes here
```

</TabItem>
</Tabs>

## Second Code example - v4 only

<Tabs groupId="languages">
<TabItem value="py" label="Python Client v4">

```python
# Even if you plan to have one code example, we should always use the tabbed approach.
```
</TabItem>
</Tabs>

## Admonitions

:::tip
You can add these pretty admonitions, by typing `doc-inf` press Enter and select from the list of options. i.e. this is `tip`
:::

124 changes: 57 additions & 67 deletions docusaurus.config.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -254,66 +254,66 @@ const config = {
position: 'right',
to: '/platform',
},
{ type: 'dropdown',
label: 'Services',
position: 'right',
items: [
{
label: 'Services Overview',
href: '/services',
{
type: 'dropdown',
label: 'Services',
position: 'right',
items: [
{
label: 'Services Overview',
href: '/services',

},
{
label: 'Serverless Cloud',
href: '/services/serverless',
},
{
label: 'Serverless Cloud',
href: '/services/serverless',

},
{
label: 'Enterprise Cloud',
href: '/services/enterprise-cloud',
},
{
label: 'Enterprise Cloud',
href: '/services/enterprise-cloud',

},
{
label: 'Bring Your Own Cloud',
href: '/services/byoc',
},
{
label: 'Bring Your Own Cloud',
href: '/services/byoc',

},
{
label: 'Education & Support',
href: '/services/education-and-support',
},
{
label: 'Education & Support',
href: '/services/education-and-support',

},
{
label: 'Pricing',
href: '/pricing',
},
{
label: 'Pricing',
href: '/pricing',
},
]
},

},
]
}
,
{ type: 'dropdown',
label: 'Solutions',
position: 'right',
items: [
{
label: 'Hybrid Search',
href: '/hybrid-search',
{
type: 'dropdown',
label: 'Solutions',
position: 'right',
items: [
{
label: 'Hybrid Search',
href: '/hybrid-search',

},
{
label: 'RAG',
href: '/rag',
},
{
label: 'RAG',
href: '/rag',

},
{
label: 'Generative Feedback Loops',
href: '/gen-feedback-loops',
},
{
label: 'Generative Feedback Loops',
href: '/gen-feedback-loops',

},
},
]
},

]
}
,
{
type: 'dropdown',
label: 'Developers',
Expand All @@ -331,6 +331,12 @@ const config = {
sidebarid: 'wcsSidebar',
type: 'doc',
},
{
label: 'Integrations',
docId: 'integrations/index',
sidebarid: 'integrationsSidebar',
type: 'doc',
},
{
label: 'Learn with Academy',
docId: 'academy/index',
Expand All @@ -340,7 +346,6 @@ const config = {
{
label: 'Blog',
to: '/blog',

},
{
label: 'Online Workshops & Events',
Expand All @@ -358,7 +363,6 @@ const config = {
label: 'Community',
to: '/community',
},

{
label: 'Paper Reviews',
to: '/papers',
Expand Down Expand Up @@ -435,18 +439,15 @@ const config = {
},
{
html: `<svg class="githubStars" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>GitHub</title><path d="M12 .297c-6.63 0-12 5.373-12 12 0 5.303 3.438 9.8 8.205 11.385.6.113.82-.258.82-.577 0-.285-.01-1.04-.015-2.04-3.338.724-4.042-1.61-4.042-1.61C4.422 18.07 3.633 17.7 3.633 17.7c-1.087-.744.084-.729.084-.729 1.205.084 1.838 1.236 1.838 1.236 1.07 1.835 2.809 1.305 3.495.998.108-.776.417-1.305.76-1.605-2.665-.3-5.466-1.332-5.466-5.93 0-1.31.465-2.38 1.235-3.22-.135-.303-.54-1.523.105-3.176 0 0 1.005-.322 3.3 1.23.96-.267 1.98-.399 3-.405 1.02.006 2.04.138 3 .405 2.28-1.552 3.285-1.23 3.285-1.23.645 1.653.24 2.873.12 3.176.765.84 1.23 1.91 1.23 3.22 0 4.61-2.805 5.625-5.475 5.92.42.36.81 1.096.81 2.22 0 1.606-.015 2.896-.015 3.286 0 .315.21.69.825.57C20.565 22.092 24 17.592 24 12.297c0-6.627-5.373-12-12-12"/></svg>`,

to: 'https://github.com/weaviate/weaviate',
position: 'right',
},

},
{
label: 'Try Now',
className: 'tryNow',
to: 'https://console.weaviate.cloud',
position: 'right',
},

{
type: 'search',
position: 'right',
Expand Down Expand Up @@ -520,7 +521,6 @@ const config = {
to: '/learn/knowledgecards',
},
{

label: 'Academy',
to: '/developers/academy',
},
Expand Down Expand Up @@ -550,7 +550,6 @@ const config = {
to: '/podcast',
},
{

label: 'Meetups',
to: '#',
className: 'footer__title subtitle',
Expand All @@ -575,14 +574,11 @@ const config = {
label: 'Toronto',
to: 'https://www.meetup.com/weaviate-toronto',
},

],
},
{
title: 'Company',
items: [


{
label: 'About',
to: '/company/about-us',
Expand Down Expand Up @@ -611,7 +607,6 @@ const config = {
{
label: 'AWS',
to: '/partners/aws',

},
{
label: 'Google Cloud',
Expand All @@ -626,17 +621,13 @@ const config = {
{
label: 'Become a Partner',
to: '/partners',

},


],
},

{
title: 'Follow Us',
items: [

{
label: 'GitHub',
to: 'https://github.com/weaviate/weaviate',
Expand All @@ -658,7 +649,6 @@ const config = {
to: 'https://youtube.com/weaviate_io',
},
{

label: 'Linkedin',
to: 'https://www.linkedin.com/company/weaviate-io',
},
Expand Down
6 changes: 6 additions & 0 deletions sidebars.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,12 @@ const sidebars = {
href: '/developers/contributor-guide',
},
],
integrationsSidebar: [
{
type: 'autogenerated',
dirName: 'integrations'
},
],
};

module.exports = sidebars;
Binary file added static/og/integrations/home.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/og/integrations/llamaindex.jpg
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2b5b413

Please sign in to comment.