Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Part 1 - Videos taken from two sessions wherein Dave Mayo instructed working group members on how to add examples to the API documentation.

Session 1

A. adding documentation to endpoints in backend controllers:view-file

Multimedia
nameapi_docs_training_1a_endpoints.mp4


B. Overview of backend code that processes API docs

Multimedia
nameapi_docs_training_1b_rest-rb.mp4


C. Overview of API documentation template

Multimedia
nameapi_docs_training_1a1c_api-erb.mp4
height250
Part 2 -


D. Review and Q&A

Multimedia
nameapi_docs_training_1d_review-qa.mp4


E. Building the API documentation:

View filemultimedia
nameapi_docs_training_1b.mp4height250

Session 2

Setting up for local development and doc-building, and making a pull request

Multimedia
nameAspaceMeeting_Local_PR.mp4