Skip to content
This repository has been archived by the owner on Oct 7, 2022. It is now read-only.

Share public version of MagicBox diagram on ReadTheDocs #30

Open
jwflory opened this issue Apr 23, 2018 · 0 comments
Open

Share public version of MagicBox diagram on ReadTheDocs #30

jwflory opened this issue Apr 23, 2018 · 0 comments
Labels
docs Adding or updating documentation onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention

Comments

@jwflory
Copy link
Member

jwflory commented Apr 23, 2018

@mikefab has a full diagram of how the pieces of MagicBox fit together and what the components of the project are; we need to make a public version of that document and add it to our documentation

What to do

  1. Create a public version of the graph with sensitive information or resources removed
  2. Submit a pull request to unicef/magicbox with the picture (maybe to the index page underneath the table of contents section for now?)
  3. Show diagram in the MagicBox README

Why do it

MagicBox is a complex project with many pieces. We want contributors to spend time working on valuable areas of MagicBox that help the project. By investing time and effort in the project, we want to reward that time and effort with accepted contributions. To accept meaningful contributions, we need to make it more clear how MagicBox fits together and what the "core" components are.

@jwflory jwflory added onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention docs Adding or updating documentation labels Apr 23, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
docs Adding or updating documentation onboarding Improving onboarding experience for new contributors and team members priority:med Doesn't need immediate attention
Projects
None yet
Development

No branches or pull requests

1 participant