Skip to content

Latest commit

 

History

History
76 lines (50 loc) · 2.49 KB

README.md

File metadata and controls

76 lines (50 loc) · 2.49 KB
Raw
Flotiq logo

Flotiq documentation

This is the Flotiq documentation. It's available online here.

We are improving our documentation along as Flotiq improves. We are trying our best to keep it as up to date and clear as it is possible. If you wish to help us with that task - PRs are welcome.

Prerequisites

Starting the project with docker:

  • Installed docker

Starting without docker:

  • Installed python
  • Installed git

Installation

With docker: docker-compose up -d It will also start docs server.

Without docker:

pip install -r requirements.txt

To start server use:

# Use SOURCE_EDITOR_URL variable to point to speciffic dashboard url. By default, SOURCE_EDITOR_URL=https://editor.flotiq.com is used.
bash .github/scripts/get-plugins-docs.sh # Pull dynamically generated plugin docs. 
mkdocs serve # Start devlopment server. Use --dirtyreload option to speed up reloading, but be aware, that this might break navigation on the preview.

After that, the documentation should be available on http://localhost:4000.

Troubleshooting

If during installation without docker you will encounter error with no git present, add 2 environment variables:

  • GIT_PYTHON_GIT_EXECUTABLE - with path to git e.g /usr/bin/git
  • GIT_PYTHON_REFRESH - with value quiet to suppress more git errors

Collaboration

If you wish to talk with us about this project, feel free to hop on Discord Chat .

If you found a bug, please report it in issues.

We also welcome any PR with documentation improvements (or typo fixes ;) ).

Aliasing

Some files are dynamically generated (e.g. all pages describing events and classes for plugin API). Those pages can be referred with an alias:

<!-- Refer to PluginInfo page -->
[[PluginInfo.md]] 

<!-- Refer to PluginInfo page with an alternative name -->
[[PluginInfo.md|Page about PluginInfo class]] 

<!-- Refer to header on PluginInfo page with an alternative name -->
[[PluginInfo.md#example-header|Example section on the page]]

You can also add an alias to any existing page by dyfining it in the meta section of the markdown file:

<!-- Start of the markdown file -->
alias: some-example-alias