ocadotechnology / codeforlife-admin

A dummy repo so that we can track all of our admin issues separately
0 stars 0 forks source link

Plan content structure on Gitbook #1115

Closed lauracumming closed 4 months ago

lauracumming commented 5 months ago

for getting started/set up/external and internal contributors

SKairinos commented 4 months ago

Code for Life (https://code-for-life.gitbook.io/) (public) - this will sync to CFL’s workspace repo.

  1. Intro
  2. Services
    1. Link to service 1…
    2. Link to service 2…
  3. Contributors
    1. Intro
    2. Prerequisites
    3. What you get
    4. Contribution process - zenhub, forking, pr reviews, definition of done
    5. Honourable mentions
  4. Developer Guide
    1. Developing a Service
    2. Set up your dev environment.
    3. Frontend
      1. Tech stack
      2. Testing strategy
    4. Backend
      1. Tech stack
      2. Testing strategy
  5. Link to student resources
  6. Link to communications

Contributor Service (https://code-for-life.gitbook.io/services/contirbutor)

  1. Intro
  2. Change log
  3. TBD

Rapid Router Service (https://code-for-life.gitbook.io/services/rapid-router)

  1. Intro
  2. Change log
  3. Python commands
  4. TBD

Portal Service (https://code-for-life.gitbook.io/services/portal) (public)

  1. Intro
  2. Change log
  3. TBD

SSO Service (https://code-for-life.gitbook.io/services/sso) (public)

  1. Intro
  2. Change log
  3. TBD

Python Package (https://code-for-life.gitbook.io/packages/python) (public)

  1. Intro
  2. Change log
  3. TBD

Javascript Package (https://code-for-life.gitbook.io/packages/javascript) (public)

  1. Intro
  2. Change log
  3. TBD

Communications (https://code-for-life.gitbook.io/communications) (public)

  1. Newsletters (https://code-for-life.gitbook.io/communications/newsletters)
    1. Newsletter 1
    2. Newsletter 2
  2. Quick Updates (https://code-for-life.gitbook.io/communications/quick-updates)
    1. Quick update 1
    2. Quick update 2
  3. Blog posts (https://code-for-life.gitbook.io/communications/blog-posts)
    1. Blog post 1
    2. Blog post 2

Teacher Resources (https://code-for-life.gitbook.io/resources/teacher) (private)

  1. Rapid Router (https://code-for-life.gitbook.io/teaching-resources/rapid-router) - TBD
  2. Kurono (https://code-for-life.gitbook.io/teaching-resources/kurono) - TBD
  3. Link to student resources

Student Resources (https://code-for-life.gitbook.io/resources/student) (public)

  1. Glossary of computing terms
  2. Intro to Python
  3. Intro to Blockly

Full time - TBD