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

refactor(docusarus): docusaurus migration #612

Merged
merged 41 commits into from
Nov 4, 2020

Conversation

MatanBobi
Copy link
Member

@MatanBobi MatanBobi commented Sep 12, 2020

This is a WIP PR, some pages still don't work and I still didn't merge all changes from master due to some conflicts.

Open issues:

  • Build is broken
  • No sidebars on netlify preview
  • Fix CSS for both Dark Mode and Light mode + Tweak the colors to match the current colors
  • Update Footer to contain all links
  • Fix Layout for Help Page
  • Markdown isn't rendered in a GridBlock component as it used to
  • Blog link is missing from navigation
  • Extract the Showcase component and use it in both Users page and Home page
  • Blog sidebar is missing
  • Users page isn't working
  • Toggle users logos between dark and light mode and add a comment in docusaurus.config.js to add both darkImage and lightImage.
  • Use Tabs in MDX when needed
  • Update README
  • Fix broken links in existing markdown pages
  • Add @docusaurus/plugin-pwa for PWA and offline support
  • After all fixes, merge new docs from master
  • Review to see all docs are working and change them to MDX

Feel free to comment here with any problems you see in the preview that weren't mentioned above.

This PR will close #487

@MatanBobi MatanBobi changed the title refactor(docusarus): initial commit for docusaurus migration refactor(docusarus): docusaurus migration Sep 12, 2020
@MatanBobi
Copy link
Member Author

@nickmccurdy following your message here, as you can see since I didn't want to break the folder structure, we still have a website folder (ignore the website-old, this is just for me to compare some stuff).
Do you think we should pull the site to the root folder?

@MatanBobi MatanBobi closed this Sep 12, 2020
@MatanBobi MatanBobi reopened this Sep 12, 2020
@MatanBobi
Copy link
Member Author

MatanBobi commented Sep 14, 2020

@kentcdodds @alexkrolick
Wdyt we should do in dark mode with the users section? Most logos look bad in dark mode.

@kentcdodds
Copy link
Member

Maybe we can make sure that only those logos that look good in dark mode make it in the homepage. The others can just make the user's page look bad 😅🤷‍♂️

@MatanBobi
Copy link
Member Author

MatanBobi commented Sep 15, 2020

Maybe we can make sure that only those logos that look good in dark mode make it in the homepage. The others can just make the user's page look bad 😅🤷‍♂️

This will leave us with something like 6 in the main page 😅
We could ask in PR's to provide a dark logo and a light logo and switch between them I guess..
image

@kentcdodds
Copy link
Member

I think having fewer on the homeowner is fine actually. And asking for a light and dark themed version of the logo would probably be good too

@MatanBobi
Copy link
Member Author

@kentcdodds @alexkrolick this is basically ready, just waiting for your decision regarding the blog sidebar.
Once we decide on that, I'll merge the docs again :)

Thanks!

@kentcdodds
Copy link
Member

Let's do what's easiest for now and we can iterate later. 👍

@alexkrolick
Copy link
Collaborator

I noticed a few final issues to address before we merge:

  1. There seems to be a broken "Introduction" item in the Frameworks menu.
    image

  2. The Recipes and Docs top bar items can be highlighted at the same time

Screen Shot 2020-10-26 at 1 25 27 PM

  1. The primary color for links is not really legible in dark mode

Screen Shot 2020-10-26 at 1 26 45 PM

@MatanBobi
Copy link
Member Author

I noticed a few final issues to address before we merge:

  1. There seems to be a broken "Introduction" item in the Frameworks menu.
    image

  2. The Recipes and Docs top bar items can be highlighted at the same time

Screen Shot 2020-10-26 at 1 25 27 PM
  1. The primary color for links is not really legible in dark mode
Screen Shot 2020-10-26 at 1 26 45 PM

Thanks @alexkrolick ! Will fix, run sanity and ping here.

@MatanBobi
Copy link
Member Author

MatanBobi commented Oct 28, 2020

Hi @alexkrolick, I fixed all the issues and also found a way to add the blog sidebar :)
For the link color in dark mode, I've just set it to a lighter one but I'm not a UX expert so I hope it will look better.
I reviewed and things look good besides the images of the users on dark mode, I had a fix for that but then there was a change that randomizes the users on the front page so it got overriden, not sure it's that important though.
If you think it's ready for merge, I'll merge the latest docs (I want to do it as close as possible to the merge because it takes some time).

Another 2 questions, can we pull out the .vscode folder from the repo and add it to .gitignore? I'm not aware of any reason to keep it there.
Second, do we use the docker files somewhere? netlify.toml isn't using them and I didn't change the files but things still work properly..

@alexkrolick
Copy link
Collaborator

If you think it's ready for merge, I'll merge the latest docs (I want to do it as close as possible to the merge because it takes some time).

Looks good to me, let's do it

can we pull out the .vscode folder from the repo and add it to .gitignore? I'm not aware of any reason to keep it there.

Actually there is useful for stuff for working on the docs in there. Can you update the code snippet for code blocks to the MDX way of doing it, unless it is super obvious (in which case you can delete)? https://github.com/testing-library/testing-library-docs/blob/master/.vscode/markdown.code-snippets

Second, do we use the docker files somewhere? netlify.toml isn't using them and I didn't change the files but things still work properly..

This came with the Docusaurus template but if it's not used by Netlify we probably don't need it

@MatanBobi
Copy link
Member Author

MatanBobi commented Nov 1, 2020

Done @alexkrolick :)
Actually was cool to learn about adding the code snippets to vscode and I think that the tabs snippet can be helpful since it has some indentation and line breaks tricks.
I'm converting this from a draft PR to a PR.
Once we merge this, I'll create another issue with the open stuff.

@MatanBobi MatanBobi marked this pull request as ready for review November 1, 2020 17:13
@nickserv
Copy link
Member

nickserv commented Nov 2, 2020

@nickmccurdy following your message here, as you can see since I didn't want to break the folder structure, we still have a website folder (ignore the website-old, this is just for me to compare some stuff).
Do you think we should pull the site to the root folder?

@MatanBobi Yes, since that seems to be the convention for Docusaurus 2.

@MatanBobi
Copy link
Member Author

@nickmccurdy following your message here, as you can see since I didn't want to break the folder structure, we still have a website folder (ignore the website-old, this is just for me to compare some stuff).
Do you think we should pull the site to the root folder?

@MatanBobi Yes, since that seems to be the convention for Docusaurus 2.

@nickmccurdy Done :)

@alexkrolick
Copy link
Collaborator

@MatanBobi functionally, looks good.

What happened to the stripes? It's not critical, but looks a bit empty now layout-wise

Before

Screen Shot 2020-11-03 at 12 40 40 PM

After

Screen Shot 2020-11-03 at 12 39 36 PM

@MatanBobi
Copy link
Member Author

MatanBobi commented Nov 3, 2020

@alexkrolick I removed those because they didn't fit the styling in dark mode..
Fixed that :)

@alexkrolick
Copy link
Collaborator

Fantastic. Merging.

@alexkrolick alexkrolick merged commit d277da1 into testing-library:master Nov 4, 2020
@nickserv
Copy link
Member

nickserv commented Dec 8, 2020

@all-contributors add @MatanBobi for code

@allcontributors
Copy link
Contributor

@nickmccurdy

I've put up a pull request to add @MatanBobi! 🎉

@testing-library testing-library deleted a comment from allcontributors bot Dec 8, 2020
@MatanBobi MatanBobi removed the 🚧 work in progress Not ready, being worked on label Feb 17, 2023
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.

Migrate to Docusaurus v2
4 participants