HCL-TECH-SOFTWARE/volt-mx-docs

Official documentation for HCL Volt MX (https://www.hcltechsw.com/volt-mx). The site is accessible at http://opensource.hcltechsw.com/volt-mx-docs/

Volt MX documentation

Usage

View the documentation for product features and usage information.

Contributing

Bug reports on product documentation and pull requests are welcome on GitHub at https://github.com/HCL-TECH-SOFTWARE/volt-mx-docs. This is Volt MX product documentation site not product support platform, all bug reports and pull requests shall pertain to product documentation. Updates shall be performed only to markdown files under volt-mx-docs/source.

• Install MkDocs
• Clone Volt MX docs repository
• Create a new branch.
• Update files as needed.

Validate document

To perform updated document check before raising pull request, run volt-mx-docs\build.bat or volt-mx-docs/build-mac.sh. Output index.html is available in volt-mx-docs/docs/documentation.

Submitting code changes:

• Open a Pull Request
• Await markdown files review, merge and a build
• Version number is increased post each build. <MAJOR.MINOR> versioning scheme is being followed for Volt MX documentation release.

License

The documentation is available as open source under the terms of the Apache License 2.0.