Skip to content
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.

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

ember-data landing page: use ember-data-overview module main if present #761

Merged
merged 3 commits into from
May 26, 2021

Conversation

runspired
Copy link
Contributor

Results of pairing with @jenweber

This allows the ember-data team to maintain and update the overview for ember-data directly with each release, falling back to a built-in overview for versions for which the library did not yet provide one.

I've configured it to use the main from the module ember-data-overview as opposed to ember-data to ensure that any old releases that had ember-data as a module (current releases do not) won't accidentally trip into this behavior.

We should consider expanding this for the ember-cli and ember.js teams to utilize as well, it would be quite easy to do.

The ember-data-overview page is filtered from the modules that will appear in the sidebar to prevent confusion, since it is already the primary link for the project. This also allows us to re-use ember-data module main as an explainer for that particular package vs for the project as a whole.

@runspired runspired changed the base branch from jw-ct-ember-data-landing-page to master May 22, 2021 00:08
@jenweber jenweber requested a review from amyrlam May 22, 2021 00:09
@jenweber
Copy link
Contributor

@amyrlam I’m going to set this PR up on the staging env and will let you know when it’s ready! Let me know if you think I should tag someone else for review.

@jenweber jenweber temporarily deployed to ember-api-docs-staging May 22, 2021 00:59 Inactive
Copy link
Member

@amyrlam amyrlam left a comment

Choose a reason for hiding this comment

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

:shipit: thank you for getting this across the finish line!

@amyrlam
Copy link
Member

amyrlam commented May 22, 2021

@jenweber Can't think of anyone else to review, but I will xpost in #core-learning for awareness!

@jenweber
Copy link
Contributor

I click tested this in staging, and everything looks good there! Github has some pipeline issues affecting heroku, so this will be deployed after those clear up.

@jenweber jenweber merged commit 1a56b06 into ember-learn:master May 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants