Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #254

Open
wants to merge 1 commit into
base: source
Choose a base branch
from
Open

Update README.md #254

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions website/static/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
This website is currently a hybrid of static hand-coded html, generated Sphinx documentation, and a Docusaurus generated blog. Changes are built and deployed to master by [GitHub Actions](https://github.com/prestodb/prestodb.github.io/actions) when changes are merged to the [source](https://github.com/prestodb/prestodb.github.io/tree/source) branch.
This website is currently a hybrid of Wordpress and generated Sphinx documentation. Doc changes are built and deployed to master by [GitHub Actions](https://github.com/prestodb/prestodb.github.io/actions) when changes are merged to the [source](https://github.com/prestodb/prestodb.github.io/tree/source) branch.

To test locally, follow the [Docusarus instructions](https://docusaurus.io/docs/en/next/tutorial-setup) to install node.js and yarn. Then follow the instructions in [README.md](website/README.md).
To test docs locally, follow the [Docusarus instructions](https://docusaurus.io/docs/en/next/tutorial-setup) to install node.js and yarn. Then follow the instructions in [README.md](website/README.md).

To summarize, you need to `brew install node` then `brew install yarn`. Once you have `node` and `yarn` you can run `yarn` from the website subdirectory to install the dependencies. Then you can run `yarn start` at any time to run a web server that will host the site from source or invoke `yarn build` to see what will be created when the site is compiled.

Static HTML portions of the site are stored under [website/static](website/static), and blog posts are stored as markdown under [website/blog](website/blog).
Static HTML portions of the site including blogs are hosted on Wordpress. If you'd like to contribute a blog or suggest a website update or change, please send an email to [email protected]