Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raml-org/raml-org
Project website
https://github.com/raml-org/raml-org
raml
Last synced: about 1 month ago
JSON representation
Project website
- Host: GitHub
- URL: https://github.com/raml-org/raml-org
- Owner: raml-org
- Created: 2015-11-03T17:20:35.000Z (about 9 years ago)
- Default Branch: develop
- Last Pushed: 2023-05-02T17:49:29.000Z (over 1 year ago)
- Last Synced: 2024-03-25T22:57:43.614Z (9 months ago)
- Topics: raml
- Language: SCSS
- Homepage: https://raml.org
- Size: 16.8 MB
- Stars: 14
- Watchers: 7
- Forks: 25
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.html
Awesome Lists containing this project
README
# RAML.org Website
> This repository contains the source code for the raml.org website written in Jekyll
## Requirements
- Ruby >2.5.x
- [Bundler](https://bundler.io) >2.0
- [Jekyll](https://jekyllrb.com) >3.8.5
## Running locally
Pull the code locally:
```
$ git clone [email protected]:raml-org/raml-org.git
```
Enter directory:
```
$ cd raml-org
```
Install all dependencies:
```
$ bundle install
```
Build & run the site:
```
$ bundle exec jekyll serve
```
## 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](_data/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](https://github.com/blog/2309-introducing-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](https://github.com/search?utf8=✓&q=topic%3Araml-design) | Includes projects that specifically support people with the design of RAML documents. |
| [raml-document](https://github.com/search?utf8=✓&q=topic%3Araml-document) | Includes projects that focus on the documentation of APIs using RAML documents. |
| [raml-build](https://github.com/search?utf8=✓&q=topic%3Araml-build) | Includes projects that focus on build client or server code based on RAML documents. |
| [raml-parser](https://github.com/search?utf8=✓&q=topic%3Araml-parser) | Includes projects that parses/validates RAML documents. |
| [raml-test](https://github.com/search?utf8=✓&q=topic%3Araml-test) | Includes projects that support people testing APIs based on RAML documents. |
| [raml-utilities](https://github.com/search?utf8=✓&q=topic%3Araml-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](#to-run-the-jekyll-site-locally) 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](#how-to-add-projects-to-the-projects-page)
* blog posts
* and others, after carefully reviewing the issue you created