SlideShare a Scribd company logo
Jutsu or Dô
Open documentation: continuous process
than a body
Linux.conf.au 2015
Raghavendra Prabhu
 raghavendra.d.prabhu@gmail.com
Percona  raghavendra.prabhu@percona.com
 randomsurfer  wnohang.net  rdprabhu  ronin13
Introduction
Lucid documentation can
▶ Help in rapid community growth
▶ Attract more contributors
▶ Enhance quality of code
▶ Help in bug fixes
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 2 / 24
Ad-hoc documentation
Introduction
Conversely, Poor documentation would...
▶ Repel users and community
▶ Lead to a less understood code
▶ Spurious bug reports
▶ Retard growth of project
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 4 / 24
Introduction
Projects
▶ Redis
▶ Go/Python/Haskell/Perl
▶ Docker
▶ Linux kernel
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 5 / 24
Keep it fresh
Factors
Keep it fresh
▶ Version control
▶ Timeline
▶ Develop in unison
♦ perldoc
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 7 / 24
Factors
Management
▶ Continuous Integration
▶ Feedback
▶ Packaged documentation
▶ Documentation Testing
▶ Reverse links from code - hackage
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 8 / 24
Factors
Management :: Formats
▶ RST
▶ Markdown
▶ Wiki?
▶ man/tex/info
▶ Which is better
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 9 / 24
Factors
Management :: Tools
▶ Doxygen
▶ Sphinx
▶ pandoc
▶ Haddock
▶ perldoc
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 10 / 24
Attribution!
Factors
Attribution
▶ Unlike code, not much and formal
▶ Importance to project
▶ Incentive
▶ Feedback loop
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 12 / 24
Factors
Personal Touch
▶ Preference towards blogs
▶ Less Mechanical
▶ Speak directly to the reader
▶ More ’How To’
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 13 / 24
Normalization
Factors
Normalisation
▶ What is this
▶ Is denormalized always good
▶ Maintenance and deduplication
▶ Embedding
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 15 / 24
Dialectics
Factors
Dialectical Approach
▶ or FAQ
▶ Flow of human thinking
▶ Troubleshooting
▶ Also, for beginners
▶ ‘Learning the hard way‘
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 17 / 24
Learning from Patterns
Factors
Examples
▶ Humans:Examples :: Machines:Algorithm
♦ Machine Learning
▶ Examples always help
▶ Quick testing
▶ Coverage
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 19 / 24
Consumers
Factors
Who uses it
▶ End user
♦ Simplicity
♦ Prior knowledge
▶ Developer
♦ Code Comments
♦ Design documents
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 21 / 24
Factors
Who uses it
▶ Architect
♦ Integration
♦ Interface
▶ Devops
♦ Troubleshooting
♦ Reference
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 22 / 24
Epilogue
Further Reading
▶ https://readthedocs.org/
▶ http://docs.writethedocs.org/
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 23 / 24
Epilogue
About
▶ /me: Raghavendra Prabhu, Product Lead, Percona XtraDB
Cluster, Percona.
▶ Slides will be at slideshare.net/slidunder.
▶ About.me: raghavendra.prabhu
▶ Keybase.io: rdprabhu
▶ Presentation under CC BY-SA 4.0
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 24 / 24
Epilogue
Image Credits
▶ https://www.flickr.com/photos/smemon/4902523202
▶ https://www.flickr.com/photos/ekampf/341734410
▶ https://www.flickr.com/photos/ecstaticist/6303689386
▶ https://www.flickr.com/photos/lentina_x/3596663014/
▶ http://www.aibn.uq.edu.au/roles-and-responsibilities
▶ http://faculty.mercer.edu/spears_a/studentpages/pattern/website.htm
▶ http://mashable.com/2013/10/03/video-assets-creative-commons/
▶ https://en.wikipedia.org/wiki/Snowflake_schema
▶ https://www.flickr.com/photos/stephanie_in_love/5525689604/
Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 25 / 24

More Related Content

Viewers also liked

Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa Luna
Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa LunaReflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa Luna
Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa LunaRosa Luna García
 
Abordaje de reacciones adversas a fármacos antituberculosos
Abordaje de reacciones adversas a fármacos  antituberculososAbordaje de reacciones adversas a fármacos  antituberculosos
Abordaje de reacciones adversas a fármacos antituberculosos
TbNuevoLeon
 
Corpus collapsum: Partition tolerance of Galera in a noisy high load environment
Corpus collapsum: Partition tolerance of Galera in a noisy high load environmentCorpus collapsum: Partition tolerance of Galera in a noisy high load environment
Corpus collapsum: Partition tolerance of Galera in a noisy high load environment
Raghavendra Prabhu
 
5 use adverbs
5 use adverbs5 use adverbs
5 use adverbs
Jennifer Maderazo
 
New spaper
New spaperNew spaper
New spaper
Jennifer Maderazo
 
Xtrabackup and FTWRL
Xtrabackup and FTWRLXtrabackup and FTWRL
Xtrabackup and FTWRL
Raghavendra Prabhu
 
5 use adverbs of duration in sentences
5 use adverbs of duration in sentences5 use adverbs of duration in sentences
5 use adverbs of duration in sentences
Jennifer Maderazo
 
Njutn i njutnovi zakoni
Njutn i njutnovi zakoniNjutn i njutnovi zakoni
Njutn i njutnovi zakoniSana Ivanović
 
1 give justification to a possible ending to a
1 give justification to a possible ending to a1 give justification to a possible ending to a
1 give justification to a possible ending to a
Jennifer Maderazo
 
MySQL-and-virtualization
MySQL-and-virtualizationMySQL-and-virtualization
MySQL-and-virtualization
Raghavendra Prabhu
 
20080618 Suivi Lecteurs Epsa
20080618 Suivi Lecteurs Epsa20080618 Suivi Lecteurs Epsa
20080618 Suivi Lecteurs Epsa
Vincent Peyrègne
 

Viewers also liked (11)

Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa Luna
Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa LunaReflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa Luna
Reflexiones sobre la_revision_bilingue-_ultima_version-libre Rosa Luna
 
Abordaje de reacciones adversas a fármacos antituberculosos
Abordaje de reacciones adversas a fármacos  antituberculososAbordaje de reacciones adversas a fármacos  antituberculosos
Abordaje de reacciones adversas a fármacos antituberculosos
 
Corpus collapsum: Partition tolerance of Galera in a noisy high load environment
Corpus collapsum: Partition tolerance of Galera in a noisy high load environmentCorpus collapsum: Partition tolerance of Galera in a noisy high load environment
Corpus collapsum: Partition tolerance of Galera in a noisy high load environment
 
5 use adverbs
5 use adverbs5 use adverbs
5 use adverbs
 
New spaper
New spaperNew spaper
New spaper
 
Xtrabackup and FTWRL
Xtrabackup and FTWRLXtrabackup and FTWRL
Xtrabackup and FTWRL
 
5 use adverbs of duration in sentences
5 use adverbs of duration in sentences5 use adverbs of duration in sentences
5 use adverbs of duration in sentences
 
Njutn i njutnovi zakoni
Njutn i njutnovi zakoniNjutn i njutnovi zakoni
Njutn i njutnovi zakoni
 
1 give justification to a possible ending to a
1 give justification to a possible ending to a1 give justification to a possible ending to a
1 give justification to a possible ending to a
 
MySQL-and-virtualization
MySQL-and-virtualizationMySQL-and-virtualization
MySQL-and-virtualization
 
20080618 Suivi Lecteurs Epsa
20080618 Suivi Lecteurs Epsa20080618 Suivi Lecteurs Epsa
20080618 Suivi Lecteurs Epsa
 

Similar to Jutsu or Dô: Open documentation: continuous process than a body

How to Write a Winning Session Submission
How to Write a Winning Session SubmissionHow to Write a Winning Session Submission
How to Write a Winning Session Submission
Docker, Inc
 
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projectsDrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
Vladimir Roudakov
 
TDD and Simple Design Workshop - Session 1 - November 2018
TDD and Simple Design Workshop - Session 1 - November 2018TDD and Simple Design Workshop - Session 1 - November 2018
TDD and Simple Design Workshop - Session 1 - November 2018
Paulo Clavijo
 
Creating test stability to create continuous delivery
Creating test stability to create continuous deliveryCreating test stability to create continuous delivery
Creating test stability to create continuous delivery
Trisha Chetani
 
Sprinting for success - the story of an open source doc sprint
Sprinting for success - the story of an open source doc sprintSprinting for success - the story of an open source doc sprint
Sprinting for success - the story of an open source doc sprint
Sarah Maddox
 
2014 BDPA High School Computer Competition Meeting (Part 1)
2014 BDPA High School Computer Competition Meeting (Part 1)2014 BDPA High School Computer Competition Meeting (Part 1)
2014 BDPA High School Computer Competition Meeting (Part 1)
BDPA Education and Technology Foundation
 
PCM_PDI_BestPractices.pdf
PCM_PDI_BestPractices.pdfPCM_PDI_BestPractices.pdf
PCM_PDI_BestPractices.pdf
Valdir Adorni
 
PDCA Problem Solving Technique & Tools
PDCA Problem Solving Technique & ToolsPDCA Problem Solving Technique & Tools
PDCA Problem Solving Technique & Tools
Flevy.com Best Practices
 
PostgreSQL Conference: West 08
PostgreSQL Conference: West 08PostgreSQL Conference: West 08
PostgreSQL Conference: West 08
Joshua Drake
 
Behaviour Testing and Continuous Integration with Drupal
Behaviour Testing and Continuous Integration with DrupalBehaviour Testing and Continuous Integration with Drupal
Behaviour Testing and Continuous Integration with Drupal
smithmilner
 
FINAL PRESENTATION_VCU OT_3D Printing
FINAL PRESENTATION_VCU OT_3D PrintingFINAL PRESENTATION_VCU OT_3D Printing
FINAL PRESENTATION_VCU OT_3D Printing
Ben Salatin
 
Software metrics to predict the health of a project? - An assessment in a maj...
Software metrics to predict the health of a project? - An assessment in a maj...Software metrics to predict the health of a project? - An assessment in a maj...
Software metrics to predict the health of a project? - An assessment in a maj...
ESUG
 
Engaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source ContributhonEngaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source Contributhon
Youngbin Han
 
Project Management with Trello by Digitangle
Project Management with Trello by Digitangle Project Management with Trello by Digitangle
Project Management with Trello by Digitangle
Digitangle
 
Rapid usability testing
Rapid usability testingRapid usability testing
Rapid usability testing
lisarex
 
Software development with scrum methodology bhawani nandan prasad
Software development with scrum methodology   bhawani nandan prasadSoftware development with scrum methodology   bhawani nandan prasad
Software development with scrum methodology bhawani nandan prasad
Bhawani N Prasad
 
Quizzes online
Quizzes onlineQuizzes online
Quizzes online
Nguyễn Trung
 
Main presentation slides Developer Student Clubs GEC Bilaspur
Main presentation slides Developer Student Clubs GEC BilaspurMain presentation slides Developer Student Clubs GEC Bilaspur
Main presentation slides Developer Student Clubs GEC Bilaspur
Domendra Sahu
 
Class 01 - Intro.pdf
Class 01 - Intro.pdfClass 01 - Intro.pdf
Class 01 - Intro.pdf
JonathanArp3
 
Inclusive design 24 (gaad)
Inclusive design 24 (gaad)Inclusive design 24 (gaad)
Inclusive design 24 (gaad)
Mike Gifford
 

Similar to Jutsu or Dô: Open documentation: continuous process than a body (20)

How to Write a Winning Session Submission
How to Write a Winning Session SubmissionHow to Write a Winning Session Submission
How to Write a Winning Session Submission
 
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projectsDrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
DrupalGov 2017: Testing any day: guide to end to end test driven Drupal projects
 
TDD and Simple Design Workshop - Session 1 - November 2018
TDD and Simple Design Workshop - Session 1 - November 2018TDD and Simple Design Workshop - Session 1 - November 2018
TDD and Simple Design Workshop - Session 1 - November 2018
 
Creating test stability to create continuous delivery
Creating test stability to create continuous deliveryCreating test stability to create continuous delivery
Creating test stability to create continuous delivery
 
Sprinting for success - the story of an open source doc sprint
Sprinting for success - the story of an open source doc sprintSprinting for success - the story of an open source doc sprint
Sprinting for success - the story of an open source doc sprint
 
2014 BDPA High School Computer Competition Meeting (Part 1)
2014 BDPA High School Computer Competition Meeting (Part 1)2014 BDPA High School Computer Competition Meeting (Part 1)
2014 BDPA High School Computer Competition Meeting (Part 1)
 
PCM_PDI_BestPractices.pdf
PCM_PDI_BestPractices.pdfPCM_PDI_BestPractices.pdf
PCM_PDI_BestPractices.pdf
 
PDCA Problem Solving Technique & Tools
PDCA Problem Solving Technique & ToolsPDCA Problem Solving Technique & Tools
PDCA Problem Solving Technique & Tools
 
PostgreSQL Conference: West 08
PostgreSQL Conference: West 08PostgreSQL Conference: West 08
PostgreSQL Conference: West 08
 
Behaviour Testing and Continuous Integration with Drupal
Behaviour Testing and Continuous Integration with DrupalBehaviour Testing and Continuous Integration with Drupal
Behaviour Testing and Continuous Integration with Drupal
 
FINAL PRESENTATION_VCU OT_3D Printing
FINAL PRESENTATION_VCU OT_3D PrintingFINAL PRESENTATION_VCU OT_3D Printing
FINAL PRESENTATION_VCU OT_3D Printing
 
Software metrics to predict the health of a project? - An assessment in a maj...
Software metrics to predict the health of a project? - An assessment in a maj...Software metrics to predict the health of a project? - An assessment in a maj...
Software metrics to predict the health of a project? - An assessment in a maj...
 
Engaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source ContributhonEngaging new l10n contributors through Open Source Contributhon
Engaging new l10n contributors through Open Source Contributhon
 
Project Management with Trello by Digitangle
Project Management with Trello by Digitangle Project Management with Trello by Digitangle
Project Management with Trello by Digitangle
 
Rapid usability testing
Rapid usability testingRapid usability testing
Rapid usability testing
 
Software development with scrum methodology bhawani nandan prasad
Software development with scrum methodology   bhawani nandan prasadSoftware development with scrum methodology   bhawani nandan prasad
Software development with scrum methodology bhawani nandan prasad
 
Quizzes online
Quizzes onlineQuizzes online
Quizzes online
 
Main presentation slides Developer Student Clubs GEC Bilaspur
Main presentation slides Developer Student Clubs GEC BilaspurMain presentation slides Developer Student Clubs GEC Bilaspur
Main presentation slides Developer Student Clubs GEC Bilaspur
 
Class 01 - Intro.pdf
Class 01 - Intro.pdfClass 01 - Intro.pdf
Class 01 - Intro.pdf
 
Inclusive design 24 (gaad)
Inclusive design 24 (gaad)Inclusive design 24 (gaad)
Inclusive design 24 (gaad)
 

More from Raghavendra Prabhu

Orchestrating Cassandra with Kubernetes Operator and PaaSTA
Orchestrating Cassandra with Kubernetes Operator and PaaSTAOrchestrating Cassandra with Kubernetes Operator and PaaSTA
Orchestrating Cassandra with Kubernetes Operator and PaaSTA
Raghavendra Prabhu
 
Orchestrating Cassandra with Kubernetes
Orchestrating Cassandra with KubernetesOrchestrating Cassandra with Kubernetes
Orchestrating Cassandra with Kubernetes
Raghavendra Prabhu
 
Cassandra Operator with Yelp PaaSTA
Cassandra Operator with Yelp PaaSTACassandra Operator with Yelp PaaSTA
Cassandra Operator with Yelp PaaSTA
Raghavendra Prabhu
 
Safe and Fast Automation on AWS for Fun and Profit
Safe and Fast Automation on AWS for Fun and ProfitSafe and Fast Automation on AWS for Fun and Profit
Safe and Fast Automation on AWS for Fun and Profit
Raghavendra Prabhu
 
Orchestrating Cassandra with Kubernetes: Challenges and Opportunities
Orchestrating Cassandra with Kubernetes: Challenges and OpportunitiesOrchestrating Cassandra with Kubernetes: Challenges and Opportunities
Orchestrating Cassandra with Kubernetes: Challenges and Opportunities
Raghavendra Prabhu
 
Pass Elk: CAP Theorem since 90s and Beyond
Pass Elk: CAP Theorem since 90s and BeyondPass Elk: CAP Theorem since 90s and Beyond
Pass Elk: CAP Theorem since 90s and Beyond
Raghavendra Prabhu
 
Cassandra in Docker at Yelp: Opportunities and Challenges
Cassandra in Docker at Yelp: Opportunities and ChallengesCassandra in Docker at Yelp: Opportunities and Challenges
Cassandra in Docker at Yelp: Opportunities and Challenges
Raghavendra Prabhu
 
Taskerman: A Distributed Cluster Task Manager
Taskerman: A Distributed Cluster Task ManagerTaskerman: A Distributed Cluster Task Manager
Taskerman: A Distributed Cluster Task Manager
Raghavendra Prabhu
 
Taskerman - a distributed cluster task manager
Taskerman - a distributed cluster task managerTaskerman - a distributed cluster task manager
Taskerman - a distributed cluster task manager
Raghavendra Prabhu
 
NUMA and Java Databases
NUMA and Java DatabasesNUMA and Java Databases
NUMA and Java Databases
Raghavendra Prabhu
 
Linux NUMA & Databases: Perils and Opportunities
Linux NUMA & Databases: Perils and OpportunitiesLinux NUMA & Databases: Perils and Opportunities
Linux NUMA & Databases: Perils and Opportunities
Raghavendra Prabhu
 
Clusternaut: Orchestrating  Percona XtraDB Cluster with Kubernetes
Clusternaut:  Orchestrating  Percona XtraDB Cluster with KubernetesClusternaut:  Orchestrating  Percona XtraDB Cluster with Kubernetes
Clusternaut: Orchestrating  Percona XtraDB Cluster with Kubernetes
Raghavendra Prabhu
 
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
Raghavendra Prabhu
 
Securing databases with systemd for containers and services
Securing databases with systemd for containers and services Securing databases with systemd for containers and services
Securing databases with systemd for containers and services
Raghavendra Prabhu
 
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
Raghavendra Prabhu
 
Dock'em: Distributed Systems Testing with NetEm and Docker
Dock'em: Distributed Systems Testing with NetEm and Docker Dock'em: Distributed Systems Testing with NetEm and Docker
Dock'em: Distributed Systems Testing with NetEm and Docker
Raghavendra Prabhu
 
Corpus collapsum: Partition tolerance of Galera put to test
Corpus collapsum: Partition tolerance of Galera put to testCorpus collapsum: Partition tolerance of Galera put to test
Corpus collapsum: Partition tolerance of Galera put to test
Raghavendra Prabhu
 
Running virtualized Galera instances for fun and profit
Running virtualized Galera instances for fun and profitRunning virtualized Galera instances for fun and profit
Running virtualized Galera instances for fun and profit
Raghavendra Prabhu
 
ACIDic Clusters: Review of current relation databases with synchronous replic...
ACIDic Clusters: Review of current relation databases with synchronous replic...ACIDic Clusters: Review of current relation databases with synchronous replic...
ACIDic Clusters: Review of current relation databases with synchronous replic...
Raghavendra Prabhu
 
Percona XtraDB Cluster before every release: Glimpse into CI testing
Percona XtraDB Cluster before every release: Glimpse into CI testingPercona XtraDB Cluster before every release: Glimpse into CI testing
Percona XtraDB Cluster before every release: Glimpse into CI testing
Raghavendra Prabhu
 

More from Raghavendra Prabhu (20)

Orchestrating Cassandra with Kubernetes Operator and PaaSTA
Orchestrating Cassandra with Kubernetes Operator and PaaSTAOrchestrating Cassandra with Kubernetes Operator and PaaSTA
Orchestrating Cassandra with Kubernetes Operator and PaaSTA
 
Orchestrating Cassandra with Kubernetes
Orchestrating Cassandra with KubernetesOrchestrating Cassandra with Kubernetes
Orchestrating Cassandra with Kubernetes
 
Cassandra Operator with Yelp PaaSTA
Cassandra Operator with Yelp PaaSTACassandra Operator with Yelp PaaSTA
Cassandra Operator with Yelp PaaSTA
 
Safe and Fast Automation on AWS for Fun and Profit
Safe and Fast Automation on AWS for Fun and ProfitSafe and Fast Automation on AWS for Fun and Profit
Safe and Fast Automation on AWS for Fun and Profit
 
Orchestrating Cassandra with Kubernetes: Challenges and Opportunities
Orchestrating Cassandra with Kubernetes: Challenges and OpportunitiesOrchestrating Cassandra with Kubernetes: Challenges and Opportunities
Orchestrating Cassandra with Kubernetes: Challenges and Opportunities
 
Pass Elk: CAP Theorem since 90s and Beyond
Pass Elk: CAP Theorem since 90s and BeyondPass Elk: CAP Theorem since 90s and Beyond
Pass Elk: CAP Theorem since 90s and Beyond
 
Cassandra in Docker at Yelp: Opportunities and Challenges
Cassandra in Docker at Yelp: Opportunities and ChallengesCassandra in Docker at Yelp: Opportunities and Challenges
Cassandra in Docker at Yelp: Opportunities and Challenges
 
Taskerman: A Distributed Cluster Task Manager
Taskerman: A Distributed Cluster Task ManagerTaskerman: A Distributed Cluster Task Manager
Taskerman: A Distributed Cluster Task Manager
 
Taskerman - a distributed cluster task manager
Taskerman - a distributed cluster task managerTaskerman - a distributed cluster task manager
Taskerman - a distributed cluster task manager
 
NUMA and Java Databases
NUMA and Java DatabasesNUMA and Java Databases
NUMA and Java Databases
 
Linux NUMA & Databases: Perils and Opportunities
Linux NUMA & Databases: Perils and OpportunitiesLinux NUMA & Databases: Perils and Opportunities
Linux NUMA & Databases: Perils and Opportunities
 
Clusternaut: Orchestrating  Percona XtraDB Cluster with Kubernetes
Clusternaut:  Orchestrating  Percona XtraDB Cluster with KubernetesClusternaut:  Orchestrating  Percona XtraDB Cluster with Kubernetes
Clusternaut: Orchestrating  Percona XtraDB Cluster with Kubernetes
 
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
Clusternaut: Orchestrating Percona XtraDB Cluster with Kubernetes.
 
Securing databases with systemd for containers and services
Securing databases with systemd for containers and services Securing databases with systemd for containers and services
Securing databases with systemd for containers and services
 
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
Corpus collapsum: Partition tolerance testing of Galera with Docker and NetEm
 
Dock'em: Distributed Systems Testing with NetEm and Docker
Dock'em: Distributed Systems Testing with NetEm and Docker Dock'em: Distributed Systems Testing with NetEm and Docker
Dock'em: Distributed Systems Testing with NetEm and Docker
 
Corpus collapsum: Partition tolerance of Galera put to test
Corpus collapsum: Partition tolerance of Galera put to testCorpus collapsum: Partition tolerance of Galera put to test
Corpus collapsum: Partition tolerance of Galera put to test
 
Running virtualized Galera instances for fun and profit
Running virtualized Galera instances for fun and profitRunning virtualized Galera instances for fun and profit
Running virtualized Galera instances for fun and profit
 
ACIDic Clusters: Review of current relation databases with synchronous replic...
ACIDic Clusters: Review of current relation databases with synchronous replic...ACIDic Clusters: Review of current relation databases with synchronous replic...
ACIDic Clusters: Review of current relation databases with synchronous replic...
 
Percona XtraDB Cluster before every release: Glimpse into CI testing
Percona XtraDB Cluster before every release: Glimpse into CI testingPercona XtraDB Cluster before every release: Glimpse into CI testing
Percona XtraDB Cluster before every release: Glimpse into CI testing
 

Recently uploaded

IEEE Aerospace and Electronic Systems Society as a Graduate Student Member
IEEE Aerospace and Electronic Systems Society as a Graduate Student MemberIEEE Aerospace and Electronic Systems Society as a Graduate Student Member
IEEE Aerospace and Electronic Systems Society as a Graduate Student Member
VICTOR MAESTRE RAMIREZ
 
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdfBPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
MIGUELANGEL966976
 
ACEP Magazine edition 4th launched on 05.06.2024
ACEP Magazine edition 4th launched on 05.06.2024ACEP Magazine edition 4th launched on 05.06.2024
ACEP Magazine edition 4th launched on 05.06.2024
Rahul
 
22CYT12-Unit-V-E Waste and its Management.ppt
22CYT12-Unit-V-E Waste and its Management.ppt22CYT12-Unit-V-E Waste and its Management.ppt
22CYT12-Unit-V-E Waste and its Management.ppt
KrishnaveniKrishnara1
 
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODELDEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
gerogepatton
 
Hematology Analyzer Machine - Complete Blood Count
Hematology Analyzer Machine - Complete Blood CountHematology Analyzer Machine - Complete Blood Count
Hematology Analyzer Machine - Complete Blood Count
shahdabdulbaset
 
132/33KV substation case study Presentation
132/33KV substation case study Presentation132/33KV substation case study Presentation
132/33KV substation case study Presentation
kandramariana6
 
spirit beverages ppt without graphics.pptx
spirit beverages ppt without graphics.pptxspirit beverages ppt without graphics.pptx
spirit beverages ppt without graphics.pptx
Madan Karki
 
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
IJECEIAES
 
BRAIN TUMOR DETECTION for seminar ppt.pdf
BRAIN TUMOR DETECTION for seminar ppt.pdfBRAIN TUMOR DETECTION for seminar ppt.pdf
BRAIN TUMOR DETECTION for seminar ppt.pdf
LAXMAREDDY22
 
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
ML Based Model for NIDS MSc Updated Presentation.v2.pptxML Based Model for NIDS MSc Updated Presentation.v2.pptx
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
JamalHussainArman
 
Advanced control scheme of doubly fed induction generator for wind turbine us...
Advanced control scheme of doubly fed induction generator for wind turbine us...Advanced control scheme of doubly fed induction generator for wind turbine us...
Advanced control scheme of doubly fed induction generator for wind turbine us...
IJECEIAES
 
Material for memory and display system h
Material for memory and display system hMaterial for memory and display system h
Material for memory and display system h
gowrishankartb2005
 
Transformers design and coooling methods
Transformers design and coooling methodsTransformers design and coooling methods
Transformers design and coooling methods
Roger Rozario
 
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
ecqow
 
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURSCompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
RamonNovais6
 
Understanding Inductive Bias in Machine Learning
Understanding Inductive Bias in Machine LearningUnderstanding Inductive Bias in Machine Learning
Understanding Inductive Bias in Machine Learning
SUTEJAS
 
Generative AI leverages algorithms to create various forms of content
Generative AI leverages algorithms to create various forms of contentGenerative AI leverages algorithms to create various forms of content
Generative AI leverages algorithms to create various forms of content
Hitesh Mohapatra
 
International Conference on NLP, Artificial Intelligence, Machine Learning an...
International Conference on NLP, Artificial Intelligence, Machine Learning an...International Conference on NLP, Artificial Intelligence, Machine Learning an...
International Conference on NLP, Artificial Intelligence, Machine Learning an...
gerogepatton
 
Literature Review Basics and Understanding Reference Management.pptx
Literature Review Basics and Understanding Reference Management.pptxLiterature Review Basics and Understanding Reference Management.pptx
Literature Review Basics and Understanding Reference Management.pptx
Dr Ramhari Poudyal
 

Recently uploaded (20)

IEEE Aerospace and Electronic Systems Society as a Graduate Student Member
IEEE Aerospace and Electronic Systems Society as a Graduate Student MemberIEEE Aerospace and Electronic Systems Society as a Graduate Student Member
IEEE Aerospace and Electronic Systems Society as a Graduate Student Member
 
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdfBPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
BPV-GUI-01-Guide-for-ASME-Review-Teams-(General)-10-10-2023.pdf
 
ACEP Magazine edition 4th launched on 05.06.2024
ACEP Magazine edition 4th launched on 05.06.2024ACEP Magazine edition 4th launched on 05.06.2024
ACEP Magazine edition 4th launched on 05.06.2024
 
22CYT12-Unit-V-E Waste and its Management.ppt
22CYT12-Unit-V-E Waste and its Management.ppt22CYT12-Unit-V-E Waste and its Management.ppt
22CYT12-Unit-V-E Waste and its Management.ppt
 
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODELDEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
DEEP LEARNING FOR SMART GRID INTRUSION DETECTION: A HYBRID CNN-LSTM-BASED MODEL
 
Hematology Analyzer Machine - Complete Blood Count
Hematology Analyzer Machine - Complete Blood CountHematology Analyzer Machine - Complete Blood Count
Hematology Analyzer Machine - Complete Blood Count
 
132/33KV substation case study Presentation
132/33KV substation case study Presentation132/33KV substation case study Presentation
132/33KV substation case study Presentation
 
spirit beverages ppt without graphics.pptx
spirit beverages ppt without graphics.pptxspirit beverages ppt without graphics.pptx
spirit beverages ppt without graphics.pptx
 
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
Electric vehicle and photovoltaic advanced roles in enhancing the financial p...
 
BRAIN TUMOR DETECTION for seminar ppt.pdf
BRAIN TUMOR DETECTION for seminar ppt.pdfBRAIN TUMOR DETECTION for seminar ppt.pdf
BRAIN TUMOR DETECTION for seminar ppt.pdf
 
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
ML Based Model for NIDS MSc Updated Presentation.v2.pptxML Based Model for NIDS MSc Updated Presentation.v2.pptx
ML Based Model for NIDS MSc Updated Presentation.v2.pptx
 
Advanced control scheme of doubly fed induction generator for wind turbine us...
Advanced control scheme of doubly fed induction generator for wind turbine us...Advanced control scheme of doubly fed induction generator for wind turbine us...
Advanced control scheme of doubly fed induction generator for wind turbine us...
 
Material for memory and display system h
Material for memory and display system hMaterial for memory and display system h
Material for memory and display system h
 
Transformers design and coooling methods
Transformers design and coooling methodsTransformers design and coooling methods
Transformers design and coooling methods
 
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
一比一原版(CalArts毕业证)加利福尼亚艺术学院毕业证如何办理
 
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURSCompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
CompEx~Manual~1210 (2).pdf COMPEX GAS AND VAPOURS
 
Understanding Inductive Bias in Machine Learning
Understanding Inductive Bias in Machine LearningUnderstanding Inductive Bias in Machine Learning
Understanding Inductive Bias in Machine Learning
 
Generative AI leverages algorithms to create various forms of content
Generative AI leverages algorithms to create various forms of contentGenerative AI leverages algorithms to create various forms of content
Generative AI leverages algorithms to create various forms of content
 
International Conference on NLP, Artificial Intelligence, Machine Learning an...
International Conference on NLP, Artificial Intelligence, Machine Learning an...International Conference on NLP, Artificial Intelligence, Machine Learning an...
International Conference on NLP, Artificial Intelligence, Machine Learning an...
 
Literature Review Basics and Understanding Reference Management.pptx
Literature Review Basics and Understanding Reference Management.pptxLiterature Review Basics and Understanding Reference Management.pptx
Literature Review Basics and Understanding Reference Management.pptx
 

Jutsu or Dô: Open documentation: continuous process than a body

  • 1. Jutsu or Dô Open documentation: continuous process than a body Linux.conf.au 2015 Raghavendra Prabhu  raghavendra.d.prabhu@gmail.com Percona  raghavendra.prabhu@percona.com  randomsurfer  wnohang.net  rdprabhu  ronin13
  • 2. Introduction Lucid documentation can ▶ Help in rapid community growth ▶ Attract more contributors ▶ Enhance quality of code ▶ Help in bug fixes Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 2 / 24
  • 4. Introduction Conversely, Poor documentation would... ▶ Repel users and community ▶ Lead to a less understood code ▶ Spurious bug reports ▶ Retard growth of project Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 4 / 24
  • 5. Introduction Projects ▶ Redis ▶ Go/Python/Haskell/Perl ▶ Docker ▶ Linux kernel Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 5 / 24
  • 7. Factors Keep it fresh ▶ Version control ▶ Timeline ▶ Develop in unison ♦ perldoc Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 7 / 24
  • 8. Factors Management ▶ Continuous Integration ▶ Feedback ▶ Packaged documentation ▶ Documentation Testing ▶ Reverse links from code - hackage Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 8 / 24
  • 9. Factors Management :: Formats ▶ RST ▶ Markdown ▶ Wiki? ▶ man/tex/info ▶ Which is better Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 9 / 24
  • 10. Factors Management :: Tools ▶ Doxygen ▶ Sphinx ▶ pandoc ▶ Haddock ▶ perldoc Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 10 / 24
  • 12. Factors Attribution ▶ Unlike code, not much and formal ▶ Importance to project ▶ Incentive ▶ Feedback loop Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 12 / 24
  • 13. Factors Personal Touch ▶ Preference towards blogs ▶ Less Mechanical ▶ Speak directly to the reader ▶ More ’How To’ Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 13 / 24
  • 15. Factors Normalisation ▶ What is this ▶ Is denormalized always good ▶ Maintenance and deduplication ▶ Embedding Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 15 / 24
  • 17. Factors Dialectical Approach ▶ or FAQ ▶ Flow of human thinking ▶ Troubleshooting ▶ Also, for beginners ▶ ‘Learning the hard way‘ Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 17 / 24
  • 19. Factors Examples ▶ Humans:Examples :: Machines:Algorithm ♦ Machine Learning ▶ Examples always help ▶ Quick testing ▶ Coverage Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 19 / 24
  • 21. Factors Who uses it ▶ End user ♦ Simplicity ♦ Prior knowledge ▶ Developer ♦ Code Comments ♦ Design documents Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 21 / 24
  • 22. Factors Who uses it ▶ Architect ♦ Integration ♦ Interface ▶ Devops ♦ Troubleshooting ♦ Reference Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 22 / 24
  • 23. Epilogue Further Reading ▶ https://readthedocs.org/ ▶ http://docs.writethedocs.org/ Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 23 / 24
  • 24. Epilogue About ▶ /me: Raghavendra Prabhu, Product Lead, Percona XtraDB Cluster, Percona. ▶ Slides will be at slideshare.net/slidunder. ▶ About.me: raghavendra.prabhu ▶ Keybase.io: rdprabhu ▶ Presentation under CC BY-SA 4.0 Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 24 / 24
  • 25. Epilogue Image Credits ▶ https://www.flickr.com/photos/smemon/4902523202 ▶ https://www.flickr.com/photos/ekampf/341734410 ▶ https://www.flickr.com/photos/ecstaticist/6303689386 ▶ https://www.flickr.com/photos/lentina_x/3596663014/ ▶ http://www.aibn.uq.edu.au/roles-and-responsibilities ▶ http://faculty.mercer.edu/spears_a/studentpages/pattern/website.htm ▶ http://mashable.com/2013/10/03/video-assets-creative-commons/ ▶ https://en.wikipedia.org/wiki/Snowflake_schema ▶ https://www.flickr.com/photos/stephanie_in_love/5525689604/ Raghavendra Prabhu (Percona) Jutsu or Dô 12 January, 2015 25 / 24