[
https://issues.apache.org/jira/browse/SOLR-12930?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17014653#comment-17014653
]
Cassandra Targett commented on SOLR-12930:
------------------------------------------
I converted this sub-task to a full issue in order to expand its scope a little
bit and bring in a thread started by [~janhoy] in June 2019
(https://lists.apache.org/thread.html/2ae2246ca26b463c53c2af2a6148bdfcab0b21befc0a753c5633fadd%40%3Cdev.lucene.apache.org%3E).
This issue originally focused on developer docs for tests, but I'd like to
expand the scope to cover adding all our project-documentation to our source
repo. To that end I also changed the issue title (was: "Add great developer
documentation for writing tests.").
The mail thread linked above suggested adding 3 separate guides:
* /dev-docs : Common info i.e. Git, Pull requests, building, doing releases
etc. Publish in TLP site
* /lucene/dev-guide : Lucene-specific developer content. Publish in Lucene web
site
* /solr/dev-guide : Solr-specific developer content. Publish in Solr web site
One suggestion added to this issue was to let people look at the docs in
GitHub. I think we could phase doing this and use this issue for just creating
the structure and starting to add some docs and file another issue for figuring
out how to publish it and where (since the sites are in flux a bit with needing
to move them, maybe it's easier to wait until that's settled? just an idea).
I'll create a PR based on this issue just to create a sample structure so we
can discuss it and figure out how to move forward.
> Add developer documentation to source repo
> ------------------------------------------
>
> Key: SOLR-12930
> URL: https://issues.apache.org/jira/browse/SOLR-12930
> Project: Solr
> Issue Type: Improvement
> Components: Tests
> Reporter: Mark Miller
> Priority: Major
> Attachments: solr-dev-docs.zip
>
>
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org
For additional commands, e-mail: issues-h...@lucene.apache.org
