Maintaining the utPLSQL Website

The utPLSQL website is generated using MkDocs and material theme Mike is used for versioning of documentation see also this page

Local setup

You will need to have python installed along with pip (see this page)

Once you have pytin and pip installed you will need to install the three components:

pip install mkdocs-material
pip install mike

Once installed you can use following commands from command line:

mkdocs serve - will stat a local server, so you can see the web page generated locally and tet real-time updates to documentation mkdocs gh-deploy - will deploy changed documentation into repository (if you have privileges).

The generated web pages are hen visible at utplsql.org.

Individual project documentation pages are deployed separately from the main organization page. Each corresponding project repository needs to have its own gh-pages branch.

utPLSQL-framework repository uses mike to deploy documentation for specific project version.

Example commands to use are:

• mike deploy develop - to deploy documentation for develop branch
• mike deploy -p develop - to deploy and push documentation for develop branch
• mike deploy -p -u v3.1.12 latest - to deploy and push documentation for version v3.1.12 and update the latest alias to point to that version

How to make an announcement post.

• Create a File in the docs/_posts directory with the file name of YYYY-MM-DD-Blog-Post-Name.md This file will be a standard Markdown file which can be editing with any text editor although there are many offline and online editors for Markdown.
• Add new entry pointing to new announcement file to the start of nav section in mkdocs.yml
• Add new entry to the top of index.md

How to preview site locally

Jekyll will allow you to preview the site locally doing the following:

1. Install Jekyll 3
2. Use Jekyll Serve