[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[ASF GitHub Bot (JIRA)]

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

ASF GitHub Bot commented on SOLR-11144:
---

Github user HoustonPutman closed the pull request at:

https://github.com/apache/lucene-solr/pull/229


> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
> Fix For: 7.2, master (8.0)
>
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[ASF GitHub Bot (JIRA)]

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

ASF GitHub Bot commented on SOLR-11144:
---

Github user HoustonPutman commented on the issue:

https://github.com/apache/lucene-solr/pull/229
  
Analytics reference merged in [this 
commit.](https://github.com/apache/lucene-solr/commit/6428ddb10e975f8b8955aebb9b59e5de201face0)


> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
> Fix For: 7.2, master (8.0)
>
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

I did neglect to add the PR #s to my commit message to close them - if you 
wouldn't mind closing them yourself, Houston, that would be great.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
> Fix For: 7.2, master (8.0)
>
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[ASF subversion and git services (JIRA)]

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

ASF subversion and git services commented on SOLR-11144:


Commit ebcf7c7acfd49d29193cb44fa6f1759f0d156658 in lucene-solr's branch 
refs/heads/branch_7x from [~ctargett]
[ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=ebcf7c7 ]

SOLR-11144: Add Analytics Component docs to the Ref Guide


> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[ASF subversion and git services (JIRA)]

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

ASF subversion and git services commented on SOLR-11144:


Commit 6428ddb10e975f8b8955aebb9b59e5de201face0 in lucene-solr's branch 
refs/heads/master from [~ctargett]
[ https://git-wip-us.apache.org/repos/asf?p=lucene-solr.git;h=6428ddb ]

SOLR-11144: Add Analytics Component docs to the Ref Guide


> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Houston Putman (JIRA)]

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

Houston Putman commented on SOLR-11144:
---

I'm fine keeping the "Reference" out of the titles.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

bq. Changed the Titles of the mismatched pages to reflect their shortnames. (So 
I removed the 'Reference' at the end of each)

Since my previous comment, Hoss figured out a way to remove the need for that 
title/shortname/filename match (SOLR-11540), so we don't need to declare 
page-shortname and page-permalink as params on each page anymore. I'll take 
those out of your latest patch for you. If you want to add "Reference" back 
into the titles, let me know and I'll add those back in - we don't need to 
match titles to filenames anymore at all.

The other changes look pretty straightforward, I'll do one more review for 
typos and commit.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Houston Putman (JIRA)]

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

Houston Putman commented on SOLR-11144:
---

[~ctargett], I'm going through the changes now. Thank you for all the help!

I've updated the following and made a pull request:
* Added parameter sections for all of the facet types
* Fixed the example analytics expression, since there was a mistake in one of 
the lines.
* Changed the Strings section in Analytics-expression-sources.adoc to use and 
unordered list instead of an ordered list.
* Changed the Titles of the mismatched pages to reflect their shortnames. (So I 
removed the 'Reference' at the end of each)

[Here is the pull request.|https://github.com/apache/lucene-solr/pull/269]

Did I miss anything? Is there anything else that we need to do?

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

Sounds good Houston, thanks.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Houston Putman (JIRA)]

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

Houston Putman commented on SOLR-11144:
---

Hey [~ctargett]. Sorry I'm a bit busy right now, but I should be able to get 
around to this next week. I believe the Analytics bug fix patch is going into 
7.2, so I'm ok with waiting for 7.2 for this.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

[~houstonputman] - did you have any thoughts on my feedback in the previous 
comment? I had hoped to get this into the 7.1 Ref Guide, but we need to get 
that going soon and if you're tied up with other things we can wait until 7.2.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

I've finally finished a rather thorough round of review & edits for these docs. 
I changed a lot of stuff, so I created a branch {{jira/solr-11144}} and have 
pushed that so you can pull the branch if you want - it's up to date with 
master as of a few minutes ago.

I didn't keep a list of the stuff I changed as I went, so this list is from 
memory - if you notice anything I changed to be incorrect, please let me know.

* I changed all of the usages of ⟹ to {{\=>}}. The character you used rendered 
very small in both HTML and PDF. I could have left it as {{=>}} and asciidoctor 
would have converted it to a nice icon that's larger than what you had used, 
but this doesn't work in the PDF at all, so precommit doesn't allow it.
* A lot of your examples in the reference pages were in the form of {{"example 
input" => "example output"}}, but the input/output sections should be 
separately monospaced to avoid confusion about which is input and which is 
output. I changed these so it would look like "{{example input}} => {{example 
output}}" instead.
* I normalized a lot of uses of bold text, particularly in examples, and 
changed a lot of capitalization of words to lower case. 
* In {{analytics-reduction-functions.adoc}}, all of the examples were marked as 
Labeled Lists (with the double colons at the end of the line), but unlike the 
other pages of reference, there are no examples that follow. Since there was no 
entry for the list, this broke the PDF. I removed all of these so they are just 
plain examples on a single line for each reduction function.
* In {{analytics.adoc}}:
** I changed the presentation of many of the sections of parameters - we 
generally do these as Labeled Lists, but you used nested unordered lists (i.e., 
bullet points) which were quite confusing. I _think_ I grokked the 
relationships between all the parameters, but you should double-check those 
because I had a hard time wrapping my head around it completely. As a related 
note, parameters should also always be in monospace instead of bold - I think I 
caught all of these, but may have missed one or two.
** I added some comments that we should address, particularly in the faceting & 
grouping section. I could see this aspect of the component being used a lot, 
and the parameters seem under-described to me.
** The section on Setup didn't cover adding the path to the .jar to the  
directive in solrconfig.xml, so I added that. The Overview section was also 
removed and replaced with it's sub-sections as main sections.

One thing I did not fix but needs to be fixed is a mismatch in some pages 
between the page title and the page shortname - in order for PDF linking to 
work properly, every {{page-shortname}} must match the title and must match the 
filename (without the .adoc file extension), due to the way the PDF is built as 
one massive file. If they don't match, the bookmark reference in the PDF won't 
point to anything and users will jump halfway through a section (if the link 
happens to work at all, sometimes it won't). This wasn't something you would 
have known when you wrote this, but we need to fix it before we commit it. We 
can either change the {{page-shortname}} & filenames on these pages or change 
the page titles - which do you prefer? These are the pages with the mismatch:

* analytics-reduction-functions.adoc
* analytics-mapping-functions.adoc
* analytics-expression-sources.adoc

I think that's the bulk of what I changed but may have forgotten some major 
things since I've been looking at this off & on for a few weeks between other 
tasks - if you have any questions, please let me know.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Houston Putman (JIRA)]

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

Houston Putman commented on SOLR-11144:
---

Sounds good, thanks for the update.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

Sorry [~houstonputman], I looked at it briefly but not as deeply as I wanted 
to, then went on vacation and now I'm focused on finishing the minimum needs 
for 7.0 Ref Guide. I haven't forgotten about it yet. I was tentatively hoping 
we could get it into 7.0, but probably more likely 7.1.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Houston Putman (JIRA)]

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

Houston Putman commented on SOLR-11144:
---

Any feedback [~ctargett]?

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[Cassandra Targett (JIRA)]

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

Cassandra Targett commented on SOLR-11144:
--

Thanks for the pull request! I'll assign this to myself and will try to get you 
feedback in the next couple of days.

> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Assignee: Cassandra Targett
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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

[jira] [Commented] (SOLR-11144) Analytics Component Documentation

[ASF GitHub Bot (JIRA)]

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

ASF GitHub Bot commented on SOLR-11144:
---

GitHub user HoustonPutman opened a pull request:

https://github.com/apache/lucene-solr/pull/229

SOLR-11144: Initial version of the analytics component reference.



You can merge this pull request into a Git repository by running:

$ git pull https://github.com/HoustonPutman/lucene-solr 
analytics-solr_ref_guide

Alternatively you can review and apply these changes as the patch at:

https://github.com/apache/lucene-solr/pull/229.patch

To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:

This closes #229


commit 54410ff9d13efcf174cff3ad0d8667cbe84e75a1
Author: Houston Putman 
Date:   2017-08-03T16:33:00Z

SOLR-11144: Initial version of the analytics component reference.




> Analytics Component Documentation
> -
>
> Key: SOLR-11144
> URL: https://issues.apache.org/jira/browse/SOLR-11144
> Project: Solr
>  Issue Type: Improvement
>  Security Level: Public(Default Security Level. Issues are Public) 
>  Components: documentation
>Affects Versions: 7.1
>Reporter: Houston Putman
>Priority: Critical
>
> Adding a Solr Reference Guide page for the Analytics Component.



--
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