Skip to content

Commit 38245c8

Browse files
update to reflect version 3.3
1 parent cbe1d06 commit 38245c8

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,21 @@
22

33
## Introduction
44

5-
Trivadis published their guidelines for PL/SQL & SQL in 2009 in the context of the DOAG conference in Nuremberg. Since then these guidelines - written in Microsoft Word - have been continuously extended and improved. We think it is time to make these guidelines more adaptable for the individual #SmartDB application needs and to simplify the continous improvement of these guidelines.
5+
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.
66

7-
The next step will be to convert the existing guidelines to a set of Markdown files and use Jekyll to generate the guidelines as static HTML files or PDF.
7+
## HTML format
8+
9+
HTML is the primary output format. [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) is used to generate static HTML files and [Mike](https://github.com/jimporter/mike) to publish version specific variants. The following sites are available:
10+
11+
Link | Content
12+
-------------------------------------------------------------------- | -------
13+
<https://trivadis.github.io/plsql-and-sql-coding-guidelines/> | Latest Release
14+
<https://trivadis.github.io/plsql-and-sql-coding-guidelines/master/> | Current version based on the master branch, typically a snapshot version of the coming release
15+
<https://trivadis.github.io/plsql-and-sql-coding-guidelines/v3.3/> | Released version 3.3
16+
17+
## PDF format
18+
19+
PDF is the secondary output format. [wkhtmltopdf](https://wkhtmltopdf.org/) is used to generate the [PLSQL-and-SQL-Coding-Guidelines.pdf](PLSQL-and-SQL-Coding-Guidelines.pdf).
820

921
## Releases
1022

0 commit comments

Comments
 (0)