[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16665977#comment-16665977
]
Shawn Heisey commented on SOLR-12930:
-------------------------------------
bq. As for the details of whether it's a section of the standard ref guide or
a sibling directory or...
I think the reference guide needs to be for end users and not include things
being discussed here. I've got no interest in hiding the information from
users, but I think it would be out of place in the reference guide and be
confusing to novices.
So my thought is a sibling dev guide. It certainly wouldn't be as big or as
complex as the ref guide, and although I don't think we necessarily need to
have it all on one page, there probably shouldn't be very many total pages, at
least in the early days. Later, we might decide on some kind of organizational
concept which changes that assumption.
Something else to think about: Do we want to move the complex moving parts for
building the guide so a dev guide could be built that includes things like
ReleaseToDo and similar best practices for Lucene? Would we want to have
separate dev guides for both halves of the project?
bq. Actually, GitHub renders Asciidoc right in the source browse
That's really awesome.
TL;DR: One of my past conversations with Infra yielded a tidbit which I did
mention on [email protected] at one point: At some point in the relatively near
future, all git repositories at Apache will be migrated from the git-wip system
to gitbox. I don't know the details, but apparently gitbox includes some deep
integration with github. I wonder if there might be something interesting to
be done with github's asciidoc rendering.
> Add great developer documentation for writing tests.
> ----------------------------------------------------
>
> Key: SOLR-12930
> URL: https://issues.apache.org/jira/browse/SOLR-12930
> Project: Solr
> Issue Type: Sub-task
> Security Level: Public(Default Security Level. Issues are Public)
> Components: Tests
> Reporter: Mark Miller
> Priority: Major
> Attachments: solr-dev-docs.zip
>
>
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
