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 Update: Minor Styling and Fixes #22

Merged
merged 17 commits into from
Feb 24, 2022

Conversation

MutableLoss
Copy link
Contributor

@MutableLoss MutableLoss commented Sep 1, 2021

Here is the PR for the minor fixes to the RF Docs site addressing a lot of various issues experienced on the site.

Current List of Applied Fixes (September 1st):

  • updated sponsor div's class in 8.2.2 docs, as old class was bubbling the flex-direction to elements setting to 'row' : Example
  • links in 4.2.0 documentation to point to the redux-form repo when referencing 4.2.0 docs, and all legacy docs still pointing to old repo : Example: "Documentation" Links
  • replace codefund ads with Ethical Ads*
  • Github button was causing the topBar to be cut off on smaller screens : Example: View in screen less than 920px
  • Updated 8.3.0 example links to point to 8.3.0 docs instead of 8.2.2 : Example: "Example" link at bottom

*Only set on 8.2.2 for now. Want to confirm this is expected fix before updating others.

Additional Fixes (September 2nd):

  • updated the rest of the ads
  • fixed all of the doc links for 4.2.0 - 5.3.6 (pre-6.0.0 versions)
  • updated all the release note links to point to their versions using the new username
  • fixed the Github Buttons, so they show the total stars/forks : Example
  • update links to new issues to point to new username
  • Updated all of the GH links for the 8.x.x versions

On the Chopping Block:
- Updating the rest of the Ads

  • Update documentation links on the pre-6.0.0 version to point to correct docs (like with 4.2.0)

Just fyi, I have been updating the styling in the redux-form/redux-form-website-template as well, but wanted to wait to finish the updates before creating that PR. 👍

Related PRs:

Styling updates for site bundles and future versions: Redux-Form-Website-Template Update

Minor Update to Version Checker: Redux-Form-Doc-Version-Checker

A few questions regarding updates on my end:

  1. You can view the update in any of the result in the 8.2.2 indices to see the Ad replacement, basically taking the ethical Ad setup from 8.3.0, and mirroring it. Is this how you want the rest of the ads replaced?
  2. Regarding the sponsored Ads, do you want the Form Nerd Ads to replace the triplebyte ads?

@erikras
Copy link
Member

erikras commented Sep 2, 2021

This all looks great! Thank you!

@MutableLoss
Copy link
Contributor Author

Sure thing, and glad to help! I think I'm going to finally call it done. Here's what was added:

  • updated the rest of the ads
  • fixed all of the doc links for 4.2.0 - 5.3.6 (pre-6.0.0 versions)
  • updated all the release note links to point to their versions using the new username
  • fixed the Github Buttons, so they show the total stars/forks
  • fixed the links to new issues
  • Updated all of the GH links for the 8.x.x versions*

*I left the rest of the GH links as-is since it redirected to the new username, and just updating the HTML files was going to be an additional 900+ file changes

Most styling updates were fixed using the existing classes in the bundle, but as you probably know, the responsive styling issues won't update until the CDN css has been updated. Here's the PR for the template which has those fixes:

Redux-Form-Website-Template Update

There was also an issue with the version checker styling. With the flex-direction fix, it ended up hidden by the topNav on small screens. Here's a PR for that too : Example

Redux-Form-Doc-Version-Checker

There is still one remaining console error I didn't dive into, but wanted to at least mention. For versions 6.0.1 - 8.3.0 there is a "missing hydrate function" error. (Example) I'm not sure when the React team moved "renderToStaticMarkup" to the separate ReactDOMServer package, but since the RF site uses 15.6 for all versions, I wondered if that is somehow related.

@MutableLoss MutableLoss changed the title Docs Update: Minor Styling and Fixes == WIP == Docs Update: Minor Styling and Fixes Sep 2, 2021
@MutableLoss
Copy link
Contributor Author

@erikras Sorry, I didn't realize how huge this PR became, but I did want to make sure, you're not waiting on me for anything here. Do I need to make sure to fix those http links, so the mixed content check passes?

If there anything I can do to make the review process easier, please ket me know. 👍

@erikras erikras merged commit d2462be into redux-form:master Feb 24, 2022
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.

2 participants