Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Creation of good documentation #4

Open
jfollert opened this issue Nov 8, 2016 · 6 comments
Open

Creation of good documentation #4

jfollert opened this issue Nov 8, 2016 · 6 comments

Comments

@jfollert
Copy link
Owner

jfollert commented Nov 8, 2016

It is very important to have a good documentation of the project, with commands, aids and translations.

@solisruj
Copy link

Hey there,

I saw this help wanted/up-for-grabs-translate documentation for Ecolab. I would love to contribute and get oriented to the project.

@bruno-chavez
Copy link
Collaborator

Hi there @solisruj as you can see the project has not been receiving updates recently, but new help is always welcomed, if you want to help with the documentation, just make a fork and familiarize yourself with the project, after that just add some comments where you think are needed or feel free to change stuff, after you are finished make sure to do a PR, ill review it and hopefully merge your fork!

@KingAkeem
Copy link

I would also like to help with adding documentation, I think this project is very interesting and I've been wanting to contribute to an open source project but I haven't found anything that wasn't too daunting.

@solisruj
Copy link

Hey there @bruno-chavez, I read through all the files. I wanted to test EcoLab and run it on my laptop to see the platform in action. However, I only have one computer and am not sure how well it would run. Any recommendations? I basically wanted to see how EcoLab optimizes resources, and begin making edits where needed.

@bruno-chavez
Copy link
Collaborator

The best option in case you dont have any other machine to test it on, is setting up a Virtual Machine an install it there, feel free to contact me if you run into any trouble.

@solisruj
Copy link

solisruj commented Dec 3, 2017

Hey Bruno, I tried installing EcoLabs on a virtual environment I setup. However, I was not sure how to go about installing and setting EcoLab up, so I went through and adjusted what I could based on my knowledge of formatting and commenting code for now. I think we should develop and write an installation guide using user machine and/or virtual machines. I would love to take on the project with some guidance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants