Added contributing guidelines about WikiToLearn #6
Conversation
This file contains hidden or 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
Added Contributing to WikiToLearn guidelines!
Added details on how to contribute to WikiToLearn.
nikhita reviewed Jun 20, 2017
| `realpath` is in `AUR` | ||
| | ||
| #### Docker installation | ||
| Docker is a quickly evolving technology, and it may be possible that the your distro official repository do not have yet the docker version requierd to run WTL. We thus recommend to install docker following the [official guide](https://docs.docker.com/engine/installation/). |
There was a problem hiding this comment.
your distro's official repository does not have the yet docker version required to run WTL yet.
| #### Docker installation | ||
| Docker is a quickly evolving technology, and it may be possible that the your distro official repository do not have yet the docker version requierd to run WTL. We thus recommend to install docker following the [official guide](https://docs.docker.com/engine/installation/). | ||
| | ||
| Do not forget to add your user to the docker group, so that you do not have to use super user privileges every time you have to manage docker images and volumes. WTLH is intended to work only if your user is added to docker group, otherwise you get errors related to missing the correct permissions since WTLH is not intended to be executed with super user rights. |
There was a problem hiding this comment.
When I started out, I didn't know how to do this. Maybe add a link for clueless folks like me? 😛
This is the link: https://docs.docker.com/engine/installation/linux/linux-postinstall/
| | ||
| #### Requirements | ||
| * 64-Bit Computer (docker need a 64 bit system) | ||
| * GNU/Linux with docker or Windows/OSX with virtualization compatability and enabled |
There was a problem hiding this comment.
s/compatability/compatibility
| | ||
| #### GNU/Linux installation | ||
| ##### Prerequisites | ||
| WTL and WTLH have some dependecies: |
There was a problem hiding this comment.
s/dependecies/dependencies
| | ||
| `./instance.sh delete` | ||
| | ||
| Read the guide to [instance.sh](http://meta.wikitolearn.org/WikiToLearn_Home/WikitoLearn_Home_Documentation/Instance_Doc) for a deatailed description of how to use WTLH to manage the WTL instance. |
| | ||
| #### Vagrant Installation for Windows/OSX | ||
| | ||
| WTL is build to work on GNU/Linux. It uses GNU/Linux software, enclosed inside docker containers, that require the GNU/Linux kernel. Hence, if you want to develop WTL from a Windows/OSX environment you need to install a virtual linux system. We remind yout in order do use a virtualization software, you have to enable virtalization in your BIOS, as [explained in this page](http://meta.wikitolearn.org/WikiToLearn_Home/WikitoLearn_Home_Documentation/Local_WikiToLearn_Instance/How_To_Enable_Virtualization_On_Your_PC). |
| Just one more thing - can you add a note about what languages/technologies one should know before contributing? :) |
| After @nikhita's suggested changes, perfect for me too. :) |
| @srijancse no hurries, but a friendly ping :) |
| Thanks @nikhita for reminding. Would fix it by weekend. ;) |
Fixed typos, and updated links!
nikhita reviewed Sep 9, 2017
| #### Docker installation | ||
| Docker is a quickly evolving technology, and it may be possible that the your distro's official repository does not have the docker version required to run WTL yet. We thus recommend to install docker following the [official guide](https://docs.docker.com/engine/installation/). | ||
| | ||
| Do not forget to add your user to the docker group, so that you do not have to use super user privileges every time you have to manage docker images and volumes. WTLH is intended to work only if your user is added to docker group, otherwise you get errors related to missing the correct permissions since WTLH is not intended to be executed with super user rights. We recommend following this [guide] (https://docs.docker.com/engine/installation/linux/linux-postinstall/). |
There was a problem hiding this comment.
remove the space between [guide] and (link). It does not render the markdown correctly.
| WTL is build to work on GNU/Linux. It uses GNU/Linux software, enclosed inside docker containers, that require the GNU/Linux kernel. Hence, if you want to develop WTL from a Windows/OSX environment you need to install a virtual linux system. We remind you that in order do use a virtualization software, you have to enable virtalization in your BIOS, as [explained in this page](http://meta.wikitolearn.org/WikiToLearn_Home/WikitoLearn_Home_Documentation/Local_WikiToLearn_Instance/How_To_Enable_Virtualization_On_Your_PC). | ||
| | ||
| ##### Vagrant Installation | ||
| Using Vagrant is a quite simple way of using a virtual linux system for development purposes. |
| | ||
| This procedure requires using port 8080 tcp, 3128 tcp, 2121 to 2221 tcp on your host, this shouldn't be a problem unless you are running a network server (apache2, remote web control, ecc.). | ||
| | ||
| If you have a **Windows/OSX** operating system, then you need to run a WikiToLearn instance using Vagrant. You can also install Vagrant if you have a Linux o.s. However, it is not required to get a fully working installation. You can just skip to the next step. |
There was a problem hiding this comment.
Linux OS instead of Linux o.s.
| | ||
| First, you need to install: | ||
| | ||
| * [VirtualBox](https://www.virtualbox.org/wiki/Downloads/) as engine for vagrant |
There was a problem hiding this comment.
nit: period at end of the sentence.
| First, you need to install: | ||
| | ||
| * [VirtualBox](https://www.virtualbox.org/wiki/Downloads/) as engine for vagrant | ||
| * [Vagrant](https://www.vagrantup.com/docs/installation/) for Windows/OS X users, for Linux it's optional. On Windows require restart. |
There was a problem hiding this comment.
On Windows, it requires a restart. (is this what you were trying to convey?)
| | ||
| #### Vagrant Installation for Windows/OSX | ||
| | ||
| WTL is build to work on GNU/Linux. It uses GNU/Linux software, enclosed inside docker containers, that require the GNU/Linux kernel. Hence, if you want to develop WTL from a Windows/OSX environment you need to install a virtual linux system. We remind you that in order do use a virtualization software, you have to enable virtalization in your BIOS, as [explained in this page](http://meta.wikitolearn.org/WikiToLearn_Home/WikitoLearn_Home_Documentation/Local_WikiToLearn_Instance/How_To_Enable_Virtualization_On_Your_PC). |
There was a problem hiding this comment.
s/virtalization/virtualization
| | ||
| | ||
| | ||
| |
| Oh, also noticed this has conflicts with |
| bump ^^ |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
@tapasweni-pathak @nikhita Have a look, and let me know if this is fine.