Docs

Overview

ArangoDB’s documentation repository provides a comprehensive guide for users across all versions of its database solution. Utilizing the Jekyll static site generator, the documentation framework supports collaborative contributions and enables users to easily suggest changes or improvements. With automatic previews in place, contributors can track the progress of their updates seamlessly, ensuring a dynamic and user-friendly experience for all involved.

The repository outlines essential procedures for building documentation locally, highlighting both Jekyll and Docker options for users who prefer to manage their development environment differently. This flexibility caters to a wide range of user preferences, from novice contributors to seasoned developers.

Features

• Automatic Previews: Each pull request triggers a build process that allows contributors to view live previews of their changes, making it easy to identify issues before finalizing.

• Contributor License Agreement: External contributions are supported through a straightforward Contributor License Agreement, simplifying the process of submitting contributions.

• Flexible Building Options: Users can choose to build documentation either with Jekyll or Docker, accommodating different levels of user expertise and preferences.

• Easy Contribution Process: The platform allows for direct edits on GitHub, facilitating a quick and efficient contribution workflow through the use of pull requests.

• Local Development Support: The documentation includes detailed instructions for setting up a local environment to view and edit documents, enhancing the collaborative experience.

• Symlink Support Requirement: Users are informed about the need for symlink support in Git for Windows to ensure a smooth cloning process of the repository.

• Quick Startup Instructions: Clear instructions to start the Jekyll server allow users to view their changes in real-time as they develop documentation.