Improve documentation for creating a custom publish provider
We have a brief section about custom output providers: https://docs.antora.org/antora/1.0/playbook/configure-output/#custom-provider
However, this documentation could be expanded to show some common custom provider scenarios, such as publishing to git (e.g., GitHub Pages) (see @eshepelyuk comment: #74 (comment 56637378)) or SSH.
While expanding this documentation we should also determine if we want to:
- add additional built-in providers
- develop additional providers but release them separately from the default generator pipeline
- schedule such development if it is desirable/feasible
Additional info:
This example is in the site-publisher architecture guidebook.
- provider: site-publisher-ssh
host: hostname
user: username
agent: true
path: /var/www/html
Done criteria:
-
Write how-to/tutorial and an example of how to do a custom provider and add it to the documentation. -
Decide is we will create the provider that we use as the custom example -
If yes, decide if it will be built-in or auxiliary -
If yes, schedule the development (roadmap and/or issue tracker)
Edited by Dan Allen