Contributions are welcome!
You can easily make changes because we follow a naming convention.
Advanced strategies should be PR'ed directly to the Ember.js Guides, since a goal of this project is to be short and sweet.
This is an Ember app, so the usual steps follow:
- Fork and clone this repo.
git clone [email protected]:<your GitHub handle>/ember-octane-vs-classic-cheat-sheet.git
- Change directory.
cd ember-octane-vs-classic-cheat-sheet - Install packages.
npm install
- Run the app.
ember serve
- Visit your app at http://localhost:4200.
This site is deployed to GitHub Pages automatically from the main branch.
First, have a look at app/routes/application.js.
The model hook returns an array of section objects. Each section can further define an array of subsection objects.
We use sections and subsections to organize this guide.
Next, we want to explain to the reader what a section or subsection is about.
We store titles and descriptions in translations/en-us.yaml. A description can contain HTML elements like hyperlinks.
The translation keys match the section and subsection IDs.
Finally, we want to show code examples to the reader.
We store code snippets in snippets folder. Afterwards, we update the model hook by listing the files.
Subfolder names match the subsection IDs.
You can find the text in translations/en-us.yaml, the code in snippets, and the app structure in app/routes/application.js! 💖