Skip to content

Latest commit

 

History

History
91 lines (42 loc) · 1.41 KB

README.md

File metadata and controls

91 lines (42 loc) · 1.41 KB
Raw

docs.rioos.xyz

This is the documentation repository for Rio OS

The documentation is live here

Hosted

At the moment this is hosted in netlify.com.

A push to master of this repository will refresh documentation automatically.

Login to netlify app.netlify

Userid: kishore.neelamegam@netlify.com Password: Team#4rio

Updating documentation locally

These instructions are tested in Linux and FreeBSD

  1. Install Ruby 2.5.1 via rvm.io or anyothers

  2. Fork & clone this repository to your id (eg: paulsanar)


git clone https://gitlab.com/paulsanar/docs.rioos.xyz

cd docs.rioos.xyz

git remote -v

git remove rm origin

git remote add origin https://gitlab.com/rioos/docs.rioos.xyz
git remote add master https://gitlab.com/paulsanar/docs.rioos.xyz
  1. Install bundler

gem install bundler
  1. Run jekyll, and start editing using your favourite editor (atom.io, vscode, sublimetext or any others)
bundle install 

jekyll clean

jekyll serve
  1. Edit files using markdown (.md)

Local changes are in url

  1. When you are happy push to your repo

git add .

git commit -m "Updated sections ..."

git push master

  1. Provide a merge request from your id paulsanar to rioos

  2. When the pull request is merged, the docs get refreshed live here