Skip to content

Trivadis/plsql-and-sql-coding-guidelines

Repository files navigation

Trivadis PL/SQL & SQL Coding Guidelines

Introduction

Trivadis published their guidelines for PL/SQL & SQL in 2009 in the context of the DOAG conference in Nuremberg. Since then these guidelines have been continuously extended and improved. Now they are managed as a set of markdown files. This makes the the guidelines more adaptable for individual application needs and simplifies the continous improvement.

HTML format

HTML is the primary output format. Material for MkDocs is used to generate static HTML files and Mike to publish version specific variants. The following sites are available:

PDF format

PDF is the secondary output format. wkhtmltopdf is used to generate the PLSQL-and-SQL-Coding-Guidelines.pdf.

Releases

You find all releases and release information here.

Issues

Please file your bug reports, enhancement requests, questions and other support requests within Github's issue tracker.

How to Contribute

  1. Describe your idea by submitting an issue
  2. Fork this respository
  3. Create a branch, commit and publish your changes and enhancements
  4. Create a pull request

How to Build the HTML Site and PDF Documenation

  1. Install Docker in your environment
  2. Fork this respository
  3. Check/change the version in mkdocs.yml
  4. Open termin in tools folder
    • Deploy into default folder run ./gh-deploy.sh
    • Deploy into a version folder run ./mike.sh deploy <version>. <version> represents the folder name, e.g. master or v3.4.
    • Build the PDF file run ./genpdf.sh.
  5. commit changes and push all branches.

Related Resources

License

The Trivadis PL/SQL & SQL Coding Guidelines are licensed under the Apache License, Version 2.0. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0.