[jira] [Commented] (SOLR-12961) Ref Guide: Add keyword metadata to pages
[ https://issues.apache.org/jira/browse/SOLR-12961?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16680033#comment-16680033 ] Cassandra Targett commented on SOLR-12961: -- I've attached a patch that adds two page-level metadata attributes to almost all the pages of the Ref Guide: a "user level", or audience knowledge level, and "keywords". The user level ({{page-userlevel}}) I pretty much settled on Introductory, Beginner, Intermediate, Advanced. The attached "userlevel.json" shows how those ended up being distributed page-count-wise. The "keywords.json" shows the distribution of keywords I chose (so far). I pretty much made these up as I went along and I did it rather free-form without trying to create or adhere to any defined taxonomy. I still need to a bit of review to see if there's consolidation of plurals/singular or similar terms that could happen, so IMO this isn't ready to commit but is ready for some feedback on the general idea. > Ref Guide: Add keyword metadata to pages > > > Key: SOLR-12961 > URL: https://issues.apache.org/jira/browse/SOLR-12961 > Project: Solr > Issue Type: Improvement > Security Level: Public(Default Security Level. Issues are Public) > Components: documentation >Reporter: Cassandra Targett >Assignee: Cassandra Targett >Priority: Major > Fix For: 7.6, master (8.0) > > Attachments: SOLR-12961.patch, keywords.json > > > As a continuation of improvements in SOLR-12746, another thing we should do > is add keyword metadata to the HTML pages. Currently our pages have this in > the {{}} section: > {code} > > {code} > We have the structure in place for it in the page templates, we just need to > populate with some keywords. > The idea behind doing this is that these terms could be a source for facet > buckets when we get a Ref Guide search going via SOLR-10299. -- This message was sent by Atlassian JIRA (v7.6.3#76005) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org
[jira] [Commented] (SOLR-12961) Ref Guide: Add keyword metadata to pages
[ https://issues.apache.org/jira/browse/SOLR-12961?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel=16675723#comment-16675723 ] Cassandra Targett commented on SOLR-12961: -- There's two ways to approach this, and we can do either or both of them. # Populate the keywords with alternate terms or key phrases the give clues to what the page is about. These would not be pre-determined, but instead decided by page authors as they see fit. # Populate the keywords with a predetermined list of topics the subject of the page fits into and/or relates to. This requires coming up with a reasonably complete list of topics and agreeing on their form. It also requires more precommit-style validation to ensure the entries used by authors fit the accepted form of terms. (We could also mix them both and just let everyone do what they want...but if we want to use them for facet buckets, a free-for-all would probably result in GIGO metadata.) They both have their place and purpose. The first helps users identify a page based on words they use which may not be in the title of the page. The second helps users find all the pages about the same topic more easily. I'm a librarian at heart and by training, so of course I like both. The second option is more work, so I'll start out with the first option and see what I can come up with. > Ref Guide: Add keyword metadata to pages > > > Key: SOLR-12961 > URL: https://issues.apache.org/jira/browse/SOLR-12961 > Project: Solr > Issue Type: Improvement > Security Level: Public(Default Security Level. Issues are Public) > Components: documentation >Reporter: Cassandra Targett >Assignee: Cassandra Targett >Priority: Major > Fix For: 7.6, master (8.0) > > > As a continuation of improvements in SOLR-12746, another thing we should do > is add keyword metadata to the HTML pages. Currently our pages have this in > the {{}} section: > {code} > > {code} > We have the structure in place for it in the page templates, we just need to > populate with some keywords. > The idea behind doing this is that these terms could be a source for facet > buckets when we get a Ref Guide search going via SOLR-10299. -- This message was sent by Atlassian JIRA (v7.6.3#76005) - To unsubscribe, e-mail: dev-unsubscr...@lucene.apache.org For additional commands, e-mail: dev-h...@lucene.apache.org