Skip to content

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

Notifications You must be signed in to change notification settings

DavideRossi/raml-org

This branch is 291 commits behind raml-org/raml-org:prd.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

5e5bf35 · Feb 17, 2018
Jul 24, 2017
Feb 17, 2018
Feb 17, 2018
Dec 14, 2017
Mar 24, 2017
Jun 15, 2017
Nov 29, 2017
Feb 17, 2017
Nov 29, 2017
Jun 27, 2017
Jun 14, 2017
Apr 19, 2017
May 19, 2017
Nov 29, 2017
Jun 16, 2017
Nov 29, 2017
Nov 29, 2017
Nov 29, 2017
Nov 29, 2017
Feb 18, 2017
Jun 15, 2017
Jun 15, 2017
Jun 7, 2017
Jun 15, 2017
Mar 24, 2017
Mar 24, 2017
Mar 13, 2017
May 18, 2017
Feb 18, 2017
Feb 17, 2018
Mar 24, 2017
Feb 17, 2018
Mar 10, 2017
May 19, 2017
Jul 5, 2017
Jun 2, 2017
Jul 5, 2017
Jul 5, 2017
Jul 5, 2017
Mar 10, 2017
Nov 3, 2017
Feb 18, 2017
Mar 8, 2017
Dec 1, 2017
May 16, 2017
Jun 28, 2017
Jun 7, 2017
Mar 17, 2017
Sep 29, 2017

Repository files navigation

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

    permalink: /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. Additionally, we still recommend people to search on Github for more projects that might not have these topics assigned.

Contribution

RAML's website is in fact an open source project and your contribution is very much appreciated. Before you start, you should check for open issues or open a fresh issue to start a discussion around an idea that you'd like to see on our website or a bug. If you want to support us fixing issues, please follow the steps below:

  1. Fork the repository on Github and make your changes on the develop branch (or branch off of it).
  2. Run the website to see if you fixed the issue.
  3. Send a pull request (with the develop branch as the target).

We will review your PR, comment if necessary, and merge it into our staging branch stg.

You can contribute to the following:

  • spelling mistakes
  • new projects
  • blog posts
  • and others, after carefully reviewing the issue you created

About

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

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • HTML 83.5%
  • CSS 14.4%
  • JavaScript 1.2%
  • Ruby 0.9%