Documentation
    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

INDEX

Documentation Library

Search for information on Hornbill Documentation.

{{docApp.searchError}}

{{docApp.searchResultFilteredItems.length}} results for "{{docApp.currentResultsSearchText}}" in {{docApp.searchFilterBySpecificBookTitle}}

Have questions about this site?

What is this site?

  • This website is Hornbill's new product documentation website and is currently under development.
  • It is intended that all existing and future public-facing documentation we produce will be available to search, browse and share.
  • Hornbill's current documentation is available at Hornbill Wiki but over time this content will be migrated to this documentation site.
  • Please feel free to have a look around at any time.

Why has Hornbill created this site?

  • Hornbill's products have moved on considerably since we introduced it almost 10 years ago. At the time, the MediaWiki tool was sufficient, but we have outgrown it.
  • Our customers are more enterprise focused and more self-sufficient than ever before, so for 2023 and beyond we have established a new documentation platform and team to drive our documentation initiative forwards.
  • We are aiming to deprecate the use of Hornbill Wiki for most Hornbill related documentation.
  • We want to enable our growing partner network with product resources and information, documentation beyond our Wiki approach is required.
  • We could definitely do with some help, and may even pay for some! If you have domain knowledge and would like to help, please check out our Hornbill Docs Contributor Guide and contact the Hornbill docs team at docs@hornbill.com.

What will this site be good for?

  • Community contribution will be facilitated, encouraged, and most welcome.
  • High quality documentation, will be kept up to date as rapidly as our products evolve.
  • Real-time content search and discovery.
  • Articles organized into books, books into libraries, creating a more natural and logical structure to our documentation.
  • Legacy API documentation and various other documentation sources will all be consolidated into a single unified documentation system.
  • Documentation available in browser as well as printable/viewable as PDF on demand.
  • Personalized documentation experience, allowing dark/light mode, article subscriptions, social media sharing and other useful features.
  • Almost all publicly available documentation on docs.hornbill.com will be open-source and available to fork on GitHub, allowing customers to derive their own custom documentation around Hornbill products should they wish to.

What is the timeline for this site?

  • We have taken the decision to publish and make available early, there is very little content at this time.
  • As and when we have completed/usable documentation, it will be published here.
  • We have a host of additional features we wish to add over time, so please watch this space.
  • We expect most of our existing documentation should be reviewed/migrated to docs.hornbill.com over the coming months.
  • The documentation project will be ongoing, will continue to expand, evolve and improve day-by-day.

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

{{group.title || group.id}}

{{group.description}}

  1. {{book.title}}

{{group.title}}

{{book.title}}
More...

Welcome to Hornbill Docs Contributor Guide

The Hornbill Docs system is a complete end-to-end solution for creating and publishing documentation to Hornbill Docs so that our customers, partners and others can browse and search our published documentation.

Intended Audience

This documentation is useful for anyone involved in the development of content for Hornbill Docs and as a workflow reference for the Hornbill Docs team at Hornbill. The vast majority of our documentation is published on GitHub—we have adopted an open-source philosophy for our documentation, and welcome contributions to our documentation project from anyone interested in getting involved. This guide provides the information needed to contribute to the Hornbill Docs project.

Hornbill Docs Overview

The Hornbill Docs system is a complete end-to-end system for creating and publishing documentation to Hornbill Docs so that our product and customer success teams, customers, partners and any other interested parties can access, and contribute to, our published documentation.

Sharing your expertise with others on Hornbill Docs helps everyone in our community achieve more. Use the information in this guide to learn how to make updates to an existing published article, or publish new content to Hornbill Docs.

Almost all of the documents available on Hornbill Docs are published as open-source projects, hosted on GitHub. Documents that are published on GitHub can be forked by anyone wishing to contribute to Hornbill’s documentation, who can make changes/additions to the content and submit a pull request to the Hornbill Docs team for review and inclusion in future revisions of the published documentation.

This open-source approach improves communication and facilitates better knowledge sharing, helping our product and content teams, and giving customers access to the collective knowledge. Contribution to Hornbill’s documentation is moderated, ensuring content meets our quality and inclusion standards.

The documentation system is modeled around the notion of a Library of Documents. Each document is called a Book, and we call the collection of published Books the Library. There is one global library for all published Books that are presented on Hornbill’s Documentation Website.

You can think of the Hornbill Docs system as conceptually representative of a traditional book library, where a community (our customers, partners and team members) all have access to a public library (the document website), with all of the Books in that library being organized and categorized into different sections and locations within the library for accessibility.

Books can contain textual content, pictures, downloadable assets, embedded video or any other web based resources you would typically find in a web application, and Book content can be created in multiple languages where required.

Books can be created and authored by Hornbill’s Documentation Team. However, most Books are created and published as open source to facilitate contributions by our partners, customers and other interested parties. Open source nooks are available in source code format, published on GitHub, making it possible for anyone to fork the Book to their own GitHub account, make changes and submit a pull request to Hornbill’s Documentation Team for review and inclusion in the officially published documents.

  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document