| commit | 95b35d7f1fe753b08c7c9cc38b7c11af83f7d718 | [log] [tgz] |
|---|---|---|
| author | Xiang Fu <xiangfu.1024@gmail.com> | Fri Oct 25 01:17:43 2024 +0800 |
| committer | GitHub <noreply@github.com> | Thu Oct 24 10:17:43 2024 -0700 |
| tree | f7656d31eae8f32b9f1af0059a2892c8c60070b6 | |
| parent | 62f46070a39daa04a59b6c4335871d807443e13d [diff] |
Update slack invite link (#137)
This is the private repository for the Apache Pinot blog and documentation website. It contains all the source code and materials required for the development and deployment of the site. The website serves as a central platform for the Apache Pinot community to access the blog posts, tutorials, and comprehensive documentation.
Apache Pinot is an open-source, distributed OLAP datastore designed to deliver real-time analytics with low latency and high throughput. The goal of this website is to provide an informative, responsive, and engaging user experience to all community members.
Before proceeding, make sure you have the following prerequisites installed:
The project utilizes the following technologies:
The codebase provides a .nvmrc file. Therefore, if you have nvm installed, simply run nvm use in your terminal in order to use the preferred Node version.
Clone the repository and install dependencies to set up your local development environment:
git clone https://github.com/startreedata/pinot-docs-site-prototype cd pinot-docs-site yarn install
To start the development server:
yarn dev
Visit http://localhost:3000 in your browser to view the website. The development server features hot-reloading to reflect changes instantly.
Generate a production build using:
yarn build
Then, launch the production server with:
yarn serve
Execute the test suite with:
yarn test
Please ensure all tests pass before merging any changes to maintain the integrity of the application.
To maintain high code quality and consistent styling, we use ESLint for static code analysis and Prettier for formatting. Run the following commands to check and fix linting and formatting issues:
yarn lint
yarn check
yarn format
Additionally, Husky is used to apply pre-commit and pre-push hooks to run linting and formatting checks, ensuring that issues are caught early on.
When you clone the repository and run yarn install, Husky will automatically set up the Git hooks defined in our configuration.
Our current Husky setup includes the following hooks:
If you encounter any issues with your commit due to these hooks, please address the reported issues before proceeding. If the hooks alter your files, you will need to add the changes to your commit:
git add . git commit -m "Your commit message"
Running the commands above will re-run the hooks, and if no issues are detected, your commit will be successful.
For more information on Husky and how to customize its behavior, see the Husky documentation https://typicode.github.io/husky/.
The website is deployed using Vercel, which offers direct integration with Next.js projects. For deployment instructions, refer to Vercel's official documentation https://vercel.com/docs.
Please find our guide about writing blog posts in CONTRIBUTION.md in this project.
Please find our guide about releasing a new version of Apache Pinot in RELEASE.md in this project.
Should you require any support, please get in touch with DevRel Team.