Git Product home page Git Product logo

open-learning-exchange.github.io's Introduction

What is this?

See what this is all about: http://open-learning-exchange.github.io/.

How to Contribute

First things first

Learn Markdown! Then check out MDwiki's quick start.

Whenever you feel stuck, go to MDwiki's own site for further information.

One Wiki Only? Fork It.

First off fork this repo and call it something like <MyProject>-wiki.

Multiple Wikis? Clone It.

In case would you like to create more than one wiki for the same GitHub user or organization, then forking won't cut it. At the moment of this writing GitHub won't allow you to fork a single repository multiple times for the same account.

There's a workaround to this, however on GitHub's web interface you won't see the sign that says "forked from" in your cloned repository.

Below instructions how to clone this repository using the CLI:

First off, create a new (empty) repository on GitHub, then;

git clone https://github.com/exalted/mdwiki-seed.git
cd mdwiki-seed
git remote add foobar <HTTPS/SSH Clone URL of the New Repository>
git push foobar gh-pages

Create a New Wiki

It all begins by creating an initial file structure for any language that you would like to support. For example, if you're interested having a wiki in English, then you will duplicate ll_CC folder and rename your copy to en. (For a complete list of languages [ll] and country codes [CC] see here.)

ll_CC is a starter template folder which you shouldn't ever edit directly, since you may loose your changes when MDwiki gets updated later.

If you want to have your wiki in more than one language, then you duplicate ll_CC as many times as necessary and rename each copy with the appropriate language and country code. (Country code is optional and it is only useful if you want to distinguish, for instance, American English from British English, such as: en_US and en_GB.)

Getting Started

You should have a language wiki folder by now, if not, go back and read above to create one.

Suppose your first wiki is going to be in English, hence you must have a folder called en, as previously described.

  1. Open index.html file with your favorite plain text editor (the one that is at the same level where ll_CC and your language folder is located, NOT the one inside your language folder).
  2. Find where it says "Override ll_CC below with your default language and country code."
  3. Change refresh meta tag from url=ll_CC/ to url=en/ (trailing / is very important).

Structure

All file references here are relative to their respective language folder.

Name Type Description
index.md File Starting point (a.k.a. "home page") for your wiki. Note this is not the index.html, but index.md!
navigation.md File Various settings of your wiki (e.g., name of your wiki, items in the navigation bar at the top, etc.)
config.json File If you don't know what this is for, don’t touch it.
pages Folder Ideally, inside this folder, you create one *.md file for every page inside your wiki (e.g., foo.md, much-longer-names-are-also-okay.md, etc.) You can also create as many subfolders as you need, just remember to link them accordingly.
uploads Folder An example folder structure where you could put other files. Although it is best to host your files somewhere else, like Dropbox, or a CDN, etc.

Best Practices

Relative URLs

Instead of using absolute URLs when linking one wiki page to another, use relative URLs.

For instance if en/pages/foo.md page had to link to en/pages/bar.md, it is enough to just add [Click here](bar.md) in your markdown.

Don't Host Your Uploads in Git(Hub)

Instead of hosting your uploads inside the uploads folder, consider using Dropbox, Google Drive, or a CDN.

Add References to Uploads

Whenever you can, avoid hosting your uploads using Git(Hub).

If you must add references to files hosted inside the uploads folder here's how to do it, for instance: ![Image Title](uploads/images/foo.png). Add that in your markdown and you're good to go.

How to Preview

In order to preview your changes locally, prior to publishing online, you may need to take some actions. Below some starting points for each operating system, also check out MDwiki's frequently asked questions section for some ideas.

Mac OS

The easiest way to serve up static sites on a Mac is to use Anvil. Go ahead and download it from their website, install and add a site using the status bar icon: simply select the folder where your wiki is located on your Mac.

If you don't want to download any apps, you can use the Terminal on your Mac and Python. To do this, go to your site folder in the Terminal app and type python -m SimpleHTTPServer 8000. This will start running a local server which you can navigate to by typing the URL localhost:8000 in any web browser.

Windows

Text editors like Brackets, and VS Code and Atom (with extensions) can be used to preview your files locally. However, it is recommended that you use the online GitHub editor and RawGit to make and view your changes in your own branch of your fork of this repository because this is the only sure way to preview your changes for live accuracy.

Linux

You can use Prax. Prax is a pure ruby alternative to Pow!! that runs on GNU/Linux.

For Developers

You don't need to read below here or do anything at all if you're only interested creating your own wiki. This section is for developers or maintainers of this repository.

Make changes to MDwiki

  1. If you haven't already, install Node.
  2. Open a command prompt/shell/git bash and navigate to your repo's directory.
  3. Run npm install to install mdwiki dependencies.
  4. For development, you can run ./node_modules/.bin/grunt devel or grunt devel if you have grunt installed globally. This will start grunt watching the index.tmpl and *.js files for changes, which you can view at localhost:35729. The index.html file that it builds is the debug version of the html with the full js files.
  5. As a note, the index.tmpl is where our custom CSS can be found. Please only add CSS within the comment denoted section.
  6. Once you have completed your changes, run ./node_modules/.bin/grunt release to build an index.html with minified js.

open-learning-exchange.github.io's People

Contributors

aberdean avatar ajgingrich avatar alexkarasik avatar aurinsomnia avatar bdelee avatar dogi avatar drewperlman avatar ebuka-chibueze avatar emilylarkin avatar empeje avatar haoran-hu avatar kanishk1010 avatar kylemathias avatar liew211 avatar lillyxxx avatar lmmrssa avatar loshi93 avatar mutugiii avatar navneetkarnam avatar paulbert avatar sagun98 avatar sahilph avatar samuelchen1213 avatar sarah-lu102 avatar sjkadali avatar snazzybunny avatar supriyaranjan avatar waryhermit avatar xyb994 avatar yurockkk avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

open-learning-exchange.github.io's Issues

Different chat windows for different topics

I think there should be some facility to flag your messages topic wise. For e.g. I have a doubt about topic "x". Since we are discussing all the topics in the same chat window its difficult for me to go through all the messages once again and look for my topic of interest.

But if we have flags, I can simply click on the flag "x" and there it is!! I will be able to find all the information.

NationBell Assignment Clarification

As part of the fifth assignment, we are supposed to log onto NationBell to explore and see that our community is synced. However, the instructions specifying this are fairly vague.

On the nation side, you can log in as admin/password and check that the sync worked. Click on "Manager" once again.

Mainly, other than specifying nation side, there is no indication of where to go in order to log in nation side (vi.ole.org). It was only because I was browsing the group chat at the right time that I recognized where to go. The change I am proposing is fairly simple, just add (vi.ole.org) in brackets.

Also, I felt that the explanation of NationBell vs LocalBell wasn't really covered completely. I noticed that Emily had posted what seemed to be a much clearer explanation in chat and wanted to bring up the idea of including it or an edited version of it in the intro to the assignment.

So we have three levels: local, community, and nation. We need to make sure they are always synced and on the same page, otherwise you'll have merge conflicts and essentially run the risk of messing up the code pretty good. We use communities in places without internet because they are local. Whereas nations are connected to the internet and it allows a connection process between us (with internet) and those on communities (without internet). Communities are either run on RPis or laptops but are intranet, not internet connected and to sync the communities with the nations, we connect to internet so that information is sent in both directions.

I have submitted a fix for the first issue but thought there should be a discussion before addressing the second one.

Vagrant.md windows clarification

The vagrant.md file suggests vboxmanage --version to make sure you have the correct installation.

vagrant --version will work from any directory, but vboxmanage can only be accessed if the command is run from the specific directory containing the executable.

example of command prompt

My suggestion is that we include a line that makes it clear you have to run the command from the directory with the executable.

I know I was stuck here for a while because I'm a bit of a stickler for perfectionist

GitHub and Markdown page clarification

As part of Assignment 2, we have to follow the instructions on the GitHub and Markdown page. One of those instructions is to create our own markdown page introducing ourselves. While the instructions on how to do this is clear, what is not specifically mentioned is that this is an opportunity for us to experiment with markdown. As such, many initial pages were created very simple, and then edited to have more markdown elements after feedback from the gitter chat. So, I thought it would be a good idea to add a line to encourage experimentation and the usage of various markdown elements in the process of creating an introductory page. It could be something like this:

Feel free to experiment with Markdown and use various Markdown elements when creating your page. After all, this is an opportunity to familiarize yourself with the language.

Trouble Shooting Wiki Suggestion

I think it would be helpful to have another subsection of the wiki for troubleshooting.
It would be something akin to an FAQ for common problems people have run into, and problems that have discussed in the chat. This way everyone can have a place to view a compilation of past errors, and perhaps help with their own troubleshooting.

Misspelling

On the third paragraph under "Git Repositories", the word "repositories" is spelled with 2 i's instead of one

Problem checking vboxmanage version

I'm having problems with checking the vboxmanage version on the Command Prompt. I get the following message.
"vboxmanage is not recognized as an internal or external command..."

Improve Welcome Page for Markdown Wiki

We are asked to follow open-learning-exchange in the welcome page of the Markdown wiki but github does not allow us to follow organization. We need to remove that.

Link to OLE official site

Pretty obvious and possibly convenient, but maybe we can add a simple link next to the "chat" tab that can direct us to the official site of Open Learning Exchange, just for those of us who are curious to know more about the company.

Team member missing from Team page - Karen T

On Team page, member Karen T is missing from list of members. Tested to see if the member site is active, and it is, but there is no link to the page. Right now to view page, other team members would have to type the url into their browser address bar.

Dummy user password warning

Since anyone logged in as an admin on the Nation BeLL can see all of the information for each community user under the "Members" tab, it would be helpful to put a warning on nation.md not to use a password for the dummy user that you wouldn't want others to see.

Team Member missing from Team page

Although pranesh-s.md is a part of the repository, it needs to be added to the team member page. This can be done by editing in the line:

[pranesh-s](/ll_CC/#!pages/pranesh-s.md)

in the team.md file. In addition, there are also team members on the page without a .md file attached. They are the following:

[mhalqurashi](/ll_CC/#!pages/mhalqurashi.md)
[ptruong88](/ll_CC/#!pages/ptruong88.md)
[xbxme12345](/ll_CC/#!pages/xbxme12345.md)
[sdronika](/ll_CC/#!pages/sdronika.md)
[mduprez](/ll_CC/#!pages/mduprez.md)
[shorabhd](/ll_CC/#!pages/shorabhd.md)
[SavinSachdev](/ll_CC/#!pages/SavinSachdev.md)

I am not sure what kind of change needs to be made regarding these team members. Finally, one team member links to the wrong .md file.

[alan459](/ll_CC/#!pages/alan459.md) -> should be [alan459](/ll_CC/#!pages/Alan259.md).

I have made changes fixing the first and last issue and have sent a pull request.

FAQ for github issues

We could do a separate tab for answering frequently asked questions such as merge conflicts or not being able to do a pull from the github remote repository. It could be part of the faq tab in markdown wiki or a separate tab altogether

MDWiki improvements

Some of the markdown code on the wiki is hard to visualize. Is there a way to insert a preview tab?

"#" after Headers

Next to all of the assignments there is "#" that doesn't do anything.

Clarification needed on tutorials

One of the instructions is as clear as it should be and so I wanted to help point where this occurred. My experience with learning has shown me that individuals succeed when things are as clear as possible. This applies beyond learning, but we'll stick to that since this organization has learning in its name.

image

This should be "Commit New File" as for users they will be seeing this:
image

when they scroll down.

Learning anything new is a time when simplicity, clarity, and ease should be greatest to help achieve familiarity.

Team member page isn't formatted like on GitHub

I noticed that my personal team member page on the website has some extra line breaks that aren't present on the GitHub version. Though this is a bit of a nitpicky issue, I'm not sure what's causing the discrepancy in formatting.
teammempagecomparison

Can't Merge Fork with Upstream

I'm not sure why, but I can't merge my forked repo with the original. It says I'm six commits ahead, but I've already sent a pull request. How do I fix this?

More description on "git fetch upstream" command

In the Markdown wiki, under the Git Repositories tab, at one point the reader is asked to run the command "git fetch upstream". However, under default condition, the upstream points to nothing so this command will not work. I think we should add instructions telling the users to point the upstream to a repository first.

_Config.yml file clarification

Just wanted to know where to find the _Config.yml file and if we are updated to kramdown - which would allow us to open links in new tabs as mentioned in #108

Translation page needed

The virtual interns need access to the Crowdin link to work on translation. This new tab should be between "Team" and "Chat" and should provide access to Open Learning Exchange's Crowdin.

Downloading resource files clarification

http://open-learning-exchange.github.io/ll_CC/#!pages/bellapps.md
Problem:
When I clicked the links for those example resource files, it automatically opened up the file in a new tab, so all i need to do is right click the webpage and click save. I didn't use the 'raw' function at all.
Solution:
adding a small paragraph on the tutorial telling others if clicking the link leads them opening up the file in the new tab, then just need to right click and save is good. 'raw' function will not be needed in this case.
will make a pull request soon

Resolving issues in assignment 5

Perhaps we should add a note stating that closing an issue is the same as resolving - had me caught for a while, it may help!

Fix directory structure

The top level ll_CC directory should be removed (or changed to en_US as this wiki is in English only).

Adding Help/FAQ tab to Markdown Wiki

Why can't we add one more tab to the Markdown Wiki: http://open-learning-exchange.github.io/ll_CC/#!index.md , that would be Help/FAQ that may be an assembled list of many questions and their answers that will help the new virtual interns or users when these questions tend to occur. For example: if i ask questions and get answers from you, i can post them in help/faq section that might help others who have similar questions

Git Repositories addition

In the Git Repositories tutorial, we are taught how to clone a repository, and sync up with relevant master/upstream repositories. However, already some people have had to rebase their forked repositories and there aren't any helpful instructions or links on the page about the process. The following two links:

https://git-scm.com/docs/git-rebase
https://git-scm.com/book/en/v2/Git-Branching-Rebasing

are fairly helpful but I was unsure of how to go about adding it into the instructions on the Git Repositories page.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.