[go: nahoru, domu]
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.

Sign up for GitHub

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

Jump to bottom

Add recipe to cookbook for 'Persist Data with Realm Database' #8233

Open
mongodben opened this issue Feb 9, 2023 · 8 comments
Open

Add recipe to cookbook for 'Persist Data with Realm Database' #8233

mongodben opened this issue Feb 9, 2023 · 8 comments
Labels
a.cookbook Relates to a cookbook recipe or guide e2-days Effort: < 5 days p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.data Data integrated into docs live

Comments

@mongodben
Copy link
mongodben commented Feb 9, 2023 •
edited
Loading

What information is missing?

Hello!

I'm a technical writer at MongoDB working on the docs for the Realm Flutter SDK.

Currently, the Recipes section of the Flutter docs does not have a page covering Realm Database. Realm Database is a SQLite alternative that recently went to general availability. Michael Thomsen wrote a blog post about Realm, which you can read here. A Realm Flutter SDK Engineer also appeared on the Observable Flutter show on Feb 23, 2023, which you can watch here.

I think it'd benefit the Flutter docs to have a recipe for a not SQLite-based local database like Realm. I envision the recipe looking similar to the Persist Data with SQLite recipe.

I also think it'd be appropriate to only have the recipe covering Realm Database, the open source project (not the freemium Device Sync and Atlas App Services functionality).

How would you like us to fix this problem?

I'd be happy to write the Realm Database recipe myself if the Flutter docs team is open to it.

Just let me know on this issue if you're interested, and I can start on a PR for it. I might have a few questions on your docs tool chain, but I can ask here, Discord, or another place of the team's preference.

Hope we can work on this together!
@danagbemava-nc danagbemava-nc added st.triage.triage-team Triage team reviewing and categorizing the issue p2-medium Necessary but not urgent concern. Resolve when possible. e2-days Effort: < 5 days and removed st.triage.triage-team Triage team reviewing and categorizing the issue labels Feb 10, 2023
@mongodben
Copy link
Author

hello @danagbemava-nc, any updates on this issue?

as indicated in the issue description, i'd be happy to work on this page if the flutter team is interested in including this content in the flutter docs.

@danagbemava-nc
Copy link
Member

Hi @mongodben, I believe this would be a fine addition to the docs and PRs are always welcome

cc @sfshaza2 for further insight

@mongodben
Copy link
Author

@sfshaza2, do you support this as well?

i just want to make sure that the docs team is open to the addition to the docs before i spend the time creating the documentation.

@sfshaza2
Copy link
Contributor

Hi, @mongodben! Actually, we don't want to offer docs every 3rd party package in our cookbook. That kind of thing is very difficult to maintain over time.

What I'd like to do is to add a new "Database support" page under "/development/data&backend/databases" that provides links to solutions. It could link to the sqlite package, as well as the cookbook recipe. It could also have a MongoDb section that links to the Flutter/MongoDb tutorial on your site, as well as Mit's article on Realm.

I'm not sure what other things it should also link to, but I think this makes the most sense.

Thoughts?

@mongodben
Copy link
Author

Hi, @mongodben! Actually, we don't want to offer docs every 3rd party package in our cookbook. That kind of thing is very difficult to maintain over time.

i understand, seems reasonable!

What I'd like to do is to add a new "Database support" page under "/development/data&backend/databases" that provides links to solutions. It could link to the sqlite package, as well as the cookbook recipe. It could also have a MongoDb section that links to the Flutter/MongoDb tutorial on your site, as well as Mit's article on Realm.

and i think a more index-style page like this makes a lot of sense as a long term solution. i'm of course biased toward realm, but could be a nice place to mention the different approaches.

i'd be happy to contribute to this page for the realm section if you'd like.

also, if the flutter team supports it, i wonder if realm would be a good candidate for the happy paths recommendations for structured local storage.

@sfshaza2
Copy link
Contributor

That would be great, @mongodben! So long as you don't mind my "red wedding" reviews. ;). Right now I'm REALLY hammered with work.

@sfshaza2
Copy link
Contributor

Oh, one more thing. Both Happy Paths and Flutter Favorites are on hiatus. I (believe) I added a note to both pages to say that. Since the PM who owned that left, we do have new PMs who want to take it on, but they have zero cycles in the foreseeable future.

@mongodben
Copy link
Author

That would be great, @mongodben! So long as you don't mind my "red wedding" reviews. ;). Right now I'm REALLY hammered with work.

thanks for the warning 😄. would you like me to start drafting that page, or wait for you to have a draft, and then i'll add the realm content.

Oh, one more thing. Both Happy Paths and Flutter Favorites are on hiatus. I (believe) I added a note to both pages to say that. Since the PM who owned that left, we do have new PMs who want to take it on, but they have zero cycles in the foreseeable future.

ah yes, see that now.

@atsansone atsansone added the a.cookbook Relates to a cookbook recipe or guide label May 17, 2023
@atsansone atsansone added t.data Data integrated into docs live st.triage.ltw Indicates Lead Tech Writer has triaged labels May 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
a.cookbook Relates to a cookbook recipe or guide e2-days Effort: < 5 days p2-medium Necessary but not urgent concern. Resolve when possible. st.triage.ltw Indicates Lead Tech Writer has triaged t.data Data integrated into docs live
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
4 participants
@atsansone @sfshaza2 @danagbemava-nc @mongodben