BIMS Website

Handbook and Technical Docs Repository for the Biodiversity Information Management System (BIMS). Here is where we highlight the procedures, principles, and processes related to using, managing and developing the BIMS platform. Please review this content at https://kartoza.github.io/bims-website for more information.

Building the Handbook as a PDF

Check out the code

git clone [email protected]:kartoza/bims-website.git

Install Dependencies

You need to install these packages:

pip install mkdocs-with-pdf
pip install mkdocs-material
pip install mdx_gh_links
pip install mkdocs-pdf-export-plugin

Build the documentation

Note that whenever you add new sections to nav in the mkdocs.yml (used for building the web version), you should apply those same edits to mkdocs-base.yml if you want those new sections to appear in the pdf too.

cd docs
./build-docs-pdf.sh
xdg-open TheBIMSHandbook.pdf

How to edit the documentation online

Go to the folders with the content:

https://github.com/kartoza/bims-website/tree/main/docs/src

Click on any of the files with .md extension then click the pencil to edit:

Editing the content uses exactly the same system as editing a ticket so you should hopefully feel at home there if you already have worked with GitHub issues. You can use the preview option to see how your changes look:

Once you are done editing, scroll down the page and write a short message explaining your changes (1) then choose commit directly to the main branch (2) then commit (3)

Normally we would actually ask you to make a branch and a pull request, but use option (2) for now to keep things simple. Your changes should appear on the live site within a minute or so.