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

Refresh python requirements and add instructions #238

Merged
merged 3 commits into from
May 23, 2024

Conversation

chiphogg
Copy link
Contributor

It's been a while since we updated requirements_lock.txt, and we've
accumulated four Dependabot alerts (7, 8, 9, and 10). I took the
opportunity to write down all the steps we should take when doing this
update. Naturally, I also performed all of those steps.

For the A/B website comparison, I found 3 differences:

  • Menu alignment has been tweaked on a few pages to reduce word wrapping
  • Tab headers are underlined
  • Mermaid diagram arrowheads are thicker

For testing mike, the suggested workflow actually caught some breaking
changes for our monkey patch code. I therefore made the first step to
simply directly check the patched APIs.

The new version of mkdocs now warns about anchors, and it caught an
incorrect anchor in a recent doc update. I've fixed that as well.

It's been a while since we updated `requirements_lock.txt`, and we've
accumulated four Dependabot alerts (7, 8, 9, and 10).  I took the
opportunity to write down all the steps we should take when doing this
update.  Naturally, I also performed all of those steps.

For the A/B website comparison, I found 3 differences:

- Menu alignment has been tweaked on a few pages to reduce word wrapping
- Tab headers are underlined
- Mermaid diagram arrowheads are thicker

For testing `mike`, the suggested workflow actually caught some breaking
changes for our monkey patch code.  I therefore made the first step to
simply directly check the patched APIs.

The new version of mkdocs now warns about anchors, and it caught an
incorrect anchor in a recent doc update.  I've fixed that as well.
@chiphogg chiphogg added release notes: ⚙️ repo PR affecting the way the repository works release notes: 📝 documentation PR affecting library documentation labels May 22, 2024
@chiphogg chiphogg requested a review from geoffviola May 22, 2024 21:27
Copy link
Contributor

@geoffviola geoffviola left a comment

Choose a reason for hiding this comment

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

I ran through the instructions. The docs still look good. Thanks for the updates!

chiphogg added 2 commits May 23, 2024 08:41
The point is to try to re-trigger the webhook for the CLA.
This reverts commit 1871209.
@chiphogg chiphogg merged commit 221d8f4 into main May 23, 2024
10 checks passed
@chiphogg chiphogg deleted the chiphogg/requirements-7-8-9-10 branch May 23, 2024 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: 📝 documentation PR affecting library documentation release notes: ⚙️ repo PR affecting the way the repository works
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants