Ember API Docs viewer
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app Search for "not private" instead of "public" because ember data class… Sep 17, 2018
bin Simplify browserstack setup Jun 16, 2018
config Use latest eslintrc & fix errors Jun 16, 2018
lib/hash-to-query Use latest eslintrc & fix errors Jun 16, 2018
public doc(browserstack): adds logo and note to readme Apr 22, 2018
tests Remove code examples from meta description Jun 30, 2018
vendor Initial Commit from Ember CLI v1.13.13 Dec 6, 2015
.bowerrc Initial Commit from Ember CLI v1.13.13 Dec 6, 2015
.editorconfig Initial Commit from Ember CLI v1.13.13 Dec 6, 2015
.ember-cli Initial Commit from Ember CLI v1.13.13 Dec 6, 2015
.env.sample Drop couch support (#146) Mar 15, 2017
.eslintrc.js Simplify browserstack setup Jun 16, 2018
.gitignore Simplify browserstack setup Jun 16, 2018
.template-lintrc.js Drop couch support (#146) Mar 15, 2017
.travis.yml Simplify browserstack setup Jun 16, 2018
.watchmanconfig Initial Commit from Ember CLI v1.13.13 Dec 6, 2015
CONTRIBUTING.md Update CONTRIBUTING.md Jul 22, 2017
DEPLOYING.md Explain why promote to production shouldn't be used for deploying Feb 4, 2018
LICENSE Upgrade Ember{.js,Data,CLI} to 2.10 Dec 5, 2016
Procfile Use a globally installed tool to purge fastly cache Oct 20, 2017
README.md Update README.md Aug 12, 2018
app.json :shipit: making this app the default api viewer Jul 11, 2017
bower.json create a landing page for ember API docs (#429) Feb 24, 2018
ember-cli-build.js fix(ead): adds polyfill for es6 features in ie11 Apr 2, 2018
local.log test(browserstack): setup cross-browser testing Apr 22, 2018
package.json Fix and sanitize meta descriptions for classes Jun 30, 2018
run-tests.js Access results only on travis Jun 16, 2018
testem.js Simplify browserstack setup Jun 16, 2018
yarn.lock Fix and sanitize meta descriptions for classes Jun 30, 2018

README.md

Ember API Docs Build Status

This project contains only the API docs portion of Emberjs.com. If you're looking for the rest of the site, see the website and guides repositories.

There are many pieces that together create the Ember API docs site:

Contributing

New contributors are welcome! This project is is maintained by an all-volunteer team, and we are thankful for your help.

The best way to get started is to find issue labeled "good first issue" or "help wanted." If you have questions or want a buddy to pair with, drop by the #-team-learning channel on the Ember Community Slack. Like most open source projects, contributors are encouraged to open an issue to propose changes and iterate on ideas before investing time in coding. Some tips for working with git/GitHub can be found in Making your first pull request in the Guides respository.

Please also see CONTRIBUTING.md.

Quickstart to run semi-locally

Follow these instructions to run the app using publically available online data. You do not need to run ember-jsonapi-docs locally yourself.

git clone https://github.com/ember-learn/ember-api-docs.git
cd ember-api-docs
yarn install
bower install
ember serve

View at http://localhost:4200

a11y testing

To run a11y tests, run test_a11y=yes ember serve

Staging Environment

Latest changes from master can be seen on https://ember-api-docs-frontend-staging.global.ssl.fastly.net/


Cross-browser testing provided by:

BrowserStack