-
-
Notifications
You must be signed in to change notification settings - Fork 69
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
Make individual pages for deprecations #1261
Conversation
✅ Deploy Preview for ember-deprecations ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
@mansona this is ready for review. I updated the markup to account for having a single-deprecation page with one heading, and included a breadcrumb-style link. If this passes your click test, I think it is good to go. I think we will need to give a little README guidance about how to figure out what the individual URL of a new deprecation will be. I would like to do that as a followup PR. |
cc @kategengler I think this is just about ready. URLs for individual deprecation pages will look something like |
Excellent! 🥳 |
1fd06e4
to
8c58f81
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- remove ids from all markdowns
- make sure the filenames matched all ids that were there
- add a linter that prevents anyone adding id again
for example check filename v4/auto-location.md
which has an ID of deprecate-auto-location
Any chance this can merge? |
@jenweber Wondering if we can find someone to get this over the line? Hate for it to go stale. |
@kategengler we discussed this during today's learning core meeting. @jenweber and @mansona will try to work on it on Friday! |
8c58f81
to
670ab74
Compare
@kategengler Here's some info on where we're at and how it intersects with ember.js. Chris & I worked on this the past 2 Fridays and are getting close! We renamed files to match their ids, sorted out a file naming clash, and next up we will work on a linter for this repo to enforce the new pattern. From a UX perspective - the pages that are in prod today will have no changes - anchor links and all that will work exactly the same, and those urls will not change. New individual page URLs will be derived from the In ember.js, we would have a few options then for simplifying the experience. Here's one of them. We could write a private wrapper in ember source that generates the link based on the URL, and lint against including Let us know if you have any thoughts on how the url is done in emberjs. |
670ab74
to
54b5d86
Compare
@jenweber I think this is working now. I removed the scripts because they didn't seem useful to commit, but I preserved them in a new branch if we need to run them again https://github.com/ember-learn/deprecation-app/tree/jw-cm-script-for-fixing-content |
54b5d86
to
e9140a8
Compare
See TODO in code comments Make individual pages for deprecations
Fastboot is still used for prember, but not for URLs or CDNs.
Co-authored-by: Chris Manson <[email protected]>
Pass in a block to DeprecationArticle so that we can use it for both the page with many components and the page with only one.
This md file was floating, not under any version directory. Based on content, it seems to go in Ember v1.
0b82734
to
ad2e672
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
woop woop!
Closes #1256
Goal:
URLS like like
https://deprecations.emberjs.com/id/some-deprecation
bring you to a guide about an individual deprecationProgress so far: