Skip to content

Create Ember Data landing page (#638) #746

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Create Ember Data landing page (#638) #746

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions app/routes/project-version.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,10 +50,11 @@ export default Route.extend({
// if there is no class, module, or namespace specified...
let latestVersion = getLastVersion(model.get('project.content').hasMany('projectVersions').ids());
let isLatestVersion = transitionVersion === latestVersion || transitionVersion === 'release';
let isEmberProject = model.get('project.id') === 'ember';
let shouldConvertPackages = semverCompare(model.get('version'), '2.16') < 0;
if (!shouldConvertPackages || isLatestVersion) {
// ... and the transition version is the latest release,
// display the landing page at
if ((!shouldConvertPackages || isLatestVersion) && isEmberProject) {
// ... and the transition version is the latest release, and the selected docs are
// ember (not Ember Data), then display the landing page at
return this.transitionTo('project-version.index');
} else {
// else go to the version specified
Expand Down
56 changes: 56 additions & 0 deletions app/templates/ember-data.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<article class="chapter">
<h1>
Ember Data API Documentation
</h1>
<p>
Ember Data is a library for robustly managing data in applications built with Ember.js.
</p>
<h2>
Commonly searched-for documentation
</h2>
<ul class="spec-method-list">
<li>
{{#link-to "project-version.classes.class" "Model"}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be nice to break this out to links to the overviews to the respective packages vs to specific classes, with a short explainer that ember-data is a package that assembles these other packages, most of which are not required.

Model
{{/link-to}}
- an object that represents the underlying data that your application presents to the user.
</li>
<li>
{{#link-to "project-version.classes.class" "Store"}}
Store
{{/link-to}}
- a service that contains all of the data for records loaded from the server.
</li>
<li>
{{#link-to "project-version.classes.class" "Adapter"}}
Adapter
{{/link-to}}
- determines how data is persisted to a backend data store.
</li>
<li>
{{#link-to "project-version.classes.class" "Serializer"}}
Serializer
{{/link-to}}
- format the data sent to and received from the backend store.
</li>
</ul>
<h2>
Useful links
</h2>
<ul>
<li>
<h5>
<a href="https://github.com/ember-learn/ember-api-docs">
API Documentation Github Repository
</a>
</h5>
</li>
<li>
<h5>
<a href="https://guides.emberjs.com/release/models/">
Introduction to Ember Data
</a>
</h5>
</li>
</ul>
</article>
10 changes: 0 additions & 10 deletions tests/acceptance/redirects-test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,16 +15,6 @@ module('Acceptance | redirects', function(hooks) {
assert.dom('h1').hasText('Ember API Documentation');
});

test('visiting /ember-data', async function (assert) {
await visit('/ember-data');
assert.equal(
currentURL(),
`/ember-data/release`,
'routes to the landing page'
);
assert.dom('h1').hasText('Ember API Documentation');
Copy link
Contributor

@jenweber jenweber Apr 1, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this test is changed to say "Ember Data API Documentation" for the h1 assertion, would that work?

This test exists to make sure some redirects work from legacy urls, so it's good to keep if we can.

});

test('visiting pre-2.16 version', async function(assert) {
await visit('/ember/1.0');

Expand Down