This is the original project proposal summary I submitted:
Robocomp current tutorials are simple and cover just the basics. Improved tutorials and use cases need to be created for Robocomp to be a framework friendly for beginners as well as more advanced users.
Working on creating examples of how Robocomp can be implemented, and why it should be used, would make it more accessible to the general public. As will improving the "How to Contribute Page", and making pull requests templates would make it easier to collaborate for more advance developers.
Getting Robocomp available in other operating systems it's necessary to making it more well-known, in other Linux distros as well as Windows. This can be done with virtual machines images or making tutorials to download it with their respective dependencies on each OS.
In summary, Robocomp would be benefited from offering a better user experience and a more seamlessly transition for collaborators to work on it.
As most early project proposals, some of the goals were adjusted while working on them. But the overall theme was followed, as I will explain next.
Making Robocomp beginner-friendly and easier to contribute to and work with were my goals. This was accomplished by:
-
Rewriting and upgrading all existing Docs, so they contained more important info, added images when necessary, and fixed typos and reading flow.
-
Improving ReadTheDocs so it contained all docs, instead of only the manual installation guide (still testing the changes in this one).
-
Creating an Installation Script for the terminal, with install options, automatizing the long manual installation process.
-
Writing a Frequently Asked Questions section. It now contains information about Robocomp in general, how to contribute, how to create 3D models, etc.
-
Creating a Contributing Guide, for info about contributing and filing issues, and a Code of Conduct File. Now new contributors have a list of suggestions about how to file issues and make pull requests.
-
Creating tutorials for the Installation Script, 3D modelling, etc. Made an email for suggestions of tutorials: robocomp.team@gmail.com.
-
My original goal of making Robocomp available in other operating systems was impractical. I spent about a week seeing how to port it to another Linux System (Arch Linux), and found that ICE 3.7 was used in almost all Linux distros except Ubuntu. The report can be found here. My solution was to explain how to install Ubuntu (in any OS) with a Virtual Enviroment in the FAQ.
-
Some tutorials that I would love to write now, are about the results of projects from others GSoC 2018 students, like the improvements to the FCL, and the work to integrate Robocomp with Gazebo.
-
In the blog posts I explained how ReadTheDocs work, so future students know how to update the index with other information.
My repository can be found here.
My commits can be found here.
My posts explaining all I did in detail can be found in the GSoC 2018 section, in the Robocomp blog, here.
I'm a Venezuelan Electronics Engineering student in Simón Bolívar University in Caracas, Venezuela. My email is gabriellabohorquez@gmail.com.
