Contribute as a writer
User documentation is essential to make the plugin approachable for all types of users. This page provides an introduction where documentation content exists and how it is structured.
With this knowledge, writers can then proceed to one of the specific "How-To" sections adjacent to this page for guidance on how to contribute changes to the documentation, content and layout.
What sources exist to build the plugin’s website?
The documentation for this plugin is hosted on the plugin’s homepage https://intellij-asciidoc-plugin.ahus1.de/
It has the following areas:
- Start page
All files related to the start page are in the Git repository https://github.com/ahus1/intellij-asciidoc-plugin.ahus1.de in the folder startpage. That folder contains both the content (look for AsciiDoc files with the extension .adoc) plus several theme and assets related files. The start page is built with the Jekyll static site generator.
All documentation content on the website is next to the plugin’s code at https://github.com/asciidoctor/asciidoctor-intellij-plugin in the sub-folder doc. Every time something in the docs changes, this triggers a build on Netlify using this GitHub action. The theme for this site is in the Git repository https://github.com/ahus1/intellij-asciidoc-plugin.ahus1.de in the folder _antora. The user’s guide and the contributor’s guide are built with the Antora documentation site generator.
- Configuration files for hosting
The plugin’s homepage is hosted on Netlify. Configuration files for hosting are in the GitHub repository https://github.com/ahus1/intellij-asciidoc-plugin.ahus1.de. Files like netlify.toml, build.sh and redirects instruct Netlify how to build and publish this site. A sub-folder lambda contains scripts to notify the maintainers of successful and unsuccessful deploys.
There are three how-tos to walk you through changing the content of the website:
A more general guide on how to write documentation: