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

docs: link to next docs and vice versa #1438

Merged
merged 22 commits into from
Oct 23, 2022
Merged

docs: link to next docs and vice versa #1438

merged 22 commits into from
Oct 23, 2022

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Oct 13, 2022

Currently the https://next.fakerjs.dev/ page does not show any hints that it isn't the current version.

grafik

This PR changes the version number to Next and adds a link to the latest released page.

grafik

@ST-DDT ST-DDT added c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: needs decision Needs team/maintainer decision labels Oct 13, 2022
@ST-DDT ST-DDT added this to the v8.0 - Module Re-Shuffling milestone Oct 13, 2022
@ST-DDT ST-DDT requested review from a team October 13, 2022 09:31
@ST-DDT ST-DDT self-assigned this Oct 13, 2022
@codecov
Copy link

codecov bot commented Oct 13, 2022

Codecov Report

Merging #1438 (fd652d9) into next (b983ca1) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1438   +/-   ##
=======================================
  Coverage   99.62%   99.62%           
=======================================
  Files        2165     2165           
  Lines      237132   237132           
  Branches     1016     1016           
=======================================
  Hits       236242   236242           
  Misses        869      869           
  Partials       21       21           

@matthewmayer
Copy link
Contributor

This seems really subtle unless you really know what to look for. Would it be possible to add something more blatant like a top banner? (rough mockup attached)

Screenshot 2022-10-15 at 20 52 35

@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 15, 2022

@matthewmayer Good point. This PR is more about linking the different versions together/making them accessible from our main website, so I created a new issue (#1456) for that to keep track of it.

@ST-DDT ST-DDT changed the title docs: show next version as special one docs: link to next docs and vice versa Oct 15, 2022
docs/.vitepress/versions.ts Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 16, 2022

I created some preview deployments:

@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 16, 2022

Not sure whether latest or next should be first:
grafik

If next is the top one, then it will be in the "correct" version order.

@Shinigami92
Copy link
Member

Looked into the preview deployments and I like them all 👍
Good job

Copy link
Member

@Shinigami92 Shinigami92 left a comment

Choose a reason for hiding this comment

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

The code is now MUCH better 👍
Will approve after rebased

docs/.vitepress/versions.ts Outdated Show resolved Hide resolved
Shinigami92
Shinigami92 previously approved these changes Oct 17, 2022
Shinigami92
Shinigami92 previously approved these changes Oct 17, 2022
@ST-DDT ST-DDT added s: accepted Accepted feature / Confirmed bug and removed s: needs decision Needs team/maintainer decision labels Oct 17, 2022
@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 17, 2022

It doesn't pass our CI, so I reverted it.

@ST-DDT ST-DDT requested review from Shinigami92 and a team October 17, 2022 12:57
@Shinigami92
Copy link
Member

🤣 no f*cking way, out TESTS are blocking it 🤣
Oh my good, okay, no new syntax for us I guess 😭 That's brutal 😖

@ST-DDT
Copy link
Member Author

ST-DDT commented Oct 17, 2022

Well, we could omit the tests... 🤣

@Shinigami92
Copy link
Member

Well, we could omit the tests... rofl

Na, lets just upgrade when we move to ^Node16

@ST-DDT ST-DDT merged commit 7d39ef7 into next Oct 23, 2022
@ST-DDT ST-DDT deleted the docs/next-version-number branch October 23, 2022 08:36
@ST-DDT ST-DDT mentioned this pull request Oct 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: docs Improvements or additions to documentation p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

4 participants