- Student: Ujjwal Bhardwaj
- Github Profile: @imujjwal96
- Organisation: FOSSASIA
- Project: Yaydoc - An automated documentation generator
This GSoC, I worked on the Documentation project under FOSSASIA, called Yaydoc. Yaydoc is an automated documentation generation and deployment project that geneates and deploys documentation for a project hosted on Github at each and every commit made to its repository.
Yaydoc contains following features:
- Generate documentation of a repository from its markdown files
- Generate API documentation including Javadocs and Swagger
- Deploy documentation website to Github Pages
- Deploy documentation website to Heroku
- Register repositories for continuous integration
- Specify project specific configurations to generate docs in the
.yaydoc.yml file
- Display build logs for documentation generated and deployed at each commit
- Enable-Disable the build process and remove repository from Yaydoc
- Specify branches for the repository to generate documentation from.
- Register repositories as sub-projects under a single project to generate a cumulative website
- Receive an email with the links for documentation preview, download as zip and deploy to the aforementationed platforms
- Receive an email with the status of documentation generation process at commits made during continuous integration
- Provide Status Badges to repositories to review the status of latest documentation build from the repository
Documentation Generator | Yaydoc Dashboard | Repository Settings |
---|---|---|
Latest Build Logs | Log History |
---|---|
- loklak/loklak_server - Pull Requests
- loklak/dev.loklak.org - Pull Requests
- fossasia/susi_server - Pull Requests
- fossasia/query_server - Pull Requests
- fossasia/phimpme-android - Pull Requests
- fossasia/loklak_search - Pull Requests
Responsible for deploying Yaydoc at following platforms:
- Heroku - https://yaydoc.herokuapp.com
- Google Cloud with Kubernetes (Master) - http://yaydoc.org
- Google Cloud with Kubernetes (Staging) - http://staging.yaydoc.org