Skip to content

Split single word document into several markup files #1

Closed
@PhilippSalvisberg

Description

@PhilippSalvisberg

Currently the Trivadis PL/SQL & SQL Coding Guidelines are maintained in a single Microsoft Word document. This is not optimal. For example:

  • Changes cannot be easily tracked within a version control system (at least not without additional tooling).
  • Multi-user support is limited, it is difficult to ensure that no changes are lost when merging.
  • Keeping track of changes after adapting the guidelines for an application/project is difficult (identifying relevant changes and merging them).
  • There is no HTML target format. This could simplify linking to chapters/rules from other documents.

The idea is to split the current document into markup files, which may be processed by Jekyll to produce static HTML files and also a PDF file similar to the current one.

This is just a "reformatting" task. It is not the idea to change the content in the first step. As long as this issue is not implemented fully in a satisfactory way, the Word document ist still the master and might be evolved further.

As an inspiration look into the MvvmCross GitHub repository. They generate the documentation with Jekyll including also some JavaScript for search capabilities. See the result.

Metadata

Metadata

Labels

enhancementNew feature or request

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions