GitHub - ember-learn/ember-api-docs: Ember API Docs viewer (original) (raw)

Ember API Docs

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

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

• The app in this repository, which fetches and displays the API docs data. It is what you see athttps://api.emberjs.com/
• The YUIdoc code comments found in theEmber.js codebase, where the informational content of the API documentation can be edited
• The data generator that serializes code comments into JSONAPI and deploys the result,ember-jsonapi-docs
• ember-styleguide, a component and styling library shared across apps.
• algolia-index-update-scripts for managing the search feature of the api docs site

Contributing

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

The best way to get started is to find an issue labeled "good first issue" or "help wanted." If you have questions or want a buddy to pair with, drop by the #dev-ember-learning channel on theEmber Community Discord. 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 inMaking your first pull request in the Guides repository.

Please also see CONTRIBUTING.md.

Running in your local environment

ember-api-docs expects a folder in its root that links to the ember-api-docs-data folder, so you can either use the npm run clone script to clone the ember-api-docs-data repo into ember-api-docs, OR you can create a symbolic link to ember-api-docs-data from ember-api-docs. You might want to sym-link ember-api-docs-data if you are generating new versions of the docs files with ember-jsonapi-docs, otherwise you can probably use the clone script.

Quickstart to run locally

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

git clone https://github.com/ember-learn/ember-api-docs.git
cd ember-api-docs
pnpm install
pnpm run clone
pnpm run start

View at http://localhost:4200

Run locally with a sym-link

Clone all of the following repositories into the same directory so they are "siblings" on the file system:

• This repository, ember-api-docs
• ember-api-docs-data

git clone https://github.com/ember-learn/ember-api-docs-data git clone https://github.com/ember-learn/ember-api-docs cd ember-api-docs ln -s ../ember-api-docs-data pnpm install pnpm start

Visit the app in your browser at http://localhost:4200

a11y testing

To run a11y tests, run test_a11y=yes ember serve

Linting

• pnpm run lint:hbs
• pnpm run lint:js
• pnpm run lint:js -- --fix

Staging and Deployment

See the DEPLOYING.md guide for instructions.

Building

Cross-browser testing provided by: