Skip to content

Add note in docs linking to local datastore issue #1044

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

Merged
merged 1 commit into from
Jul 26, 2021
Merged

Add note in docs linking to local datastore issue #1044

merged 1 commit into from
Jul 26, 2021

Conversation

Jawnnypoo
Copy link
Member

It is important for SDK users to understand the drawbacks of using Local Datastore when using the SDK. I think that we need to have a link to the open issue directly in the docs, so there are no surprises for users once they go down the route of using local datastore in their project. #279

@Jawnnypoo Jawnnypoo requested a review from mtrezza July 6, 2020 07:54
@mtrezza
Copy link
Member

mtrezza commented Jul 6, 2020

@TomWFox As the "docs expert", what is your opinion on linking Github issues directly in the docs? Anything we should consider? Or should we rather extract the gist from the issue discussion and add that to the docs, so people don't have to read through the whole issue thread (which may contain incorrect comments and presumptions from non-team members) and we keep the docs concise?

@TomWFox
Copy link
Contributor

TomWFox commented Jul 6, 2020

Seems like a good idea, probably for the iOS guide too.

I would say extracting the key points for the docs would be preferable but you could also provide a link for those who want to see the whole thread.

@mtrezza
Copy link
Member

mtrezza commented Jul 6, 2020

@Jawnnypoo Do you think you could just briefly mention the key issue with the local datastore in the docs, in addition to the issue link?

@mtrezza
Copy link
Member

mtrezza commented Jul 6, 2020

I can then open an iOS PR to add the same comment there (if the same problem exists), thanks @TomWFox for suggesting.

@mtrezza mtrezza merged commit 358a5b7 into parse-community:master Jul 26, 2021
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