mayadata-docs

Building docs:

The default branch is staging. Contributions are accepted to staging branch. The accepted doc changes are visible at docs.mayadatastaging.io

Prerequisites

Ensure you have the latest version of Node installed. We also recommend you install Yarn as well.

• You have to be on Node >= 8.x and Yarn >= 1.5.

Clone the code

Follow the below instructions to build and test your changes.

git clone -b staging https://github.com/mayadata-io/mayadata-docs.git

To get a preview of .md file

1. For MAC

   1. cd website 
   2. npm install
   3. npm start

   Then browse here

2. For Ubuntu
   On your terminal,

   1. sudo apt-get update
   2. sudo apt install nodejs
   3. sudo apt install npm

   If installed successfully, run npm -v on your terminal, it should display the version of npm installed.
   
   Now, to view:

   1. $ cd website
   2. $ npm start

License

Copyright (c) 2017-2019 MayaData, Inc.

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.