-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
15 changed files
with
156 additions
and
42 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,16 @@ | ||
# It works! ;-) | ||
#Welcome! | ||
|
||
This is a MD Wiki for our Virtual Interns program. Please feel free to explore and offer suggestions on our [gitter.im chat](https://gitter.im/open-learning-exchange/chat). | ||
|
||
## Section 1 | ||
Our Virtual Interns program is part of the software development strategy by [Open Learning Exchange](http://www.ole.org/) (OLÉ). We are a non-profit and for-purpose organization based in Cambridge, Massachusetts. We strive to provide universal quality education using open source materials and technology to address educational barriers. | ||
|
||
Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Cras mattis consectetur purus sit amet fermentum. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Sed posuere consectetur est at lobortis. | ||
##Assignments | ||
###Due 5/11/16 | ||
1. Follow the instructions on the [GitHub and Markdown page](pages/githubandmarkdown.md) and comment on the [gitter.im chat](https://gitter.im/open-learning-exchange/chat) when you have completed these steps. | ||
2. Review [Vagrant instructions](pages/vagrant.md) to ensure that you have completed last week's assignment fully. | ||
3. This step will be released on Friday, 5/6/16. | ||
|
||
|
||
## Section 2 | ||
|
||
Aenean eu leo quam. Pellentesque ornare sem lacinia quam venenatis vestibulum. Donec ullamcorper nulla non metus auctor fringilla. Cras mattis consectetur purus sit amet fermentum. Donec ullamcorper nulla non metus auctor fringilla. Cras justo odio, dapibus ac facilisis in, egestas eget quam. | ||
|
||
Vestibulum id ligula porta felis euismod semper. Maecenas faucibus mollis interdum. Morbi leo risus, porta ac consectetur ac, vestibulum at eros. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer posuere erat a ante venenatis dapibus posuere velit aliquet. | ||
###Due 5/4/16 | ||
1. Go to [this GitHub address](https://github.com/dogi/ole--vagrant-bells) to read through the basic instructions on how to create your own digital library (what we call the BeLL, or Basic e-Learning Library). It involves several steps of downloading various content to your OS so that you can use and work within our software. You should be able to scroll down to see ole--vagrant-bells, but you can also find it in the README.md file. Please do not make ANY changes to the text or files: simply read and follow the directions. | ||
2. Please send Emily your resume again (along with a short description of yourself and what you would like to be called) to [email protected]. | ||
3. We use Crowdin to translate our user interface in many different languages. Please go to [this Crowdin link](https://crowdin.com/project/open-learning-exchange/invite) to join Crowdin by creating an account. If you speak an additional language, it would be very helpful for you to translate some of the words and familiarize yourself with the software. We will be using it later on in the summer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
Emily Larkin | ||
Boston / EST | ||
Mac OS X v.10.11.3 | ||
|
||
Emily is a project manager and Open Education Resource specialist. Over the past year, she has supported educational extension programs in Jordan and delivered training and resources for hundreds of students and teachers. Emily’s work in Jordan includes all aspects of project management from planning to implementation to monitoring and evaluation. Emily has proficiency in Arabic and French. She is completing her degree at Emmanuel College this spring and will be a Fulbright Fellow next year. | ||
|
||
Email: [email protected] | ||
GitHub: [EmilyLarkin](https://github.com/EmilyLarkin) |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
# GitHub and Markdown | ||
|
||
[GitHub](https://help.github.com/categories/writing-on-github/) acts as a source code management system for Open Learning Exchange. It's a very simple open source system that is easy to learn and to use. Please read some of the basic instructions below as a user manual for OLE on GitHub. | ||
|
||
[Markdown Wiki](http://dynalon.github.io/mdwiki/#!quickstart.md) is the software you're currently reading on that OLE uses for our Virtual intern program. Markdown (MD) Wiki allows us to use Markdown and javascript on GitHub so that it is easily compatible with our current development environment. To be explicit, Markdown is a simplified development language which allows you to format and write text. | ||
Below is a screenshot of what Markdown language with a preview looks like: | ||
|
||
![Markdown Preview](/ll_CC/pages/uploads/images/markdown.png) | ||
|
||
Below is a cheat sheet of Markdown so you can have more information on writing MD on your individual Markdown Wiki pages: | ||
|
||
![Markdown Cheat Sheet](/ll_CC/pages/uploads/images/Markdown_Reference.png) | ||
|
||
The main GitHub page devoted to this is found at [open-learning-exchange/open-learning-exchange.github.io](https://github.com/open-learning-exchange/open-learning-exchange.github.io) and our virtual interns will essentially create their own Markdown Wiki page as a copy of open-learning-exchange.github.io. Please find the steps below to do this after a brief description of GitHub and its functionality. | ||
|
||
As you have already created a username on GitHub, we can assume that you understand the basic layout and functionality. Please explore and do some basic googling if not. On GitHub, it's important to always be sure that you are working on your own GitHub page if you're editing (which you can tell based off of the name before the slash and the repositority after the slash: ex. EmilyLarkin/BeLL-Apps). All of Open Learning Exchange's work can be [found here](https://github.com/open-learning-exchange). All of the different repositories represent differnt types of software used by OLE and the repositories act as categorizing system. | ||
|
||
There is a lot of GitHub to learn, but to acclimatize you to it, we will provide a basic example of how to change something on GitHub. This example with specifically create your own <username>.github.io and allow you to edit and commit your changes. | ||
|
||
First, you will need to find the correct GitHub repository to fork. Forking is essentially creating a copy on your own user so that you don't edit or mess up the main file. To make it easier on you, I will provide you with a link to the correct repository [here](https://github.com/open-learning-exchange/open-learning-exchange.github.io). | ||
Now you will fork the repository to your own page. Look at the picture below to find the fork button. | ||
|
||
![Forking on GitHub](/ll_CC/pages/uploads/images/Forking on GitHub.png) | ||
|
||
After your fork it, you will be on your page: username/open-learning-exchange.github.io. Then go to settings at the top middle of the page and rename your repository to your name. See example below. | ||
|
||
![Renaming Repository](/ll_CC/pages/uploads/images/Rename Repository.png) | ||
|
||
Once again, it's important to distinguish now the difference between your personal GitHub account and the Open Learning Exchange account. As we want to keep a 'clean' version of code, everyone forks repositories and then saves them back for approval (called a pull request) before the Open Learning Exchange code is updated. Be sure to ALWAYS work on your personal account via forking and pull requests. | ||
|
||
Now, you can edit your files and check out your username.github.io in a web browser. To edit, click on the `II_CC` folder and then click on `pages` folder. Then, click `New File` and make the filename the exact same name as your gitter.im username (minus the @). I have created pages for you using your gitter.im chat name so it's important you stick with that name. For reference, my link to this page is EmilyLarkin.github.io/ll_CC/pages/EmilyLarkin.md and yours should look similar in a parallel format. | ||
|
||
From this, click the pencil icon to edit (as shown below) and type your name, your location/time zone, and OS (including version). Feel free to add a short description of yourself as well so your fellow virtual interns know who you are. Then scroll down to the bottom of the page and click `Commit Changes`. | ||
|
||
![Edit](/ll_CC/pages/uploads/images/Edit.png) | ||
|
||
Now check what this looks like on your own page (username.github.io/ll_CC/#!pages/username.md). Check and double check that everything looks good and is working before initiating a pull request. | ||
|
||
Then, you can create a pull request by clicking the `Pull requests` button and then clicking `New pull request`. Then click `Create pull request` and someone from our team will then merge and allow your pull request once everything looks good. After the pull request is completed, you'll be able to see this on open-learning-exchange.github.io in addition to your personal page. Let us know when you have completed this step in the [gitter.im chat](https://gitter.im/open-learning-exchange/chat). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
[EmilyLarkin](/ll_CC/#!pages/EmilyLarkin.md) | ||
|
||
[vimalababu4](/ll_CC/#!pages/vimalababu.md) | ||
|
||
[mduprez](/ll_CC/#!pages/mduprez.md) | ||
|
||
[shorabhd](/ll_CC/#!pages/shorabhd.md) | ||
|
||
[SavinSachdev](/ll_CC/#!pages/SavinSachdev.md) | ||
|
||
[yywmm1991](/ll_CC/#!pages/yywmm1991.md) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
# Vagrant | ||
|
||
[Vagrant](https://www.vagrantup.com/) is open source tool for building development environments. We assume that you have followed the first instructions on README.md to install Vagrant and VirtualBox on your OS. Below you will find a shortened version on how to install this software quickly if needed as a reference. | ||
|
||
### Ubuntu | ||
``` | ||
sudo apt-get install virtualbox | ||
sudo apt-get install vagrant | ||
``` | ||
### OSX | ||
Open your `Terminal`. We assume that [brew](http://brew.sh/) is already installed. | ||
``` | ||
brew install vagrant | ||
brew cask install virtualbox | ||
``` | ||
### Windows | ||
You need to manually install git, virtualbox, and vagrant via internet from the installation links provided above. Afterwards, open your `Command Prompt` to check that the following are up and running properly: | ||
``` | ||
vagrant --version | ||
vboxmanage --version | ||
``` | ||
|
||
After installing a communityBeLL on your OS, you will need to follow these instructions to use your communityBeLL. Vagrant only works when you have installed vagrant and you are in the proper directory where your vagrant file is located. To find the proper directory, open your `Terminal` or `Command Prompt` and type `cd ole--vagrant-bells/release` in order to be in the right directory. | ||
Now that you are in the right directory, check the status of vagrant with `vagrant global-status`. You should have the following message: | ||
|
||
``` | ||
id name provider state directory | ||
--------------------------------------------------------------------------- | ||
2198a3d ole virtualbox running /Users/Emily/ole--vagrant-bells/release | ||
The above shows information about all known Vagrant environments | ||
on this machine. This data is cached and may not be completely | ||
up-to-date. To interact with any of the machines, you can go to | ||
that directory and run Vagrant, or you can use the ID directly | ||
with Vagrant commands from any directory. For example: | ||
"vagrant destroy 1a2b3c4d" | ||
``` | ||
If you have a different message, your vagrant is powered off, you have multiple machines of the same name, or you have another technical issue. | ||
|
||
If your vagrant is powered off, use `vagrant up` to turn it on. To shut down your machine, use `vagrant halt`. These two commands require that you are in the right directory. To destroy your machine entirely, use `vagrant destroy`. Remember, by using `vagrant destroy`, you destroy the machine and will need to rebuild a communityBeLL if you wish to use it. It requires that you enter your password and this is not undoable. | ||
|
||
We suggest doing some light googling to tell you more about the background and commands of vagrant. Use `vagrant --help` for other commands that you may need. See `vagrant --help` below: | ||
|
||
``` | ||
Usage: vagrant [options] <command> [<args>] | ||
-v, --version Print the version and exit. | ||
-h, --help Print this help. | ||
Common commands: | ||
box manages boxes: installation, removal, etc. | ||
connect connect to a remotely shared Vagrant environment | ||
destroy stops and deletes all traces of the vagrant machine | ||
global-status outputs status Vagrant environments for this user | ||
halt stops the vagrant machine | ||
help shows the help for a subcommand | ||
init initializes a new Vagrant environment by creating a Vagrantfile | ||
login log in to HashiCorp's Atlas | ||
package packages a running vagrant environment into a box | ||
plugin manages plugins: install, uninstall, update, etc. | ||
port displays information about guest port mappings | ||
powershell connects to machine via powershell remoting | ||
provision provisions the vagrant machine | ||
push deploys code in this environment to a configured destination | ||
rdp connects to machine via RDP | ||
reload restarts vagrant machine, loads new Vagrantfile configuration | ||
resume resume a suspended vagrant machine | ||
share share your Vagrant environment with anyone in the world | ||
snapshot manages snapshots: saving, restoring, etc. | ||
ssh connects to machine via SSH | ||
ssh-config outputs OpenSSH valid configuration to connect to the machine | ||
status outputs status of the vagrant machine | ||
suspend suspends the machine | ||
up starts and provisions the vagrant environment | ||
version prints current and latest Vagrant version | ||
For help on any individual command run `vagrant COMMAND -h` | ||
Additional subcommands are available, but are either more advanced | ||
or not commonly used. To see all subcommands, run the command | ||
`vagrant list-commands`. | ||
``` |