-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
ajosh0504
committed
Jul 11, 2024
1 parent
211ec62
commit 9b0a9c9
Showing
1 changed file
with
13 additions
and
28 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,41 +1,26 @@ | ||
# Docusaurus Template Workshop | ||
# Developer Days AI RAG Lab | ||
|
||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator. It's available on https://mongodb-developer.github.io/docusaurus-workshop/. | ||
This is the AI RAG Lab used during MongoDB Developer Days that covers building RAG applications using MongoDB. | ||
|
||
This is a template to create new Workshop documentation sites. Contains info on how to use Docusaurus and is a good starting point. | ||
You can access the online version of the lab [here](https://mongodb-developer.github.io/ai-rag-lab/). | ||
|
||
### Installation | ||
## Running the Lab Locally | ||
|
||
``` | ||
npx create-docusaurus@latest name-of-my-new-awesome-workshop https://github.com/mongodb-developer/docusaurus-workshop | ||
cd name-of-my-new-awesome-workshop | ||
npm start | ||
``` | ||
If you want to run the lab locally, you can start by cloning the repository or downloading the code. You will need to have [Node.js](https://nodejs.org/en/) installed. | ||
|
||
As you don't want to get the changes of these sample pages, just delete the `.git` folder and then `git init`. | ||
Once you have the code, you can run the following commands to install the dependencies and start the server: | ||
|
||
Open `docusaurus.config.js` and change at least the `workshopName` | ||
|
||
### Local Development | ||
|
||
``` | ||
$ npm start | ||
``` | ||
|
||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
||
### Build | ||
|
||
``` | ||
$ npm build | ||
npm install | ||
npm start | ||
``` | ||
|
||
This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
You can then access the lab at http://localhost:3000 | ||
|
||
### Deployment | ||
## Contributing | ||
|
||
Use the provided Github Action, or deploy manually after building | ||
If you find any issues with the lab, please open an issue or submit a pull request. | ||
|
||
### Disclaimer | ||
## License | ||
|
||
Use at your own risk; not a supported MongoDB product | ||
This project is licensed under the Apache 2.0 License - see the [LICENSE](LICENSE) file for details |