openstack/tripleo-ci
Code Issues Proposed changes
75ff68608b
tripleo-ci/scripts/website/README.md
Sorin Sbarnea ed27a979d5 Adopt use of pre-commit linting 
Follows the same configuration that was used on
tripleo-quickstart-extras and documented use on tripleo-docs.

Change-Id: Iba8a2db92137f9f6ad28f498627eb1b87039d99f
Story: https://tree.taiga.io/project/tripleo-ci-board/task/381
2018-12-14 15:50:06 +00:00

1.3 KiB
Raw Blame History

tripleo.org

Description

This directory contains scripts and config files used to generate the tripleo.org website.

The following projects are used:

  • tripleo-docs (our tripleo documentation)
  • tripleosphinx (currently hosted on https://github.com/dprince/tripleosphinx.git)
  • reviewday (provides an HTML report of reviews along with LP ticket priorities)
  • tripleo-ci (HTML CI reports and other misc scripts.)

Building the site

Tripleo.org is currently a static HTML website that is regenerated by scripts or via a cron job.

To build the entire site run the following:

cd tripleo-ci/scripts/website OUT_HTML='out_html' bash generate_site.sh

NOTE: This will take some time to run reviewday (which makes remote Gerrit and Lauchpad API connections) and generate the CI reports which contact the API of the upstream Jenkins servers.

If you want to do a quick build to test out new HTML formatting, etc. you can disable the reviewday and CI reports by running the following:

cd tripleo-ci/scripts/website SKIP_REVIEWDAY="Y" SKIP_CI_REPORTS="Y" OUT_HTML='out_html' bash generate_site.sh

Once you executed either of the above commands the HTML website would be in your local out_html directory and can be viewed with any webrower by pointing it to the local filesystem.