Eclipse Api Documentation
This project describes the resources that make up the official Eclipse Foundation REST API.
Links
Warning: All above links are updated only after Travis CI finishes deployment
Getting started
Install
- Install Node JS
- Clone repo and run
npm install
in the repo root
Usage
npm start
Starts the development server.
npm run build
Bundles the spec and prepares web_deploy folder with static assets.
npm test
Validates the spec.
npm run gh-pages
Deploys docs to GitHub Pages. You don't need to run it manually if you have Travis CI configured.
Contributing
- Fork the eclipsefdn/it/api/api.eclipse.org-docs repository
- Clone repository:
git clone https://gitlab.eclipse.org/[your_gitlab_username]/api.eclipse.org-docs.git
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -m 'Add some feature' -s
- Push feature branch:
git push origin my-new-feature
- Submit a merge request
Declared Project Licenses
This program and the accompanying materials are made available under the terms of the Eclipse Public License v. 2.0 which is available at http://www.eclipse.org/legal/epl-2.0.
SPDX-License-Identifier: EPL-2.0
Bugs and feature requests
Have a bug or a feature request? Please search for existing and closed issues. If your problem or idea is not addressed yet, please open a new issue.
Author
Christopher Guindon (Eclipse Foundation)
Eric Poirier (Eclipse Foundation)
Trademarks
- Eclipse® is a Trademark of the Eclipse Foundation, Inc.
- Eclipse Foundation is a Trademark of the Eclipse Foundation, Inc.
Copyright and license
Copyright 2018 the Eclipse Foundation, Inc. and the api.eclipse.org-docs authors. Code released under the Eclipse Public License Version 2.0 (EPL-2.0).