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 how-to for storing state #1534

Merged

Conversation

tonyandrewmeyer
Copy link
Contributor

This continues the previous work in moving chapters of the tutorial to how-to guides.

The how-to guide covers:

  • Storing state with StoredState objects
  • Storing state in a peer relation

Minor tweaks are also made to the "stored state uses and limitations" explanation doc, to which the how-to links.

Copy link
Contributor

@james-garner-canonical james-garner-canonical left a comment

Choose a reason for hiding this comment

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

I've given this a read through and it looks good. I guess there will be corresponding PR(s) on the tutorial itself eventually too?


Note: The test failure is unrelated to this PR.

@tonyandrewmeyer
Copy link
Contributor Author

I guess there will be corresponding PR(s) on the tutorial itself eventually too?

Yes, e.g. #1511

Copy link
Contributor

@dwilding dwilding left a comment

Choose a reason for hiding this comment

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

It's good to me, thanks Tony! I added one minor comment about a link.

@dwilding
Copy link
Contributor

@tonyandrewmeyer I was just speaking with Dora and she mentioned that she's ready to come and update the links to point to new locations for Juju and Charmcraft docs. So maybe it would be better to leave the links in the source for now, to make that job easier?

@tonyandrewmeyer
Copy link
Contributor Author

tonyandrewmeyer commented Jan 21, 2025

@tonyandrewmeyer I was just speaking with Dora and she mentioned that she's ready to come and update the links to point to new locations for Juju and Charmcraft docs. So maybe it would be better to leave the links in the source for now, to make that job easier?

The other "update links" comments were ones that Dora added, so I think that making them like this makes it easier for her to find and update them all. 🤞

@tonyandrewmeyer tonyandrewmeyer merged commit c487840 into canonical:main Jan 22, 2025
31 of 32 checks passed
@tonyandrewmeyer tonyandrewmeyer deleted the docs-how-to-store-state branch January 22, 2025 23:10
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.

3 participants