Skip to content

Latest commit

 

History

History
32 lines (18 loc) · 2.04 KB

INTEGRATION-GUIDE.adoc

File metadata and controls

32 lines (18 loc) · 2.04 KB
Raw

Integrating a New Docs Project into the Docs Site

After creating your site, you need to complete the following steps to publish it on docs.hazelcast.com:

  1. Publish to docs.hazelcast.com.

  2. Create any redirects that you need such as for the latest/ alias.

  3. Add your project’s URL to the search indexer’s configuration.

  4. Configure docsearch in the UI to display your index in search results.

Publishing to docs.hazelcast.com

The Antora playbook in the hazelcast-docs repository defines the content that gets published to docs.hazelcast.com.

The hazelcast-docs repository is separated into two branches: develop (staging site) and main (production site).

To publish the content of your project to docs.hazelcast.com, add your repository to the content.sources object of the antora-playbook.yml file in the develop branch, then apply the changes to the main branch.

On a merge to the hazelcast-docs repository, a build hook is triggered and the site is built from the playbook. You can monitor the build in Netlify.

Creating Redirects

To create a URL alias for the latest version of your content, see Redirects.

Configuring the Search Index

To index your content and make it available in our internal search results, see Search.

Configuring Docsearch

To display relevant versions of products in the search results, we apply filters in the UI project. For an example, see this filter for the JDBC driver docs.

After making changes to the UI project, make sure to create and release a new package.