ScoreLab - Writing fresh content for scorelab projects in general

Google Season of Docs 2019


Welcome to the SCoRe Lab Google Season of Docs 2019 project ideas page. We are a dynamic and enthusiastic nonprofit research group pioneering in Internet of Things (IoT), Embedded Systems, Computer Security, Software Tools and 'Wireless Adhoc and Sensor Networks' and is one of the best groups in South Asia. Google Season of Docs is a new Google program focussed on helping to improve the quality of documentation in open source software. We are pleased to introduce the below project ideas to encourage you to participate and become a contributor in the SCoRe Lab open source community. Happy documenting with Google Season of Docs 2019!!!

Mailing list: score-community@googlegroups.com

Gitter Channel: https://gitter.im/scorelab/

Project list for Google Season of Docs 2019

  • Bassa - Build a documentation site for Bassa

    Bassa is automated download queue for communities to take the best use of Internet bandwidth. In this task candidate need to setup new documentation site and include all documentations and bassa tutorials. Also, the documentations should be use cases specific for example if an enterprise want to use Bassa then all the requirements and well enough details on industrial scale should be provided. More detailed description is given below.

    • A static website to show complete documentation of Bassa web application. This site shall contain.
      • A documentation which should be use cases specific for example if an enterprise want to use Bassa then all the requirements and well enough details on industrial scale should be provided. (User guide)
      • A thorough documentation on how to setup Bassa locally on machine. Mentioning about setting up manually from scratch on different operating systems and using Docker. (Developer guide)
      • Documenting all the important contribution guidelines which are necessary for new contributors to Bassa web application. (covering topics like opening an issue and creating a pull request on GitHub, discussing new features with Org admins and maintainers) (Developer guide)
      • Documenting all the usual errors along with fixes (like dependency based) which are invoked while setting up and using Bassa on machine locally (covering different operating systems). (Developer guide)
      • Documentation on explaining project flow among different parts of Bassa web application- Web, Bassa API server, database and Aria2c rpc server.(Developer guide)
      • Bassa for mobile project should also be added to the static website.
    • A tutorial video on how to use Bassa web application for enterprise which will go in to the documentation website.

    Expected Results: Setup Jekyll based documentation site, provide documentations and tutorials
    Required Knowledge: English, Github, Jekyll
    Github: https://github.com/scorelab/Bassa
    Possible Mentors: Charith, Milindu
  • Fact-Bounty - Build a documentation site for Fact Bounty

    The recent decade has witnessed the birth of social media ecosystems that brings social organizations, media content and various stakeholders together, and now it appears significant advantages of comprehensiveness, diversity and wisdom that provide users with higher quality of experiences. Meanwhile, social media ecosystems suffer from security, privacy and trustworthiness threats. How to leverage the power of intelligent crowds to improve the ecosystem’s efficacy and efficiency, as well as ensure its security and privacy become burning and challenging issues. In this task candidate need to setup new documentation site and include all documentations and Fact-Bounty tutorials.

    Expected Results: Setup Jekyll based documentation site, provide documentations and tutorials
    Required Knowledge: English, Github, Jekyll
    Github: https://github.com/scorelab/fact-Bounty
    Possible Mentors: Charith, Oshan
  • ScoreLab - Writing fresh content for scorelab projects in general

    Scorelab have variety of projects in different fields. Some of the projects don’t have their use case documentation which might be friction for people to understand where exactly product can be utilized. You will be given set of projects which you have to explore by taking help from mentors and understand their value. For each of project, you have to write it’s use cases, a good documentation and few blogs for project technicality. This will help you to know a lot of projects in small span.

    Expected Results: Setup a fresh blog site and start writing down your experience with each of the project. Write simple documentations for given projects with technical descriptions.
    Required Knowledge: English, Github, Jekyll
    Github: https://github.com/scorelab/Bassa
    Possible Mentors: Charith, Milindu, Nirmal Sarswat

© Copyright 2019 Sustainable Computing Research Group (SCoRe)