minio / Doctor
Licence: apache-2.0
Doctor is a documentation server for your docs in github
Stars: ✭ 391
Programming Languages
ruby
36898 projects - #4 most used programming language
Projects that are alternatives of or similar to Doctor
Email Dashboard
📪 An interactive emailing management service with scheduling, templating, tracking and A/B testing.
Stars: ✭ 194 (-50.38%)
Mutual labels: rails, ruby-on-rails, dashboard
Binda
Headless CMS based on Ruby on Rails
Stars: ✭ 60 (-84.65%)
Mutual labels: rails, ruby-on-rails, dashboard
Sail
Sail is a lightweight Rails engine that brings an admin panel for managing configuration settings on a live Rails app
Stars: ✭ 484 (+23.79%)
Mutual labels: rails, ruby-on-rails, dashboard
Niklick
Rails Versioned API solution template for hipsters! (Ruby, Ruby on Rails, REST API, GraphQL, Docker, RSpec, Devise, Postgress DB)
Stars: ✭ 39 (-90.03%)
Mutual labels: postgres, rails, ruby-on-rails
Mrdoc
online document system developed based on python. It is suitable for individuals and small teams to manage documents, wiki, knowledge and notes. like gitbook.
Stars: ✭ 1,129 (+188.75%)
Mutual labels: document-management, markdown
Coderdojo.jp
☯️ CoderDojo Japan (@coderdojo-japan) official website developed by Ruby on Rails with @YassLab team. 💎
Stars: ✭ 50 (-87.21%)
Mutual labels: markdown, rails
Postgui
A React web application to query and share any PostgreSQL database.
Stars: ✭ 260 (-33.5%)
Mutual labels: postgres, dashboard
Flipper
🐬 Beautiful, performant feature flags for Ruby.
Stars: ✭ 2,732 (+598.72%)
Mutual labels: postgres, rails
Elasticsearch Rails
Elasticsearch integrations for ActiveModel/Record and Ruby on Rails
Stars: ✭ 2,896 (+640.66%)
Mutual labels: rails, ruby-on-rails
Tapping device
TappingDevice makes objects tell you what they do, so you don't need to track them yourself.
Stars: ✭ 296 (-24.3%)
Mutual labels: rails, ruby-on-rails
Bluedoc
An open-source document management tool for enterprise self host.
Stars: ✭ 579 (+48.08%)
Mutual labels: markdown, rails
Scenic
Scenic is maintained by Derek Prior, Caleb Hearth, and you, our
contributors.
Stars: ✭ 2,856 (+630.43%)
Mutual labels: postgres, rails
Seafile
High performance file syncing and sharing, with also Markdown WYSIWYG editing, Wiki, file label and other knowledge management features.
Stars: ✭ 9,201 (+2253.2%)
Mutual labels: document-management, markdown
Activerecord Postgres enum
Integrate PostgreSQL's enum data type into ActiveRecord's schema and migrations.
Stars: ✭ 227 (-41.94%)
Mutual labels: postgres, rails
Kickoff tailwind
A rapid Rails 6 application template for personal use bundled with Tailwind CSS
Stars: ✭ 287 (-26.6%)
Mutual labels: rails, ruby-on-rails
Lamby
Simple Rails & AWS Lambda Integration 🐑🛤
Stars: ✭ 336 (-14.07%)
Mutual labels: rails, ruby-on-rails
Ansible Rails
Ansible: Ruby on Rails Server
Stars: ✭ 317 (-18.93%)
Mutual labels: rails, ruby-on-rails
Rails performance
Monitor performance of you Rails applications
Stars: ✭ 345 (-11.76%)
Mutual labels: rails, ruby-on-rails
Learn Rails
An example Rails 5.1 app to accompany the "Learn Ruby on Rails" book.
Stars: ✭ 375 (-4.09%)
Mutual labels: rails, ruby-on-rails
What is Doctor
- Doctor is a Documentation Server for all your project docs.
- Doctor beautifully decouples document serving and document contents.
- Create your docs in markdown. Store them anywhere (github/dropbox/google drive/ anywhere really).
- Login to Doctor's Dashboard. Setup links to your doc files in Doctor's Dashboard.
- You are done!
Live Demo
- Doctor's website is a site hosted on doctor using this very Readme.MD file. Yeah very meta.
-
Minio Docs has a doctor server running that pulls together MD files that reside across a number of github repos :
Eg:
- README.md in https://github.com/minio/minio
- Markdown files in https://github.com/minio/minio/tree/master/docs
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.
Deployment
Heroku
Scalingo
Docker
Using Docker Compose
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
- Open http://localhost:3000 on your browser to see doctor running from docker container.
- Note: If you start doctor in production mode, all http requests are redirected to https.
Features
- Documents are organized under Categories.
- Login to the dashboard
- Step 1 : Use the Dashboard to create a new Category : http://localhost:3000/categories/new
- Step 2 : Use the Dashboard to create a link to a new Document : http://localhost:3000/docs/new
- Step 3: Paste the raw URL to the md file when linking a new document. The "Raw" button is on the top of the MD file in github.
- Required : All documents need to be associated under a Category
Development
Quickstart: Setup on OSX
- Install Ruby 2.2.2 using the instructions here.
- Install Rails 4.2.4 using the instructions here.
- Install Postgres using the command
brew install postgres
. Configure Launch Agent to start it automatically or use the commandpg_ctl -D /usr/local/var/postgres -l /usr/local/var/postgres/server.log start
to start it manually.
Quickstart: Setup on Ubuntu
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
Use [email protected]
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.
Note -
- On Ubuntu vanilla installations,
bundle install
sometimes may not go through smoothly. In that case, you may need to runsudo apt install libpg-dev
- If you get error message:
Gem Load Error is: Could not find a JavaScript runtime. See https://github.com/rails/execjs for a list of available runtimes.
, duringbundle install
, then runsudo apt-get install nodejs
- If you see error:
ActiveRecord::NoDatabaseError: FATAL: role <your_user_name> does not exist
duringrake:db setup
, then run:sudo -u postgres createuser --superuser <your_user_name>
- Ping us on our gitter channel to report any installation issues on your platform.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].