Kentra Website

This repository contains the source code for the Kentra project documentation website, built with Hugo.

About

This site provides comprehensive documentation for Kentra, including installation guides, API references, architecture, tutorials, and best practices to help users get started and make the most of the project.

Contributing to documentation

Before you begin, ensure you have the following installed:

• Hugo (Extended version recommended)
• Git
• go (used for managing the theme installed as a hugo module)

Getting Started

Clone the Repository

git clone https://github.com/kentrasecurity/website
cd website

Run the Development Server

Start the Hugo development server with live reload:

hugo serve -D

The site will be available at http://localhost:1313/. The -D flag includes draft content.

Project Structure

.
├── archetypes/          # Content templates
├── content/             # Documentation content (Markdown files)
├── data/                # Data files (YAML, JSON, TOML)
├── layouts/             # Custom HTML templates
├── static/              # Static assets (images, CSS, JS)
├── themes/              # Hugo theme(s)
├── config.toml          # Site configuration
└── README.md            # This file

Contributing

We welcome contributions to improve the Kentra documentation! Here's how you can help:

Reporting Issues

If you find errors, broken links, or have suggestions, please open an issue.

Submitting Changes

1. Fork the repository
2. Create a new branch (git checkout -b feature/improve-installation-docs)
3. Make your changes
4. Test locally with hugo server
5. Commit your changes (git commit -m 'Improve installation documentation')
6. Push to your branch (git push origin feature/improve-installation-docs)
7. Open a Pull Request

Documentation Style Guide

• Use clear, concise language
• Include code examples where applicable
• Follow the existing document structure and formatting
• Test all commands and code snippets before submitting

Deployment

This site is automatically deployed to github pages when changes are pushed to the main branch. The deployment process is handled by GitHub Actions.

License

This documentation is licensed under the APACHE license, See the LICENSE file for details.

Support

• Documentation Issues: Open an issue in this repository
• Kentra Project Issues: Visit the main Kentra repository

Acknowledgments

Built with Hugo and blowfish theme.

---

For more information about the Kentra project itself, visit the main repository.