[
https://issues.apache.org/jira/browse/SOLR-10301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16005568#comment-16005568
]
Cassandra Targett commented on SOLR-10301:
------------------------------------------
There are now a few docs in place, in the {{solr/solr-ref-guide/meta-docs}}
directory:
* {{asciidoc-syntax.adoc}} - covers basics of the asciidoc syntax, with links
to more details.
* {{editing-tools.adoc}} - is the start of some tools you can use to make
writing in asciidoc easier.
* {{jekyll.adoc}} - describes how we're using Jekyll and how to work with the
templates and config files defined.
* {{pdf.adoc}} - describes how the PDF is built, and how to control various
elements of the design, layout, and styling.
> Create meta-documentation for how to write in asciidoc
> ------------------------------------------------------
>
> Key: SOLR-10301
> URL: https://issues.apache.org/jira/browse/SOLR-10301
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: documentation
> Reporter: Cassandra Targett
> Assignee: Cassandra Targett
>
> If we want to encourage new users and non-committers to contribute patches
> for the Ref Guide, we should document some basics on how to write in
> Asciidoc(tor) format, and how to install/use various tools to improve the
> experience.
> Some basic style guidelines may also be helpful, to ensure a consistent
> experience once docs are published.
--
This message was sent by Atlassian JIRA
(v6.3.15#6346)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
