dick wall - lightbenddownloads.typesafe.com/website/presentations... · why start with...
TRANSCRIPT
![Page 1: Dick Wall - Lightbenddownloads.typesafe.com/website/presentations... · Why Start with Documentation? •Most Complete •Needed to Update Docs •Need Help with Documenting Everything](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/1.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/2.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/3.jpg)
//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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/4.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/5.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/6.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/7.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/8.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/9.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/10.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/11.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/12.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/13.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/14.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/15.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/16.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/17.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/18.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/19.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/20.jpg)
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](https://reader034.vdocuments.us/reader034/viewer/2022042109/5e88f547e467cb44f12d4962/html5/thumbnails/21.jpg)
Dick Wall