kbase / project_guides

This repo contains documents and guides that describe project principles, how-to docs, etc.
MIT License
7 stars 33 forks source link

Update How_to_add_a_new_data_type.md #19

Closed nlharris closed 9 years ago

nlharris commented 9 years ago

Added title, made some minor wording/punctuation improvements.

Added FIXME to that places that need work, to make it harder to forget to update them.

Comment on line 417: "From solrconfig.xml you need to modify line 106 to point to the correct directory for the index data of your type." If there's a new release of solrconfig.xml, it might not be line 106 anymore, so you should include that line here (or at least say which variable you need to set/modify). (Similarly for the other line numbers mentioned here--describe what's on the lines. No one is going to think to come and update this document if the SOLR installation is updated and the line numbers change!)

Line 429: Does Solr use the term "ingest"? If not, I would change this to "input" (but if "ingest" is their term for it, then it's ok to leave it).

mlhenderson commented 9 years ago

Data ingestion ("ingest") is common terminology, not just solr specific language. Maybe I'm missing something here.

mlhenderson commented 9 years ago

It is my responsibility to keep this document up to date.

nlharris commented 9 years ago

On Apr 16, 2015, at 3:03 PM, Matt Henderson notifications@github.com wrote:

Data ingestion ("ingest") is common terminology, not just solr specific language. Maybe I'm missing something here.

Nah, probably I am. You can keep it “ingest”.

nlharris commented 9 years ago

On Apr 16, 2015, at 3:05 PM, Matt Henderson notifications@github.com wrote:

It is my responsibility to keep this document up to date.

Great! I just figured there were ways to lower the hassle of updating it.

mlhenderson commented 9 years ago

I don't think I can reply to a comment in that way directly using github. Maybe if I strictly used email, but then I can't accept the PR that way.

On Thu, Apr 16, 2015 at 4:50 PM, Nomi Harris notifications@github.com wrote:

On Apr 16, 2015, at 3:03 PM, Matt Henderson notifications@github.com wrote:

Data ingestion ("ingest") is common terminology, not just solr specific language. Maybe I'm missing something here.

Nah, probably I am. You can keep it “ingest”.

BTW, when I get these comments from you, I can’t see what part of the text (or which of my suggestions) they pertain to.

Nomi

— Reply to this email directly or view it on GitHub https://github.com/kbase/project_guides/pull/19#issuecomment-93863826.

fperez commented 9 years ago

@mlhenderson, since you're on top of this doc, do you think this is ready for merge at this point, or do you guys want further work/discussion before merging?

mlhenderson commented 9 years ago

@fperez It is not ready to merge yet. Let me check with Nomi on the changes I asked for and see if we can fix it so it can be accepted. Most of her edits are fine, there were a couple that I wanted changed before merging.

mlhenderson commented 9 years ago

Thanks Nomi!