https://github.com/altinity/altinityknowledgebase
The repository for the Altinity Knowledge Base located at https://kb.altinity.com
https://github.com/altinity/altinityknowledgebase
Last synced: 2 months ago
JSON representation
The repository for the Altinity Knowledge Base located at https://kb.altinity.com
- Host: GitHub
- URL: https://github.com/altinity/altinityknowledgebase
- Owner: Altinity
- License: other
- Created: 2021-04-16T14:03:26.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-07-14T12:37:58.000Z (10 months ago)
- Last Synced: 2025-07-14T16:25:17.420Z (10 months ago)
- Language: HTML
- Homepage:
- Size: 21.4 MB
- Stars: 59
- Watchers: 23
- Forks: 43
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Welcome
Welcome to the Altinity Knowledgebase Repository! This Knowledgebase was established for Altinity Engineers and ClickHouse community members to work together to find common solutions.
Submissions and merges to this repository are distributed at https://kb.altinity.com .
This knowledgebase is licensed under Apache 2.0. Contributors who submit to the Altinity Knowledgebase agree to the Altinity Contribution License Agreement.
## How This Site is Rendered
This site is rendered using [Hugo](https://gohugo.io/) and the [Docsy theme](https://www.docsy.dev/).
To test out the site on a local system:
1. Download the entire repo.
1. Install `hugo`.
1. From the command line, run `npm install` to allocate the proper packages locally.
1. From the command line, run `git submodule update --init --recursive` to populate the Docsy theme.
1. Edit the contents of the `./content/en` directory. To add images/pdfs/etc , those go into `./static`.
1. To view the web page locally to verify how it looks, use `hugo server` and the web page will be displayed from `./docs` as a local server on `http://localhost:1313`.
## How This Site Is Served
Merges into the `main` branch are run through a Github workflow, and the results are rendered into the branch `altinity-knowledgebase`. The GitHub pages are served from that branch. Members of the Altinity Knowledge Base team can directly contribute to the Knowledge Base. Other users will submit pull requests and agree to the CLA before their pull request will be accepted.