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...

Attribution and Thanks

Hornbill Docs is built substantially using open source tools and has drawn inspiration, guidance and ideas from the systems, projects and information made generally available to the open-source community. The Hornbill Docs project is standing on the shoulders of giants: the many individuals, teams and organizations who have contributed time, resources and knowhow to open-source projects to the benefit of everyone. We would like to attribute this project to the projects, individuals and organizations named below, from whom we have drawn inspiration, knowhow and software:

  • Microsoft Learn—a world-class project showing how to embrace an open-source philosophy to produce an outstanding documentation system. Hornbill Docs has drawn huge inspiration from this project, and made use of various open-source artifacts that Microsoft have made available to the community under liberal licensing agreements.
  • Vitepress—a really nice “instant up and running” example of how to create a static documentation site using Markdown and Node.js with a live-edit environment. Although Vitepress turned out not to be the right solution to build Hornbill Docs on, it provided the initial inspiration and kickstart for the Hornbill Docs project.
  • GitHub—a great source control ecosystem and tooling that makes community engagement, and therefore external contribution to Hornbill Docs at scale, possible.
  • Node.js—when development workflows are involved, Node.js and its many projects, libraries and tools are pretty amazing.
  • markdown-it
  • highlight.js
  • Vue.js
  • Express.js
  • others to follow…

We have been using a Wiki tool for the Hornbill Wiki for almost 10 years now, a very long time, but as our product range, number of customers and partner ecosystems have grown, the Hornbill Docs platform will be the foundation and standard for our future documentation strategy.

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