Git Product home page Git Product logo

cloud-docs's Introduction

Hazelcast Cloud Documentation

Build Staging yellow

This repository contains the Antora components for the Hazelcast Cloud documentation.

The documentation source files are marked up with AsciiDoc.

Docs Structure

This section describes some important information about how this repository is structured:

  • The component name, version, and start page are configured in each branch’s antora.yml file.

  • The navigation for all modules is stored in the ROOT module’s nav.adoc file.

  • The docs site playbook instructs Antora to build the site using content in the main branch.

GitHub Actions

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

Table 1. GitHub Actions
File Description Triggers

validate-site.yml

Validates that all internal and external links are working

On a pull request to the main branch

build-site.yml

Builds the production documentation site by sending a build hook to Netlify (the hosting platform that we use)

On a push to the main branch

Contributing

If you want to add a change or contribute new content, simply submit a pull request to the main branch. The documentation site is set up to build on a push. For more detailed information about the site structure, see our contributing guide.

To let us know about something that you’d like us to change, consider creating an issue.

License

All documentation is available under the terms of a Creative Commons License.

cloud-docs's People

Contributors

jakescahill avatar fantkolja avatar vladoschreiner avatar yunussandikci avatar horakihor avatar huseyinbabal avatar serdaro avatar nosan avatar yamanogluberk avatar ozgeavc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.