search

open-learning-exchange / open-learning-exchange.github.io

http://open-learning-exchange.github.io/
40 stars 321 forks source link

Suggestion for "First Steps" instructions - Github, master/forked IO, MDWiki, Vagrant #230

Closed ghost closed 7 years ago

ghost commented 7 years ago

image

For visual learners, it may be helpful to have an overview flowchart/schematic somewhere in the First Steps page. I'm not sure if the above example is correct, but the activity of putting it together helped me begin to visualize the pieces better. What else could be added/clarified/corrected in order for it to be useful? For example, I think it would be especially helpful to have a way to distinguish the various layers of "nation" versus "community," the various configuration settings, maybe a breakdown of the routes pull requests and issues are sent through to make changes, etc.

DrewPerlman commented 7 years ago

@rachelpei Wow, this is great! This diagram is very clear and accurate, good job. Submit a pull request so we can include it on the MD wiki. And yes I agree, it would be helpful to have another similar diagram that distinguishes the relationship between community and nation, etc. Good start!

ghost commented 7 years ago

image

There's already a really good picture of how multiple users make parallel changes with their forked/cloned repositories and then send changes back to the master repository. I think the above is more like a supplement to the fork/clone/syncing video tutorial.

image

Here is how I'm understanding the nation/communities. All communities are parallel versions of the master Wiki, and in order to add new a new community in another language (e.g. Spanish), you use the translation tool Crowdin. The CouchDB database holds all the versions of the BeLLs and helps to sync them all. Community users can get library resources from the nation and can upload new resources that can be synced either to the nation or other communities (although I'm thinking it's probably back to the nation and then to the other communities, not sure). I'm not sure if this is the actual flow, just a best guess!

I can start by trying a pull request to add the first picture to the steps (need to think about how/where). Please let me know what you think about the new pictures.

Thanks!

DrewPerlman commented 7 years ago

@rachelpei Awesome, I love the diagrams you're making! I think visuals will definitely help reduce confusion on the wiki. However, I think the above 2 figures you've just attached need some further corrections.

Would you mind opening a new issue and then copying-pasting what you've said in your second comment, since they don't have as much to do with your first comment (for organizational purposes)? We can discuss it further there.

DrewPerlman commented 7 years ago

In fact, it actually might be more helpful to have 3 separate issues. One for each of your diagrams! :wink:

ghost commented 7 years ago

@DrewPerlman I was just at OLE today when you replied to the thread! :) Will create two more issues and copy the pictures over (I can also include the PPT draft in case you would like to mess with it). I think I have a clearer idea from @dogi and @EmilyLarkin about how the nation and communities "talk" to each other but can focus on hammering that out in the other issues' threads. Thanks!

ghost commented 7 years ago

flow-chart_master-fork.pptx

DrewPerlman commented 7 years ago

Thanks for splitting these up @rachelpei! I must have missed you when you came in yesterday, I was in the office upstairs :/

I'll merge your pull request and close this issue, since this picture looks good.

ghost commented 7 years ago

Thanks @DrewPerlman