Versions Compared

Key

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

...

  •  TBD

Eval 3:

  •  TBD

Eval 4:

  •  TBD

Timeline

Timeline

Sep 5 - Sep 18

Sep 8 - Sep 18
DatesTasks/Plan

Status

Jun 12 - Jun 26Mentee intro with the mentor. Decision on the progress of the connectorDone
Jun 27 - Jul 10Understanding the current state of documentation and ReadTheDocs configuration/hostingDone

Jul 11 - Jul 24

Setup initial base structure on ReadTheDocs using the Sphinx Material Theme, light/dark theme suppport and required code preview & chart plugins

Jul 25 - Aug 7 (Jul 28 eval)

Aug 17 - Aug 24

Drafting the documentation contents of each top level documentation modules (Get Started, How to... etc)

Aug 8 - Aug 21

Aug 24 - Aug 31

Complete Get Started section and host it on ReadTheDocs (same for other sections in subsequent bi-weekly tasks)

Aug 22 - Sep 4 (Aug 31 eval)

Sept 1 - Sep 8

Complete How to section and host

Complete How to section and host

Sep 5 - Sep 18

Complete Concepts section and host
Sep 19 - Oct 2Complete Tutorials section and host 
Oct 3 - Oct 16Complete Reference section and host
Oct 16 - Oct 30 (Oct 20 eval)Complete Contribution section and host
Oct 31 - Nov 6Create PR and incorporate review comments - Phase 1
Nov 7 - Nov 30 (Nov 30 eval)Create PR and incorporate review comments - Phase 2

Timeline(Updated)

DatesTasks/PlanStatus
Jun 12 - Jun 26Mentee intro with the mentor.Done
Jun 27 - Jul 10Understanding the current state of documentation and ReadTheDocs configuration/hostingDone
Aug 17 - Aug 24Setup initial base structure on ReadTheDocs using the Sphinx Material Theme, light/dark theme suppport and required code preview & chart pluginsOngoing

Aug 25 - Sept 04
(Aug 31 eval)

Drafting the documentation contents of each top level documentation modules (Get Started, How to... etc)
Sept 5 - Sep 14Complete Get Started section and host it on ReadTheDocs (same for other sections in subsequent bi-weekly tasks)
Sep 15 - Sep 21Complete How to section and host
Sep 22 - Sep 28Complete Concepts section and host
Sep
19
29 - Oct
2
5Complete Tutorials section and host 

Oct

3

6 - Oct 16

Complete Reference section and host

Oct

16

17 - Oct 30 (Oct 20 eval)

Complete Contribution section and host
Oct 31 - Nov 6Create PR and incorporate review comments - Phase 1
Nov 7 - Nov 30 (Nov 30 eval)Create PR and incorporate review comments - Phase 2

Methodology

  • TBD
  • TBD
  • TBD