participating in the community - beyond code: presented by cassandra targett, lucidworks
TRANSCRIPT
![Page 1: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/1.jpg)
O C T O B E R 1 1 - 1 4 , 2 0 1 6 • B O S T O N , M A
![Page 2: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/2.jpg)
Participating in the Community: Beyond Code Cassandra Targett
Director of Engineering, Lucidworks
![Page 3: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/3.jpg)
3
02
![Page 4: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/4.jpg)
4
• Director of Engineering at Lucidworks • manage the Open Source team
• Lucene/Solr committer and PMC member
• Not a programmer
About Me 01
![Page 5: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/5.jpg)
5
Why Contribute to Open Source
Understand Solr Better Improve Your SkillsMake Solr Better
![Page 6: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/6.jpg)
01
My boss won’t let me
I don’t have time
I don’t know enough about Solr
I’m not great with Java
![Page 7: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/7.jpg)
7
• No one knows everything about Solr
• If you are using Solr, you know enough to contribute
Obstacle: I don’t know enough about Solr
![Page 8: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/8.jpg)
8
• Make it easy for yourself to work in short bursts
• Start small
• Feedback (+1/-1) is a contribution
Obstacle: I don’t have time 01
![Page 9: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/9.jpg)
9
• Will take too much of a developer’s time
• Project is not a Core Competency
• “Legal” Won’t Like It
• Can’t let competitors know what we’re working on
• Might expose our Intellectual Property
• Don’t understand how the community works
Obstacle: My boss won’t let me
![Page 10: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/10.jpg)
10
• Who has the objection? Is it your boss or the company?
• Can you take out proprietary stuff?
• Cost of maintenance of customizations locally
• Good citizenship
• Helps build your skills
Possible Counter-Arguments 01
![Page 11: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/11.jpg)
11
• Neither am I
• Solr still needs YOU
Obstacle: I’m not a Java Programmer 01
![Page 12: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/12.jpg)
12
What Tools Can You Work With?
![Page 13: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/13.jpg)
13
• It’s easy to be overly vague (“It’s broke”)
• Concrete feedback is a contribution (“When I do XYZ steps, I get these errors”)
• Can you add anything to advance the problem toward a solution?
• What would make life easier for future users?
What Is a Contribution?
![Page 14: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/14.jpg)
14
• Solr Ref Guide missing lots of stuff • Tutorials
• Getting Started
• Use Cases
• Best Practices
• Changes in recent releases
Documentation
![Page 15: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/15.jpg)
15
• Editing limited to committers
• Comments or JIRA issues are main way for non-committers to contribute
• Online is only for the next release. The PDF is 700+ pages long.
Documentation Today
![Page 16: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/16.jpg)
16
• Docs with Code
• Written with Asciidoc
• Static HTML built with Jekyll and Asciidoctor tools
Documentation Future
![Page 17: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/17.jpg)
17
• Docs with code means ability to submit patches and pull requests
• Online versions for each release
• Online as the primary presentation mode (will still produce a PDF)
Benefits of New Doc System
![Page 18: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/18.jpg)
Link to another page
This page will have a TOC
Comment
Headings
Page title
Italics
![Page 19: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/19.jpg)
All rendering of text, headings, links, etc. managed by CSS
HTML Output
![Page 20: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/20.jpg)
Defines doc attributes, some for output
Include full text of another page
Separate the “book” into parts
![Page 21: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/21.jpg)
![Page 22: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/22.jpg)
Info Blocks
Supported:
WARNING NOTE TIP CAUTION IMPORTANT
![Page 23: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/23.jpg)
![Page 24: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/24.jpg)
Code Examples
![Page 25: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/25.jpg)
![Page 26: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/26.jpg)
Code Callouts
* Other languages use a different syntax for a callout; most use line comment syntax, such as // or #, etc.
![Page 27: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/27.jpg)
Labeled List
Level 1
Level 2
![Page 28: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/28.jpg)
![Page 29: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/29.jpg)
29
• Solr-user list is high-volume, ~1000 mails/month
• Help new users understand how to ask their question
• Identify XY problems
• Point users to documentation or explain terminology
Mailing List & IRC
![Page 30: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/30.jpg)
30
• We need help with issues • 2,807 open issues
• 2,466 opened more than 6 months ago
• Try to reproduce with the latest Solr, provide steps to reproduce if it still exists
Verify JIRA Issues
![Page 31: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/31.jpg)
31
Advancing a Bug Report
Report a Problem
Show Logs & Steps to Reproduce
Write a Test to Reproduce
Find Possible Cause in Code
Provide a Patch
Commit Fix
![Page 32: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/32.jpg)
32
• If an issue has a patch, see if it applies cleanly and helps resolve the problem (and doesn’t cause other issues)
• Tests that prove the problem are so helpful
How Can You Advance an Issue?
![Page 33: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/33.jpg)
33
• 14 Ways to Contribute to Solr without Being a Programming Genius or a Rock Star: https://lucidworks.com/blog/2012/03/26/14-ways-to-contribute-to-solr/
• Solr Example Reading Group: bit.ly/SolrERG
More Ideas
![Page 34: Participating in the Community - Beyond Code: Presented by Cassandra Targett, Lucidworks](https://reader031.vdocument.in/reader031/viewer/2022030317/5870a46f1a28abcb078b5773/html5/thumbnails/34.jpg)
34
• Solr needs more users sharing their experiences
• Your feedback is welcome
• Your contributions are needed
Summing Up