Content Structure
Content in Alliage is structured using three main concepts: organizations, projects, and documents.
Organization: An entity with one or multiple projects.
Project: Collection of documents.
Document: Association of contents and metadata properties.
Collaborators have different permissions managed at various levels via roles.
Document
A document is the main unit of work. Depending on their types, not all documents are the same.
They contain shared metadata properties defined at project level as well as category specific properties.
The following project is an example of how this structure works.
Knowledge base project
The project contains 5 categories with the specific content properties:
- Card
- Description
- Content
- Issue
- Observation
- Diagnostic
- Reproducibility
- Workaround
- Solution
- FAQ
- Description
- Response
- Cheat sheet
- Content
- Quick start
- Content
All document types share required properties with one possible value. For example:
- Status
- Opened
- Handled
- Solved
- Outdated
- Defunct
- Severity
- DEBUG
- INFO
- WARNING
- ERROR
- FATAL
All document types share optional properties with multiple possible values. For example:
- Components
- list of useful components
- Platforms
- list of useful platforms
- Tags
- list of useful tags
This information is used to describe the documents and allows you to find related content easily.