Skip to content

Latest commit

 

History

History
84 lines (52 loc) · 3.13 KB

README.md

File metadata and controls

84 lines (52 loc) · 3.13 KB

This project uses GitHub Actions for continuous integration. This project uses Percy.io for visual regression testing.

deprecation-app

This is the app that serves https://deprecations.emberjs.com/

Linking to deprecations

You can link to a specific deprecation by using the ID of the deprecation. For example, to link to the deprecation with the ID my-old-api, you can use the following URL: https://deprecations.emberjs.com/id/my-old-api. These URLs can be generated in advance of adding the deprecation guide, when the deprecation lands in the code. When adding a deprecation the filename should match the ID of the deprecation, or the displayId should be specified in the frontmatter.

Adding new deprecations

The content folder contains all the deprecations that are listed by the website. To add a new deprecation, add it to the appropriate folder by creating a new file. The content of the file needs to follow a specific format for the app to work. You can see this sample for reference.

Frontmatter

Grouping deprecations

  parent: deprecation-id

Can be used to nest deprecations under a parent grouping for the purpose of the UI. The deprecations will still be available via the direct ID URLs.

Prerequisites

You will need the following things properly installed on your computer.

Installation

  • git clone <repository-url> this repository
  • cd deprecation-app
  • npm install

Running / Development

Troubleshooting

Do you only see a blank page with a header and footer? Or maybe a 404? Make sure to visit http://localhost:4200/v3.x to view the app with data loaded in.

Code Generators

Make use of the many generators for code, try ember help generate for more details

Running Tests

  • ember test
  • ember test --server

Linting

  • npm run lint
  • npm run lint:fix

Building

  • npm run build (production)

Deploying

The app is continuously deployed to Netlify when a pull request is merged and passes continuous integration.

Further Reading / Useful Links