mirror of https://github.com/hasura/graphql-engine.git synced 2024-12-15 01:12:56 +03:00

History

SidharthBihary 5be7dc7ad7 docs: Minor update to include traces in the context of logs and metrics in Metrics/Integration section, rectify typo PR-URL: https://github.com/hasura/graphql-engine-mono/pull/4737 GitOrigin-RevId: 900564cc2f41c0cb09e788bc6f75b7e8a6f3f45e		2022-06-15 14:18:51 +00:00
..
docs/graphql	docs: Minor update to include traces in the context of logs and metrics in Metrics/Integration section, rectify typo	2022-06-15 14:18:51 +00:00
public	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
scripts	docs: add cloud docs for billing owner	2022-04-18 14:56:19 +00:00
src	docs: fix graphiql editor copying issue	2022-06-08 13:22:28 +00:00
static	docs: cloud OpenTelemetry integration	2022-06-15 13:32:08 +00:00
wiki	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
.gitignore	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
babel.config.js	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
CONTRIBUTING.md	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
docusaurus.config.js	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
package.json	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
README.md	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
sidebars.js	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
sidebarsWiki.js	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
tsconfig.json	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00
yarn.lock	docs: move docs-new to docs	2022-04-13 12:01:50 +00:00

Website

This website is built using Docusaurus 2, a modern static website generator.

$ yarn

$ yarn 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.

$ yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

$ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.