updating-website.md

layout	title
default	Updating the website

Updating the website

{:.no_toc}

• Will be replaced with the ToC, excluding a header {:toc}

The setup

The whole website is available in a dedicated Git repository, you can also use a Github mirror.

The master branch contains the current source code of the website, any changes should be applied to this branch, also any Pull Request should be opened against this branch as well.

We are using Jekyll and mix of Markdown pages with raw Html pages, where Markdown is a preferred option.

WARN: do not manually change the asf-site or ast-staging branches, they will be automatically updated by a CI server.

The whole build of the website is orchestrated by .asf.yaml, please refer to the docs for more details. The main build of the website is performed by a buildbot job, the staging site is build and deployed by a Jenkins job - buildbot doesn't support staging site deployment yet.

Applying a change

If you are a contributor, and the change is small you can push it directly to the master branch. In any other case please open a Pull Request. The Pull Request will be automatically build and deployed to the staging site.

You can then review your changes before applying them to the master branch.

Deploying JavaDocs

There is a dedicated Jenkins job which is used to update the JavaDocs based on the latest release. If you have a proper privileges you can start the job and provide a Git tag of the latest release, eg. STRUTS_2_5_22. Based on the tag, Jenkins will generate a proper JavaDocs and deploy them directly into the website. You can verify them by using this link.

Example styles

Below you will find an example styles and panels you can use when developing the webpage

Text alignment

Text right {:.text-right}

Text right
{:.text-right}

Text center {:.text-center}

Text center
{:.text-center}

Text left {:.text-left}

Text left
{:.text-left}

Text justify {:.text-justify}

Text justify
{:.text-justify}

Text color

Text primary {:.text-primary}

Text primary
{:.text-primary}

Text info {:.text-info}

Text info
{:.text-info}

Text success {:.text-success}

Text success
{:.text-success}

Text warning {:.text-warning}

Text warning
{:.text-warning}

Text danger {:.text-danger}

Text danger
{:.text-danger}

Background

Background primary {:.bg-primary}

Background primary
{:.bg-primary}

Background info {:.bg-info}

Background info
{:.bg-info}

Background success {:.bg-success}

Background success
{:.bg-success}

Background warning {:.bg-warning}

Background warning
{:.bg-warning}

Background danger {:.bg-danger}

Background danger
{:.bg-danger}

Label

Label primary {:.label .label-primary}

Label primary
{:.label .label-primary}

Label info {:.label .label-info}

Label info
{:.label .label-info}

Label success {:.label .label-success}

Label success
{:.label .label-success}

Label warning {:.label .label-warning}

Label warning
{:.label .label-warning}

Label danger {:.label .label-danger}

Label danger
{:.label .label-danger}

Panel

Info panel {:.alert .alert-info}

Info panel
{:.alert alert-info}

Success panel {:.alert .alert-success}

Success panel
{:.alert alert-success}

Warning panel {:.alert .alert-warning}

Warning panel
{:.alert alert-warning}

Danger panel {:.alert .alert-danger}

Danger panel
{:.alert alert-danger}