Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with...

21
Dick Wall

Transcript of Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with...

Page 1: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Dick Wall

Page 2: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Rebooting Community Contributions

Some images courtesy ofhttp://www.pbh2.com/astounding/incredible-star-wars-propaganda-posters/ andhttp://fromplaygroundstopolitics.com/tag/wwii-propaganda-posters/

Page 3: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

//TODO (community):

• Documentation• Bug-fixes• Tools/IDE• Core Libraries• Compiler Features

Page 4: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Why Start with Documentation?

• Most Complete• Needed to Update Docs• Need Help with Documenting Everything Else

Page 5: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

What’s Changed

• Reorg• Gap Closing• Anything I could follow first time through I left

Page 6: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

So it’s Done?

• Noooooooo!• More like a first draft• It will (should) never be done

Page 7: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Pledge Drive

• Wanna help?• Good!• Call today, help us meet our target

Page 8: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

How can I help?

• scala-lang.org/contribute• DEMO!• Be Patient• JIRA -> Github?

Page 9: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Logistics

• scala-internals• [docs], [issue], [tools], [libs]• Read before you write!• Much of this still being sorted out - discuss

Page 10: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Activator Templates

• Lowest Barrier to Entry• Perfect for Coding Examples• https://typesafe.com/activator/template/contribute

• Markdown for Activator?

Page 11: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Report Bugs

• JIRA (for now) (unless other proj)• There is a right way• Check for duplicates!• http://scala-lang.org/contribute/bug-reporting-guide.html

• Docs, Libs, Tools, Language

Page 12: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Scaladoc

• Help us find missing doc• Spell check, grammar, code check• http://scala-lang.org/contribute/scala-standard-library-api-documentation.html

Page 13: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

docs.scala-lang.org

• Expect some revisions• Guides, Overviews, Tutorials• Could also update wiki (or raid wiki for material)• http://docs.scala-lang.org/contribute.html

“fit in” to the repository ( i.e., it should not be a complete duplicate of another article),be polished it must be thorough, complete, correct, organized, and “article-like” (personal programming notes don’t quite fit.)be maintained if the document might require revisions from time to time, it should come with an owner

Page 14: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

scala-lang.org

• Document the Process• Only those with high pain

threshold need apply*• https://github.com/scala/scala-lang

Page 15: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

bugfixes

• Already was well documented• New checklist• http://scala-lang.org/contribute/guide.html

Page 16: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Tools/IDEs

• All New!• Core Tools/Scala IDE• http://scala-lang.org/contribute/tools.html

Page 17: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Core Libraries

• All New!• Core Library Proposals (SLIPs)• http://scala-lang.org/contribute/corelibs.html • http://docs.scala-lang.org/sips/

Page 18: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Yeah, but what’s in it for me?

STICKER DESIGN HERE!

Page 19: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

So much left to do

• SIPs are long overdue for an overhaul

• Move SIPs/SLIPs to a new home?

• SLIP meetings/channels

• Scala Blog!

• JIRA -> Github?

Page 20: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Q&A

• Questions

• Comments

• Brainstorming

Page 21: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything

Dick Wall