https://github.com/firebolt-db/godocs
Documentation for Firebolt 2.0
https://github.com/firebolt-db/godocs
Last synced: about 1 month ago
JSON representation
Documentation for Firebolt 2.0
- Host: GitHub
- URL: https://github.com/firebolt-db/godocs
- Owner: firebolt-db
- License: other
- Created: 2023-08-29T17:37:59.000Z (almost 2 years ago)
- Default Branch: gh-pages
- Last Pushed: 2025-04-28T09:40:53.000Z (about 1 month ago)
- Last Synced: 2025-04-29T21:18:06.606Z (about 1 month ago)
- Language: Shell
- Size: 71.9 MB
- Stars: 2
- Watchers: 3
- Forks: 28
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE-SAMPLECODE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Firebolt 2.0 documentation repository
Welcome to the open source version of the documentation for the Firebolt Analytics data warehouse. You can submit feedback on the documentation by submitting issues in this repository. You can also propose changes directly by editing files and submitting a pull request.
## How to run locally
Run the following command:
```bash
make start-local
```
Then, you can go to http://localhost:8080/ in your browser to preview the documentation.
## How to check links
```bash
make check-links
```
## How to add an interactive example
We have interactive examples in the documentation. These run against a Firebolt docs server.
Just add your single query as a sql file in `docs/_includes/sql_examples`. You can then add the following to your main markdown page:
```
{% include query-window.html sql_file="sql_examples/" %}
```
For example:
```
{% include query-window.html sql_file="sql_examples/median_example_1.sql" %}
```
You then need to pre-package results for that example or CI will fail.
### How to package documentation examples
If the Firebolt docs server is unavailable (or rate limited), we still want to keep the examples interactive, so we pre-package the results of the examples.
These are also used on the initial page to show example results as quickly as possible.
To package all examples, run:
```bash
make package-docs
```
To package only missing examples, run:
```bash
make package-missing-docs
```
## License summary
The documentation is made available under the Creative Commons Attribution-ShareAlike 4.0 International License.
For details, see the LICENSE file. Any sample code within this documentation is made available under a modified MIT license. For details, see the LICENSE-SAMPLECODE.md file.