You may use the
Suggest Edits feature in Doctor to submit changes to any of the MD files in github. Doctor relies on github workflow to accept PRs for changes.
Pre-requisite: Install and set up docker on your machine.
# get the docker-compose.yml file from the minio/doctor repo wget https://raw.githubusercontent.com/minio/doctor/master/docker-compose.yml wget https://raw.githubusercontent.com/minio/doctor/master/.env # If you want to start the services in production RAILS_ENV=production docker-compose up -d # If you want to start the services in development docker-compose up -d # get the container name of the web service docker ps # setup the database in a one-off command docker exec docapp bundle exec rake db:setup
brew install postgres. Configure Launch Agent to start it automatically or use the command
pg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log startto start it manually.
Clone and start doctor
> git clone https://github.com/minio/doctor.git > cd doctor > bundle install > rake db:drop > rake db:setup > rails s
Now visit http://localhost:3000
email@example.com with password
Doctor!23 to login. Visit http://localhost:3000 to navigate the docs. This can be changed anytime via the Dashboard. We highly recommend that you do if you use Doctor in deployment.
bundle installsometimes may not go through smoothly. In that case, you may need to run
sudo apt install libpg-dev
bundle install, then run
sudo apt-get install nodejs
ActiveRecord::NoDatabaseError: FATAL: role <your_user_name> does not existduring
rake:db setup, then run:
sudo -u postgres createuser --superuser <your_user_name>