[jira] [Commented] (SOLR-14840) Convert Overseer Google doc to asciidoc for addition to Git repo

["Cassandra Targett (Jira)" <ji...@apache.org>]

    [ https://issues.apache.org/jira/browse/SOLR-14840?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17191841#comment-17191841 ] 

Cassandra Targett commented on SOLR-14840:
------------------------------------------

Here is the branch: https://github.com/apache/lucene-solr/tree/jira/solr-14840/solr/dev-docs/overseer

Since the original Google doc had images, I put the new overseer.adoc into a directory under the dev-docs directory, and the images in a directory under that. In Github the new file displays quite nicely.

The original Google doc had a section which had been crossed out - I omitted that from this conversion. Otherwise, however, the content should be identical. There might be a few lingering format problems that need to be fixed.

Ilan's original highlighted problematic areas with a warning symbol next to the paragraph. In the conversion, I put those into Asciidoc's warning style block.

I think it's worth considering if this document should be broken up into smaller docs (per class maybe?). I don't have a particular opinion about that at this time, but think it's worth a thought in general.

> Convert Overseer Google doc to asciidoc for addition to Git repo
> ----------------------------------------------------------------
>
>                 Key: SOLR-14840
>                 URL: https://issues.apache.org/jira/browse/SOLR-14840
>             Project: Solr
>          Issue Type: Improvement
>      Security Level: Public(Default Security Level. Issues are Public) 
>          Components: documentation
>            Reporter: Cassandra Targett
>            Priority: Minor
>
> Back in April [~ilan] shared via the mailing list a Google doc he had written which provided extensive documentation of the Overseer. It's an impressive document, and one we should preserve in the repo for other developers to use.
> I recently offered to convert the Google doc to Asciidoc format to add it to the {{solr/dev-docs}} directory, so this issue is mostly so I can make a branch for Ilan (and others) to review.
> Mailing list thread: https://lists.apache.org/thread.html/rf41ae1356bd2e4e68b3c3d835c5e368493ae0ee14a024402c88c795e%40%3Cdev.lucene.apache.org%3E
> Original Google doc: https://docs.google.com/document/d/1KTHq3noZBVUQ7QNuBGEhujZ_duwTVpAsvN3Nz5anQUY/edit



--
This message was sent by Atlassian Jira
(v8.3.4#803005)

---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org