The administrators of a particular instance of n6 are responsible for managing the knowledge base contents (adding, updating, deleting articles and chapters etc…). The aim of this guide section is to describe how the knowledge base structure is built and how to manage articles within that structure.
Knowledge Base filesystem structure¶
Articles are stored as a markdown files in a dedicated filesystem structure (see Initialization and Configuration). Current structure assumes that one article is representated as two markdown files, in Polish and English version. Analogicaly one chapter has in structure two physical representations, Polish and English.
Below you will find detailed description of the structure and minimal conditions ensuring its correctness.
- Knowledge Base filesystem structure has two subfolders, representing the language (
en). Each of them must have the same structure (number of subfolders and articles located in it).
- Language subfolders contains file
_title.txt, defining the name of the table of contents in aprioriate language, visible for user in n6 GUI.
- Language subfolders also contains subfolders, which are chapters storing particular articles.
The name of chapter subfolder has specific syntax:
id: identifier of the chapter (unique from the whole knowledge base structure perspective), the number between
name: the name of chapter, number or ASCII char (only small letters or chars
- Chapter subfolders contains file
_title.txt, defining the name of the chapter, visible for the user in n6 GUI.
Chapter subfolders also contains article files.
The name of article file, anlogicaly to chapter, has specific syntax:
id: identifier of the article (unique from the whole knowledge base structure perspective), the number between
name: the name of article, number or ASCII char (only small letters or chars
The title of the article, visible for user in n6 GUI, is taken from the first line of the article (after clipping
#chars and white spaces from the beginning and the end of the line).
Example of the knowledge base structure with two chapters and three articles¶
│ ├── 10-example-of-chapter-1
│ │ ├── 10-example-of-article-1.md
│ │ ├── 20-example-of-article-2.md
│ │ └── _title.txt
│ ├── 20-example-of-chapter-2
│ │ ├── 30-example-of-article-3.md
│ │ └── _title.txt
│ └── _title.txt
│ ├── 10-przykladowy-artykul-1.md
│ ├── 20-przykladowy-artykul-2.md
│ └── _title.txt
│ ├── 30-przykladowy-artykul-3.md
│ └── _title.txt
Correctnes of the structure - minimal boundary conditions¶
Below you fill find the minimal boundary conditions for correct knowledge base structure (otherwise user ater click in Knowledge base link will not get table of contents).
- The depth of the structure is correct (between 1 and 3).
- Every language directory has file
- Every chapter has file
- Chapters and articles have correct identifiers (natural number between 1 and 999999).
- Chapters and articles have correct names (number or ASCII char, only small letters or chars
- Chapter and article identifiers are unique in the given language branch.
- Chapter and article identifiers are equal among language branches.
Operations on the Knowledge Base¶
Backend API builds and memoizes Knowledge Base structure data (including documents indexing for the searching purpuse) during the first run of the n6 Portal. So after every operation described below, you need to reload the HTTP server. When the typical Apache configuration is in use (so that no Python code is run until a request is obtained), it is recommended to send a client request to trigger the aforementioned Knowledge Base structure data building and memoization; to do so, you can use e.g. the
$ cd ~/certs
$ curl --cert cert.pem --key key.pem -k 'https://localhost/api/info'
To add new chapter you neeed to:
1. create subfolder with unique identifier, in every language branch,
2. create in chapter subfolder the file
_title.txt with the title of the chapter displaying in n6 GUI. Please consider using max 30 chars for better displaying it in n6 GUI.
The identifier is used to sort chapters in table of contents visible for user in n6 GUI. It is advisable to create new identifiers with gaps, for example every tenth number for better managing it in the future.
To update chapter just update the name of the apriopriate chapter subfolders in every language branch. If you want to update the chapter title, you need to update the file
To delete chapter delete apriopriate chapter subfolders in every language branch. Please remember, then you also delete the content of the chapter (all articles located in it).
Set the chapter order¶
For set the right order of the chapter, you need to set the rignt identifier accordingly to your needs. Chapters are visible in the table of contents of the n6 GUI in accordance with their identifiers (ascending).
To add article you need to know, in which chapter it should be located. In chosen chapter subfolders in every language branch, create markdown file with unique identifier in its name.
First line of the article is the title visible for the user in n6 GUI (after clipping
# chars and white spaces from the beginning and the end of the line). Please consider using max 80 chars for better displaying it in n6 GUI.
The identifier is used to sort articles in table of contents visible for user in n6 GUI. It is advisable to create new identifiers with gaps, for example every tenth number for better managing it in the future.
To update article just update markdown files in article in wanted language branch.
To delete article, delete particular markdown files representing article, in every language branch.
Set the article order¶
For set the right order of the article in given chapter, you need to set the rignt identifier accordingly to your needs. Articles are visible in the table of contents of the n6 GUI in accordance with their identifiers (ascending).
Move the article to the other chapter¶
To move an article to another chapter, move the article file to the subfolder representing that chapter (in all language branches).