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

How to make simple edits

To make simple edits, like fixing typos or adding text, all you need is a web browser and a GitHub account.

Prerequisites

  • A personal or work GitHub account
  • A web browser, connected to the internet

GitHub

If you do not have a GitHub account, you can create one for free.

Once you have created a GitHub account, you can open the Hornbill-Docs home page and see the Hornbill Docs GitHub account.

You can then follow the instructions below to make and submit edits for consideration.

Using GitHub online only

Minor edits are easy using GitHub and its basic editing and Markdown preview capabilities. To make an edit to an existing document, follow these steps:

  1. Log into your GitHub account.
  2. Go to the Hornbill-Docs page.
  3. Click on the Repositories tab, then find and click on the document you want to edit.
  4. At the top right of the page, click Fork. Accept the defaults, then click Create fork. This creates a copy of the HDocBook source code on your account. GitHub automatically navigates you to the home page of the newly forked repo.
  5. Browse the files in the repository and click on an .md file you want to edit. You can also edit the hdocbook.json file to add to or reorganize the navigation tree of the book.
  6. Click the pencil icon (Edit this file), and make your edits to the Markdown text.
  7. Each time you complete your edits on a file, you will be asked to commit the changes and provide a message that will be attached to the commit. This message will be seen by our reviewer when your changes are sent to us, and should be a brief description of what was done. See here for more information about commit messages. Remember: you are only committing changes to your fork, not to the main repository.
  8. Once you have finished your edits, create a pull request. Select the “Pull Requests” tab, and in that view, click the New Pull Request.
  9. Review the changes and make sure you are happy with them, then click Create Pull Request.
  10. Confirm by clicking Create Pull Request once more.

Important

You will notice that the Markdown content can be previewed in GitHub. While the content is rendered, GitHub only supports the basic CommonMark specification, so features such as this info panel will not appear correctly there. Hornbill Docs uses a different specification of Markdown which will render the features correctly.

That’s it — your pull requests have been submitted to the Hornbill Docs team who will review and accept/reject your changes in due course.

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