sichvoge/raml-org

This repository contains the source code for the raml.org website written in Jekyll.

RAML.org Website

This repository contains the source code for the raml.org website written in Jekyll.

To Install jekyll

please check the below links:

1. For mac.
2. For ubuntu.

To Run the jekyll Site locally

1. Pull the code locally

2. change to the root directory of the raml-org project by running the command in your terminal

   cd raml-org
   

3. remove the below line in blogs/index.html in case you are testing locally

   permlaink: /blogs
   

4. run this command

   bundle install
   

5. Run this command to build the jekyll site

   jekyll serve --detach
   

   currently the site will run with port 4000. say for example http://localhost:4000.

   if you want to run the site with port 80. First you need to stop services that are listening to port 80 then run the below command:

   jekyll serve --port=80 --detach
   

To run the jekyll site on the prod or stagging server

1. Pull the code on your server

2. goto root directory by running the command in your terminal

   cd raml-org
   

3. run this command

   bundle install
   

4. Run this command to build the jekyll site

   jekyll serve --host=<ip of the server> --port=80 --detach
   

How to add projects to the projects page?

RAML.org includes a projects page that lists tools around RAML that either are community or commercial driven. If you think, your project should be in this list, please fork this repository, add it into the projects.yml file, and send us a PR. We will review and let you know if we will be able to list it.

Another way to make sure your project is linked to our projects page is through assigning topics to your Github project. Links to each topics are below the list of projects on the projects page. The following topics are available:

Topic	Description
raml-design	Includes projects that specifically support people with the design of RAML documents.
raml-document	Includes projects that focus on the documentation of APIs using RAML documents.
raml-build	Includes projects that focus on build client or server code based on RAML documents.
raml-parser	Includes projects that parses/validates RAML documents.
raml-test	Includes projects that support people testing APIs based on RAML documents.
raml-utilities	Includes other projects that do not fall into the other topics like converters.

Topics need to be assigned and managed by the owner of a project. The RAML community does not have any influence. Additionally, we still recommend people to search on Github as well.

Test Staging