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

Make individual pages for deprecations #1261

Merged
merged 13 commits into from
Jun 9, 2023
Merged

Make individual pages for deprecations #1261

merged 13 commits into from
Jun 9, 2023

Conversation

jenweber
Copy link
Contributor

@jenweber jenweber commented Jan 13, 2023

Closes #1256

Goal:
URLS like like https://deprecations.emberjs.com/id/some-deprecation bring you to a guide about an individual deprecation

Progress so far:

Screen Shot 2023-01-29 at 4 13 45 PM

@netlify
Copy link

netlify bot commented Jan 13, 2023

Deploy Preview for ember-deprecations ready!

Name Link
🔨 Latest commit 2274005
🔍 Latest deploy log https://app.netlify.com/sites/ember-deprecations/deploys/647b2f42ac71ac0007640d1c
😎 Deploy Preview https://deploy-preview-1261--ember-deprecations.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@jenweber jenweber changed the title WIP Make individual pages for deprecations Make individual pages for deprecations Jan 29, 2023
@jenweber
Copy link
Contributor Author

@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.

@jenweber jenweber requested a review from mansona January 29, 2023 21:29
@jenweber
Copy link
Contributor Author

cc @kategengler I think this is just about ready. URLs for individual deprecation pages will look something like http://localhost:4200/id/blueprint.add-bower-packages-to-project

@kategengler
Copy link
Contributor

Excellent! 🥳

Copy link
Member

@mansona mansona left a 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

@kategengler
Copy link
Contributor

Any chance this can merge?

@kategengler
Copy link
Contributor

@jenweber Wondering if we can find someone to get this over the line? Hate for it to go stale.

@MinThaMie
Copy link
Contributor

@kategengler we discussed this during today's learning core meeting. @jenweber and @mansona will try to work on it on Friday!

@jenweber
Copy link
Contributor Author

jenweber commented Jun 2, 2023

@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 id specified in the frontmatter (and by extension, the id mentioned in ember source).

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 url in the deprecation options. That link would go to the individual deprecation page. These improvements do not block the launch of the deprecation app improvements, since everything is backwards compatible.

Let us know if you have any thoughts on how the url is done in emberjs.

@mansona
Copy link
Member

mansona commented Jun 2, 2023

@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

@mansona mansona mentioned this pull request Jun 3, 2023
jenweber and others added 12 commits June 3, 2023 13:09
See TODO in code comments

Make individual pages for deprecations
Fastboot is still used for prember, but
not for URLs or CDNs.
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.
Copy link
Member

@mansona mansona left a comment

Choose a reason for hiding this comment

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

woop woop!

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.

URL Scheme for deprecations
4 participants