DDN documentation creation tool
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Matthias Wolf d027a773bf Updated reportlab and cleanup several files and direcories. 1 year ago
.settings Updated reportlab to fix several issues 1 year ago
html Updated reportlab to fix several issues 1 year ago
lib Updated reportlab and cleanup several files and direcories. 1 year ago
manuals Updated reportlab and cleanup several files and direcories. 1 year ago
media Initial commit 1 year ago
templates Updated reportlab and cleanup several files and direcories. 1 year ago
README.md Updated reportlab to fix several issues 1 year ago
docscaler.py Updated reportlab to fix several issues 1 year ago
docscaler.spec Initial commit 1 year ago

README.md

#DocScaler - Tool to generate an installation report for DDN systems

Execution: ./docscaler -c

#Configuration: Best practice would be to create a directory and put all relevant files in there. A configuration template (config.json) can be found in the templates directory.

###GENERAL: Document related information

"general": {
        "date": "now",			//Required
        "document_name": "",		//Required
        "title": {			//Optional 
                "1": "",
                "2": "",
                "3": ""
        }
    }

date -> The document creation date (currently only now is possible)
document_name > The filename of the document
title > 3 lines of extra data for the document, e.g. project name

##CUSTOMER: Customer related information

"customer": {
        "company": "",			//Required
        "logo": "",			//Required
        "name": "",			//Required
        "phone": "",			//Required
        "email": "",			//Required
        "address": {			//Optional
                "1": "",
                "2": "",
                "3": ""
        }
    }

company > The company name logo > Image of the company logo. Only the name, if in the same path as the config. name > Name of the customer phone > Phone number of the customer email > Email address of the customer address > Address of the customer site. Can be extended with more lines.

##DDN: DDN personel information

"ddn": {
        "personel": [
            {
                "role": "",
                "name": "",
                "phone": "",
                "email": "",
                "doc_creator": "no"
            }
        ]
    }

role > The role within DDN e.g. Sales Manager name > Name of the DDN person phone > Phone number of the DDN person email > Email address of the DDN person doc_creator > Is this person the creator of the doc? yes/no

##NETWORK: Network diagrams of the project

"network": {
        "rack_diagram": "",
        "network_diagram": ""
    }

rack_diagram > Image of the rack diagram. Only the name, if in the same path as the config. network_diagram > Image of the network diagram. Only the name, if in the same path as the config.

##SFA: SFA related information

"sfa": {
        "sss": [
            {
                "file": ""
            }
        ]
    }

file > Name of the show sub summary file. Can be a text or tgz file. Only the name, if in the same path as the config.

##FILESYSTEMS: Filesystem related information

"filesystems":{
        "gsctl": [
            {
                "file": ""
            }
        ],
        "esctl": [
            {
                "file": ""
            }
        ]
    }

gsctl/file > Name of the gs_showall file. Only the name, if in the same path as the config. esctl/file > Name of the es_showall file. Only the name, if in the same path as the config.

##TEMPLATES: All templates used for the doc. The order is defined by the number.

"templates": {
        "1": "contact.txt",
        "2": "overview.txt",
        "3": "summary.txt",
        "4": "rack_network.txt",
        "5": "sfa.txt",
        "6": "gpfs.txt",
        "7": "support.txt"
    }