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

Remove duplicate docs #420

Open
4 tasks done
mtrezza opened this issue Sep 28, 2022 · 4 comments
Open
4 tasks done

Remove duplicate docs #420

mtrezza opened this issue Sep 28, 2022 · 4 comments
Labels
bounty:$10 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README

Comments

@mtrezza
Copy link
Member

mtrezza commented Sep 28, 2022

New Issue Checklist

Issue Description

The docs here contain a lot of copy/paste from the Parse Server repo. This makes the docs difficult to maintain, as info needs be kept in sync. In addition, the copied info is sometimes truncated, which may case misunderstandings and provides less value than the original longer and more detailed docs.

Common docs that are referenced across Parse Platform repos may be best kept in a separate repo, but we currently don't have such a repo, other than maybe the governance repo. Until we have such a common repo or find another approach, individual repos should only reference the docs in the Parse Server repo, not duplicate their information.

Steps to reproduce

For example compare:

Actual Outcome

n/a

Expected Outcome

n/a

Environment

n/a

@parse-github-assistant
Copy link

parse-github-assistant bot commented Sep 28, 2022

Thanks for opening this issue!

  • 🚀 You can help us to fix this issue faster by opening a pull request with a failing test. See our Contribution Guide for how to make a pull request, or read our New Contributor's Guide if this is your first time contributing.

@mtrezza mtrezza added the type:docs Only change in the docs or README label Sep 28, 2022
@mtrezza
Copy link
Member Author

mtrezza commented Sep 28, 2022

@cbaker6 Do you have a suggestion on how to solve this? Otherwise I would just remove the duplicate parts.

Off topic: The GitHub About section of this repo reads (I rephrased it recently):

The Swift SDK for Parse Platform (iOS, macOS, watchOS, tvOS, Linux, Android)

Are there any docs about how to use the Parse Swift SDK in Android?

@cbaker6
Copy link
Contributor

cbaker6 commented Sep 28, 2022

Otherwise I would just remove the duplicate parts.

duplicate parts can be removed and/or linked to the server document

Are there any docs about how to use the Parse Swift SDK in Android?

“Windows” needs to be added to this section… There are no docs needed to use for Android or any other OS as they all use SPM. Anyone building swift on another platform should know SPM is available. Any other requirement for other OS’s are in the API docs.

@mtrezza
Copy link
Member Author

mtrezza commented Sep 28, 2022

“Windows” needs to be added to this section

added

duplicate parts can be removed and/or linked to the server document

ok

@mtrezza mtrezza added the bounty:$10 Bounty applies for fixing this issue (Parse Bounty Program) label Nov 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bounty:$10 Bounty applies for fixing this issue (Parse Bounty Program) type:docs Only change in the docs or README
Projects
None yet
Development

No branches or pull requests

2 participants