Hazelcast Documentation UI

This repository hosts the UI project for the documentation playbook.

Tip	You can see the UI in action on the documentation site.

Table of Contents

• GitHub Actions
• Custom CSS classes
  • .multiple-headed-table
  • .img-inline-block
• Contributing
• Copyright and License
  • Software
  • Branding and Design

GitHub Actions

To automate some elements of the build process, this repository includes the following GitHub Actions:

Table 1. GitHub Actions

File	Description	Triggers
bundle.yml	Packages the UI into a ui-bundle.zip file and commits it to the master branch	On a push to the master branch of this repository

Custom CSS classes

The UI supports adding custom CSS classes to various elements of the documentation site.

.multiple-headed-table

Use this class on tables that have multiple header rows to ensure proper styling. Apply the class to the table element as shown below:

  [.multiple-headed-table, cols="x,x,x" ...]
  |===
  |[align=left]*Core Hazelcast Capabilities*
  |[align=left]*Hey*
  |[align=left]*Hi*
  |[align=left]*Description*

  |Management Center
  |✅
  |❌
  |Get full access to all Management Center features.

  |*Management Center*
  |*Foo*
  |*Bar*
  |*Get full access to all Management Center features.*

  |===

The last column in the example above will be styled correctly as a header row since it contains bold text.

.img-inline-block

Use this class on inline image elements to display them as inline-block elements, allowing text to wrap around them on bigger screens (> 1600px) but showing them as block elements on smaller screens. Apply the class to the image element as shown below:

  [.img-inline-block]
  image:hazelcast-overview.png[Hazelcast Overview,role="related thumb right"]

Contributing

To learn how to develop the UI and preview it locally, see our contributing guide.

Copyright and License

Software

The software in this repository (build scripts, JavaScript files, Handlebars templates, foundation CSS, utility icons, etc) is part of the Antora project. As such, use of the software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0).

Branding and Design

Copyright © Hazelcast 2022. All rights reserved.