Skip to content

Latest commit

 

History

History
89 lines (67 loc) · 4.16 KB

README.md

File metadata and controls

89 lines (67 loc) · 4.16 KB
Raw

liquibase.github.io

Documentation for the liquibase.org site.

Please send pull requests!

Project Overview

The Liquibase site is hosted using GitHub Pages, and generated using Jekyll. Pages are written in MarkDown documents, making use of Liquid template tags.

To build the site for local testing, install Jekyll and its dependencies, including Ruby, the kramdown gem, Python 2.7, and the Pygments package. If you're developing on Windows, there is a handy Portable package of Jekyll you can use. You may still need to fiddle around a bit to get it working, such as installing the kramdown gem ("gem install kramdown") and editing "setpath.cmd".

Once Jekyll is installed, just navigate to this repo's directory, and run jekyll serve. You can then access the site from http://localhost:4000.

If you're using a MarkDown editor with a "live preview" feature, be aware that it's unlikely to support Liquid's syntax highlighting tags, such as "{% highlight xml %}".

Project Setup

Requirements (Bundler)

Steps

Bundler

Install

Once all requirements are met, you can install everything with:

bundle install
Local Dev Server
bundle exec jekyll serve

Or

bundle exec jekyll serve -l

The -l option specifies "live reload" to automatically refresh your browser when a content change is complete.

Local Server

To access the local development server navigate to: 127.0.0.1:4000 (the default Jekyll port).

Requirements (Docker)

Or if you'd prefer to run everything through a docker container:

Docker

./scripts/docker-dev.sh

CI/CD Overview

Staging (staging.liquibase.org)

To see your changes in a staging environment, base your PRs on the staging branch. When the PR is merged to staging, a build server will generate the site and publish it to http://staging.liquibase.org/ within about 10 minutes. After review by the team, staging will be merged to master (typically within 1 business day).

Production (liquibase.org)

To see the changes in production a merge must be made into master. GitHub Pages will handle the deployment.

Sub-sections that are generated

There are several sub-sections of the site that are generated. Two are listed below.

Changes docs

The first generated section is all the documentation for the built-in Liquibase change types (both Core and Pro). The process for generating these is not currently automated by CI/CD, and is documented in the README.md file in the _doc_generators directory

Maven Plugin Docs

The second generated section is the documentation for the Liquibase Maven Plugin. The process for generating these docs and incorporating them into this site:

  • clone the liquibase core source code
  • run mvn -DskipTests package site to compile and package the code, and then generate maven-style site documentation. Most of that documentation will not get used.
  • copy files from liquibase/liquibase-maven-plugin/target/site to liquibase.github.com/documentation/maven/generated
    • There is a shell script in the root of this project copyMavenDocs.sh that will copy the correct files for you.
  • double check the diffs and then commit the changes.

Javadocs

The third generated section is the javadocs. These are on the site in the javdoc section.

As with the maven docs:

  • clone the liquibase core source code
  • run mvn -DskipTests package site to compile and package the code, and then generate maven-style site documentation. Most of that documentation will not get used.
  • copy files from liquibase/liquibase-core/target/apidocs to liquibase.github.com/javadoc selecting * There is a shell script in the root of this project copyJavaDocs.sh that will copy the correct files for you.
  • double check the diffs and then commit the changes.