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: add version banner #1487

Merged
merged 22 commits into from Oct 28, 2022
Merged

docs: add version banner #1487

merged 22 commits into from Oct 28, 2022

Conversation

brc-dd
Copy link
Contributor

@brc-dd brc-dd commented Oct 25, 2022

fixes #1456

TODO:

  • allow users to dismiss that

Note on how id works: Each time you change the banner text and want users (those who had dismissed it) to see new banner just update the id to any new random value. You can omit id to for a particular channel to don't persist users' preference for banner dismissal.

Updated behavior: Dismissal preference is only kept for 24hrs now. There won't be need to add random ids.

@brc-dd brc-dd requested a review from a team October 25, 2022 18:27
@brc-dd brc-dd requested a review from a team as a code owner October 25, 2022 18:27
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 banner should always be shown on non-https://fakerjs.dev/ sites
But they all have the same source, so we need to check window.location.host !== 'fakerjs.dev' or something like that

@Shinigami92 Shinigami92 added the c: docs Improvements or additions to documentation label Oct 25, 2022
@brc-dd brc-dd marked this pull request as draft October 25, 2022 19:37
docs/.vitepress/config.ts Outdated Show resolved Hide resolved
docs/.vitepress/components/Banner.vue Outdated Show resolved Hide resolved
@brc-dd brc-dd marked this pull request as ready for review October 26, 2022 16:32
@brc-dd
Copy link
Contributor Author

brc-dd commented Oct 26, 2022

This is ready for review guys! 🙏

@brc-dd brc-dd changed the title docs: add banner to next docs docs: add banner Oct 26, 2022
@brc-dd brc-dd changed the title docs: add banner docs: add version banner Oct 26, 2022
@codecov
Copy link

codecov bot commented Oct 26, 2022

Codecov Report

Merging #1487 (171f7f9) into next (09e8356) will not change coverage.
The diff coverage is n/a.

Additional details and impacted files
@@           Coverage Diff           @@
##             next    #1487   +/-   ##
=======================================
  Coverage   99.63%   99.63%           
=======================================
  Files        2165     2165           
  Lines      237147   237147           
  Branches     1021     1021           
=======================================
  Hits       236285   236285           
  Misses        841      841           
  Partials       21       21           

docs/.vitepress/versions.ts Outdated Show resolved Hide resolved
docs/.vitepress/config.ts Outdated Show resolved Hide resolved
docs/.vitepress/components/Banner.vue Outdated Show resolved Hide resolved
@Shinigami92
Copy link
Member

Shinigami92 commented Oct 26, 2022

Example Screenshot of iPhone XS (Opera Mini)

@Shinigami92
Copy link
Member

I'm thinking about to use the sessionStorage instead of localStorage 🤔

brc-dd and others added 3 commits October 26, 2022 23:16
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
Co-authored-by: Shinigami <chrissi92@hotmail.de>
@brc-dd brc-dd dismissed stale reviews from ST-DDT and Shinigami92 via 4ab0e46 October 26, 2022 20:17
ST-DDT
ST-DDT previously approved these changes Oct 26, 2022
@ST-DDT ST-DDT added p: 1-normal Nothing urgent s: accepted Accepted feature / Confirmed bug labels Oct 26, 2022
Shinigami92
Shinigami92 previously approved these changes Oct 26, 2022
@ST-DDT ST-DDT requested review from import-brain and a team October 26, 2022 22:25
@brc-dd brc-dd dismissed stale reviews from Shinigami92 and ST-DDT via 0ed7ed7 October 27, 2022 12:56
ST-DDT
ST-DDT previously approved these changes Oct 27, 2022
docs/.vitepress/config.ts Outdated Show resolved Hide resolved
netlify.toml Outdated Show resolved Hide resolved
@ST-DDT
Copy link
Member

ST-DDT commented Oct 27, 2022

For some reason, this doesn't work for the next branch on netlify anymore.
Do you have an idea why?

EDIT: Nevermind. I closed it like 23h ago...

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.

Add banner to next.fakerjs.dev
3 participants