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

Add doc page on Redis #1015

Merged
merged 24 commits into from
Sep 26, 2024
Merged

Add doc page on Redis #1015

merged 24 commits into from
Sep 26, 2024

Conversation

victorlin
Copy link
Member

@victorlin victorlin commented Sep 5, 2024

preview

Description of proposed changes

Docs used for 6.2 → 7.2 upgrade. Reflects lessons learned from the 2 upgrades that have been done so far.

Checklist

  • Checks pass
  • Convert to RST
  • Doc page preview looks good
  • Do the 6.2 → 7.2 upgrade and update PR contents with any new findings
  • Check if changes affect the resource index JSON revision

Start by moving the existing content from the infrastructure page.
Make this distinctively about minor maintenance tasks and set
expectations.
The rename is apparent on the add-on page, presumably because of the
shift to using Valkey with version 7.2.¹

¹ https://devcenter.heroku.com/changelog-items/2918
Reduce the amount of first-person wording which made sense for the note
form, but not so much in a proper guide.
This can be detected automatically. The same can likely be done with the
new instance name (to replace redis-X-N), but I don't want to create a
new instance to test this at the moment.
@victorlin victorlin self-assigned this Sep 5, 2024
@nextstrain-bot nextstrain-bot temporarily deployed to nextstrain-s-victorlin--pt6y6j September 5, 2024 21:40 Inactive
@victorlin victorlin temporarily deployed to nextstrain-s-victorlin--pt6y6j September 5, 2024 21:51 Inactive
@victorlin
Copy link
Member Author

victorlin commented Sep 5, 2024

Not ready to be merged, but the content (GitHub preview) is ready for review.

I'll wait until after doing the 6.2→7.2 upgrade to see if there are any additional details to include before merging.

@victorlin victorlin requested a review from tsibley September 5, 2024 21:52
@victorlin victorlin temporarily deployed to nextstrain-s-victorlin--pt6y6j September 5, 2024 21:58 Inactive
Copy link
Member

@tsibley tsibley left a comment

Choose a reason for hiding this comment

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

A few minor suggestions, none blocking. Thanks for doing this work!

+1 from me for converting to rST and cleaning it up for rendering on RTD too.

docs/redis.md Outdated Show resolved Hide resolved
docs/redis.md Outdated Show resolved Hide resolved
docs/redis.md Outdated Show resolved Hide resolved
This is necessary to test session restoration.
rST is our standard doc format; Markdown is the legacy format.

Initial conversion performed with:

    pandoc -f markdown-smart --shift-heading-level-by -1 -t rst-smart docs/redis.md > docs/redis.rst

and then I hand reviewed and made additional edits.
@victorlin victorlin marked this pull request as ready for review September 25, 2024 19:40
@victorlin victorlin requested a review from tsibley September 25, 2024 19:40
docs/redis.rst Outdated Show resolved Hide resolved
@victorlin victorlin merged commit ee79330 into master Sep 26, 2024
4 checks passed
@victorlin victorlin deleted the victorlin/redis-docs branch September 26, 2024 18:17
@victorlin victorlin mentioned this pull request Sep 26, 2024
2 tasks
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.

4 participants