arohm19 / RDocumentation-app

The web application running rdocumentation.org.

rdocumentation.org provides the R community with centralized, quality and easy to search documentation.

R documentation sifts through all CRAN, GitHub and BioConductor packages hourly, parses the documentation files and indexes them in an Elasticsearch database. This makes rdocumentation.org the best online resource to browse all R package documentation.

The RDocs project is completely open-source. This repository contains the source code for the NodeJS web application that serves www.rdocumentation.org. For other codebases, you can check out CONTRIBUTING.md.

Features

• Quick search through all packages and functions

• Complete search through all packages and function

• Easily assess package quality

• Post community examples to help the community understand how to use a function

What this app does

This application is part the rdocumentation project. This app is responsible for storing the RDocumentation data, and bring it to the users through a web interface (the rdocumentation.org site) or through an api (See https://www.rdocumentation.org/docs/ for the public API)

Documentation

Documentation of the differents endpoints can be found here: http://www.rdocumentation.org/docs/

Issue/Feature request

Please post a new issue at https://github.com/datacamp/rdocumentation-app/issues for any bug that you encounter or a feature that you would like to see in rdocumetation.org.

Development

Using docker

You'll need docker and docker-compose to run this stack locally

• Copy the .env.sample to .env and change relevant variables
• docker-compose create to create the redis and mysql container
• docker-compose start to fire up a local redis an mysql
• Run the database migrations by doing npm run migrate
• npm run start-dev

How to deploy

• To deploy to stating (rdocumentation.datacamp-staging.com), merge to master
• To deploy to production, add a tag which starts with release-

The rdocumentation app is hosted on DataCamp's infrastructure, on our AWS ECS cluster.

What the CI does

This application runs on the DataCamp infrastructure. Our custom CI flow will:

• Build a docker image
• Upload it the ECR
• Deploy the new version to ECS

How to contribute

We welcome any contributions that could improves rdocumentation.org. There is multiple ways of contributing:

• Report when some packages are missing/outdated/incorrect by creating an issue.
• Report bugs.
• Help us improves by proposing features.
• Directly contribute by forking the repo and making changes.

License

See the LICENSE file for license rights and limitations (MIT).