Documentation

{{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}}

Service Availability

Hornbill is committed to providing reliable and highly available services to our customers. We maintain a dedicated Service Availability page on our Trust Website to provide customers with up-to-date information on the performance and availability of our services.

Key aspects of Hornbill’s service availability include:

  • Real-time status: The Service Availability page displays the current status of our various services, including any ongoing incidents or maintenance events. This real-time information allows customers to quickly identify if there are any issues impacting Hornbill services and determine if they need to take any action.

  • Historical data: In addition to real-time status, our Service Availability page provides historical data on the performance and availability of all services. Customers can view past incidents, maintenance events, and overall uptime percentages to understand the reliability of Hornbill services over time.

  • Uptime commitment: We are dedicated to maintaining a high level of service availability and commit to a 99.9% uptime Service Level Agreement (SLA) for all customers. This commitment reinforces our dedication to providing reliable services that customers can depend on.

  • Monitoring and incident management: We continuously monitors our services to identify and address any issues that may arise. In the event of an incident, our incident management process ensures that the issue is promptly resolved and that customers are kept informed of the status and resolution.

  • Regular maintenance: To keep our services running smoothly and securely, we perform regular maintenance on our systems. Any scheduled maintenance events are communicated to customers in advance, and we aim to minimize any potential impact on service availability during these times.

By providing comprehensive information on our service availability, we aim to demonstrate our commitment to transparency and reliability. Customers can rely on the Service Availability page to stay informed about the performance and uptime of Hornbill services, ensuring that they can effectively plan and manage their use of the platform.

In This Document