Implementace a rozšíření frameworku pro testování technické dokumentace

Abstract

Práca sa zaoberá automatizáciou testovania technickej dokumentácie napísanej v značkovacom jazyku AsciiDoc pomocou open-source frameworku testovania technickej dokumentácie Emender implementovaného na CI/CD platforme. Framework bol rozšírený o webovú aplikáciu emenderwebservice s REST API, ktorá poskytuje užívateľské grafické rozhranie s výsledkami testov a mechanizmom na odrieknutie falošne pozitívnych výsledkov testov. Webová aplikácia bola vytvorená pomocou WSGI frameworku na tvorbu webových aplikácií Flask s databázou ktorá umožňuje agregáciu výsledkov testov a ich unikátnu identifikáciu. Aplikácia uľahčuje prístup ku výsledkom testov vygenerovaných frameworkom Emender v CI/CD systémoch a poskytuje technical writer-om ucelené užívateľské prostredie.The thesis discusses automated testing of technical documentation written in AsciiDoc markup language using open-source documentation testing framework Emender implemented in CI/CD. The framework was extended with a RESTful web application emenderwebservice, providing a graphical user interface with test results and a mechanism to waive false positive test results. Web application was implemented with Flask WSGI web application framework along with a database enabling aggregation and unique test identification. The application simplifies access to test results generated by Emender in CI/CD and provides a concise graphical user interface for technical writers.