Contributing

Bookstack Basics:

• Documentation in Bookstack is organized into Books.
• Each Book contains Pages which contain documentation.
• Pages within a book can be grouped into Chapters.
• Books which are related can be grouped into Shelves
• Books can be placed on multiple shelves

Vector Bookstack Structure:

Adhere to the following structure when contributing documentation:

• Shelf - Team

• Book - Project

• Chapter - Subproject

• Page - Topic

• Each Book should represent the documentation for a single project.

• Each team will be assigned its own Shelf on which to store/group Books.

  • If a project is shared across multiple teams, then the book for that project can be placed on both of the shelves for each team.

• Books are private by default.

  • Books should only be made public if they are intended to be shared with those who are not Vector proffessional staff and do not contain sensitive information.
  • If a book is made public, all the pages and chapters within that book are also made public. You can override this by explicitly editing the permissions of a page to make it private again.

• Team Shelves should be made public.

  • Making a shelf public does not make the books within that shelf public.