DB-GPT/docs
2024-11-10 22:36:53 +08:00
..
blog docs: add v0.6.0 release notes (#1991) 2024-09-10 14:26:25 +08:00
docs feat: Enhance the triplets extraction in the knowledge graph by the batch size (#2091) 2024-11-05 14:01:18 +08:00
nginx docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
src docs: SMMF introduction and usage (#878) 2023-12-01 12:37:29 +08:00
static feat(runtime): Execute codes in a sandbox environment (#2119) 2024-11-10 22:36:53 +08:00
.gitignore docs: rewrite docs use docusaurus (#853) 2023-11-27 19:53:56 +08:00
babel.config.js docs: rewrite docs use docusaurus (#853) 2023-11-27 19:53:56 +08:00
Dockerfile docs: rewrite docs use docusaurus (#853) 2023-11-27 19:53:56 +08:00
Dockerfile-deploy docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
Dockerfile-deploy.dockerignore fix(docs): Fix build doc image error (#1997) 2024-09-10 17:47:38 +08:00
docusaurus.config.js docs: app & agents development document (#2081) 2024-10-19 16:00:00 +08:00
package-lock.json docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
package.json docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
README.md docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
sidebars.js docs: app & agents development document (#2081) 2024-10-19 16:00:00 +08:00
versions.json docs: Multi-version document build (#1741) 2024-07-23 11:10:28 +08:00
yarn.lock 🍎 docs: add docs for v0.6.0 (#1964) 2024-09-09 16:16:50 +08:00

DB-GPT documentation

Quick Start

Install dependencies

  • Clone current project firstly!
  • Install docusaurus dependencies, generate node_modules folder.
sudo yarn install

launch

yarn start

The default service starts on port 3000, visit localhost:3000

Deploy Multi-Version Documentation

We can deploy multiple versions of the documentation by docker.

Build Docker Image

Firstly, build the docker image in DB-GPT project root directory.

# Use the default NPM_REGISTRY=https://registry.npmjs.org
# Use https://www.npmmirror.com/
NPM_REGISTRY=https://registry.npmmirror.com
docker build -f docs/Dockerfile-deploy \
-t eosphorosai/dbgpt-docs \
--build-arg NPM_REGISTRY=$NPM_REGISTRY \
--build-arg CI=false \
--build-arg NUM_VERSION=2 .

Run Docker Container

Run the docker container with the following command:

docker run -it --rm -p 8089:8089 \
--name my-dbgpt-docs \
-v $(pwd)/docs/nginx/nginx-docs.conf:/etc/nginx/nginx.conf \
eosphorosai/dbgpt-docs

Open the browser and visit localhost:8089 to see the documentation.