diff --git a/README.rst b/README.rst index bfb44b93..617dec9f 100644 --- a/README.rst +++ b/README.rst @@ -52,3 +52,16 @@ the key is :code:`service_type` which has the foreign key in the document can only be linked to one service. The key :code:`service_category` table is :code:`name` of the service category which is then used in the :code:`services` table as foreign key. + +File structure: documents +^^^^^^^^^^^^^^^^^^^^^^^^^ + +* hc_location: reference to Huawei Cloud part +* html_location: place where the documents are stored in doc-exports +* link: URI document +* pdf_enabled: true| false ; enable pdf generation +* pdf_enviroment public|internal|hidden: environment where the pdfs are shown in the SBV +* rst_location: folder location of this specific in the source repo +* service_type: primary key of service name +* title: written title of the service +* type: document type