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

[WIP] migration guide #552

Merged
merged 16 commits into from
Jan 5, 2019
Merged

[WIP] migration guide #552

merged 16 commits into from
Jan 5, 2019

Conversation

alexjeffburke
Copy link
Member

This commit adds a first iteration of a migration guide for v11.

Copy link
Member

@sunesimonsen sunesimonsen left a comment

Choose a reason for hiding this comment

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

This is absolutely awesome, thanks you so much!

documentation/migration.md Outdated Show resolved Hide resolved
Copy link
Member

@papandreou papandreou left a comment

Choose a reason for hiding this comment

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

This is great, thank you so much for picking this up!

I think I would put the #### sections in exactly the opposite order, so (what I perceive to be) the most impactful breaking changes would be mentioned first.

documentation/migration.md Outdated Show resolved Hide resolved
Most importantly place the function by value information after the
expect.it() information because it builds on it.
@alexjeffburke
Copy link
Member Author

@sunesimonsen @papandreou this could do with a fresh read by both of you :)

@papandreou
Copy link
Member

I think we need a way to control the order of the pages in the top menu, and maybe whether they appear there at all. It's pushing out the plugins page on small screens in portrait mode:

image-1 2

If we solve that, we should also move the Releases section to a separate page.

documentation/migration.md Outdated Show resolved Hide resolved
documentation/migration.md Outdated Show resolved Hide resolved
documentation/migration.md Outdated Show resolved Hide resolved
documentation/migration.md Outdated Show resolved Hide resolved
documentation/migration.md Show resolved Hide resolved
@sunesimonsen
Copy link
Member

I don't want the migration to be a menu point, I don't think it is important enough for that. But let's solve that technically.

@alexjeffburke
Copy link
Member Author

I think you're both right that this doesn't need to be a top level menu - only did that because it was easy. Perhaps Releases is the way to go and migration is linked to or something.

@alexjeffburke
Copy link
Member Author

@papandreou have hopefully addressed all your comments in the last push :)

@@ -0,0 +1,187 @@
---
title: Migration
Copy link
Member

Choose a reason for hiding this comment

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

Maybe the title should be "Migration to Unexpected 11"? Or maybe it would be better to also list migration guides for future versions here, but then the heading below (line 8) should be "Migration to Unexpected 11" or similar.

@papandreou
Copy link
Member

papandreou commented Jan 3, 2019

Looks great! I guess what's missing is then:

  • Add the capability to unexpected-documentation-site-builder to hide pages from the menu, via a flag in the front matter or similar
  • Make the migration page hidden
  • Add a "releases" page, probably also hidden from the menu, based on https://unexpected.js.org/#releases, also including a brief section for Unexpected 11 that links to the migration guide.
  • Link to the "releases" page from the front page

Edit: The two last ones are fixed in #560

@papandreou papandreou merged commit 0eaf94d into v11 Jan 5, 2019
@papandreou papandreou deleted the docs/migrationGuide branch January 5, 2019 20:27
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.

None yet

3 participants