[ https://issues.apache.org/jira/browse/SOLR-10301?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16093543#comment-16093543 ]
Hoss Man commented on SOLR-10301: --------------------------------- FWIW: I don't have any objections to the "how-to-contribute.adoc has diff content depending on format and in HTML it includes all the meta-docs" idea, but as a straw man alternative ... * we could add a second "sidebar" that lists all the meta-docs * the PDF could continue to only include stuff in the "main" sidebar ** the main doc -- in either form -- could have a "how-to-contribute.adoc" that is short and links to the (online) meta-docs the net effect would probably be very similar, except that: * each metaa-doc page would have it's own html page and it's own entry in the (new) "How to contribute" sidebar * we wouldn't need to rely on format conditional logic -- which _might_ reduce confusion for folks who edit these pages? (just hypothosizing) ---- (this is also something we could easily punt on until later if/when we decide that the meta-docs have grown significantly and we want to stop including them all in a single html page) > 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.4.14#64029) --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org