Upgrade to Pro — share decks privately, control downloads, hide ads and more …

TensorFlow 2.0 Global Docs Sprint - GDG Cloud L...

TensorFlow 2.0 Global Docs Sprint - GDG Cloud Lagos

TensorFlow 2.0 Global Docs Sprint - GDG Cloud Lagos

Olayinka Peter Oluwafemi

June 01, 2019
Tweet

More Decks by Olayinka Peter Oluwafemi

Other Decks in Technology

Transcript

  1. #TensorFlow | #TFDocsSprint Overview 5 Step 1. Choose an API

    symbol for review Step 2. Review docstring Step 3. Report review result Step 4. (optional) Fix doc issues
  2. #TensorFlow | #TFDocsSprint 1. Decide which API symbol to review

    • Take a look at the TensorFlow Docs Tasks • Choose a symbol you are interested in • Write down your GitHub handle in the owner field ◦ Note this will avoid duplicate work by someone else
  3. #TensorFlow | #TFDocsSprint 2. Review the documentation 1. Click on

    the chosen symbol in the TensorFlow Docs Tasks 2. You will land on a tensorflow.org documentation page. 3. Review the symbol and assess the doc quality with the checklist in TF 2.0 API Docs FAQ.
  4. #TensorFlow | #TFDocsSprint 3. Report the review result • Enter

    results on the task list as comments • And open a new docs issue on github, only if issues are significant
  5. #TensorFlow | #TFDocsSprint 4. (Optional) fix the doc issue This

    step is totally optional!!! • Create a PR to fix the doc issue • Make sure to reference the PR in the doc issue you created Reference: watch Paige Bailey’s step-by-step video on how to create a PR here.
  6. #TensorFlow | #TFDocsSprint Helpful links • Contribute to the TensorFlow

    Documentation on tensorflow.org • TensorFlow Global Docs Sprint Cheatsheet bit.ly/TFDocsSprint-Cheatsheet • Photo album - add your photos here • Questions? - ask them in the TensorFlow Docs Gitter chat room: https://gitter.im/tensorflow/docs