Welcome to GlareDB documentation đź‘‹.
Have feature requests or bug reports for console.glaredb.com? We'd love to hear from you - please file an issue.
We welcome contributions and fixes to our documentation. For more information on contributing, see our Contributing guidelines.
GlareDB docs are built using Just the docs. The following are needed:
- Ruby
- Also: RubyGems which can typically be installed alongside
ruby
- Also: RubyGems which can typically be installed alongside
- GCC (
g++
)build-essential
APT package for debian and Ubuntu
make
In addition to the documentation, we have some optional tooling for static analysis. The following are needed:
Once the above are installed, install jekyll and bundler:
gem install jekyll bundler
Install project dependencies:
# From the project root
bundler install
Develop locally (localhost:4000
):
# From root of project
bundle exec jekyll serve
We use markdownlint
for linting and prettier
for formatting. To see the
configurations, check out .markdownlint-cli2.jsonc
and .prettierrc.json
respectively.
From the root of the project:
# Checks spelling
yarn cspell
# Checks code format
yarn format
# Attempts to automatically fix any formatting issues
yarn format:fix
# Checks code adheres to lint rules
yarn lint
# Attempts to automatically fix any lint violations
yarn lint:fix
See cspell.json
for spell checking configuration. The patterns
are regular
expressions for which spell checking is ignored (example: in code blocks).
The words
array is a list of words to ignore.
Adding plugins:
- Add the following to your site's
Gemfile
:
gem "<plugin>"
- And add the following to your site's
_config.yml
:
plugins:
- "<plugin>"
This repository is licensed under the MIT License. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party starter workflows. A copy of their MIT License is available in actions/starter-workflows.