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

GitHub

GitHub is a web-based hosting service for software development projects that use the Git revision control system. Hornbill's integrations with GitHub enable the management of Gists, Issues and Repositories from Hornbill workflows.
This is a Free Tier Integration.

Cloud Automations

Gists

OperationDescription
File Add Adds a new file to a Gist.
File Get Retrieves a file from a Gist.
File Remove Removes a file from a Gist.
File Rename Renames a file in a Gist.
File Update Updates a file in a Gist.
Gist Create Creates a new Gist.
Gist Delete Deletes a Gist.
Gist Fork Forks a Gist.
Gist Get Info Retrieves information about a Gist.
Gist Update Updates a Gist.

Issues

OperationDescription
Issue Add Comment Adds a comment to an existing Issue.
Issue Create Creates a new Issue against a repo.
Issue Get Details Retrieves information about an Issue.
Issue Update Updates an Issue.

Repositories

OperationDescription
Commit Add Comment Adds a comment to a Commit.
Commit Get latest Retrieves information about the latest Commit.
File Add Adds a file to a repo.
File Get Retrieves a file from a repo.
File Remove Removes a file from a repo.
File Update Updates a file within a repo.
Repositories Create Creates a new repo.
Repositories Get Info Retrieves information about a repo.
In This Document