-
-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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
Simplify README and transition content to docs.parseplatform.org #7108
Conversation
Codecov Report
@@ Coverage Diff @@
## master #7108 +/- ##
==========================================
- Coverage 93.67% 93.66% -0.01%
==========================================
Files 169 169
Lines 12508 12508
==========================================
- Hits 11717 11716 -1
- Misses 791 792 +1
Continue to review full report at Codecov.
|
- [Sponsors](#sponsors) | ||
- [Backers](#backers) | ||
|
||
The full documentation for Parse Server is available [here](https://docs.parseplatform.org/parse-server/guide/). An [API reference](http://parseplatform.org/parse-server/api/) and [Cloud Code guide](https://docs.parseplatform.org/cloudcode/guide/) are also available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
May be we can have a detailed redirection system like
Documentation:
- [Home](https://parseplatform.org/)
- [Get started](https://docs.parseplatform.org/parse-server/guide/)
- [GraphQL](https://docs.parseplatform.org/graphql/guide/)
- etc...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the suggestion. I'll make this change once the docs site is finalised!
The As it's in the license, we might as well remove the last sentence...
|
I'm not sure about having the whole introduction to using the REST API. If we are to remove the GraphQL section it would seem consistent to remove the REST part. I imagine most people use an SDK as their first/main way to interact with their server and it gets in the way of the info on the Express setup. The one benefit I see is that it allows people to get an idea of how simple/powerful Parse Server is without having to delve into a guide and perhaps nice for quickly testing it out. The importance, if any, this represents is difficult to know. |
Agree, I feel as though the SDKs are a really attractive feature of Parse, although I think the REST API bit is just so developers can see things happening without needing to install anything else. Maybe instead we could include some example JS in serverStartComplete? |
Maybe some inspiration from the Parse Server Getting Started section helps? The Parse Server repo is likely the main entry point for most developers and likely most have a use case in mind using an SDK, like Tom said. For a developer to set up a simple proof of concept with Parse Server they need to:
Since this is the Parse Server repo, it could focus on a) and provide a link list for b) to the SDK docs:
|
Co-authored-by: Tom Fox <[email protected]>
I like the suggestion, but with the introduction of Default ACL, the example REST guide will become invalidated (as objects will no longer have default Public Read). Also, should this:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apologies for the delay on this one. Just one change from me.
I think this will be a significant improvement.
Co-authored-by: Tom Fox <[email protected]>
Sorry @TomWFox. I'll try get to your suggestions this week. |
## Learning more | ||
|
||
The [Parse GraphQL Guide](http://docs.parseplatform.org/graphql/guide/) is a very good source for learning how to use the Parse GraphQL API. | ||
For more information as to how to configure your Parse Server, [check out our Parse Server guide.](https://docs.parseplatform.org/parse-server/guide/#usage) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For more information as to how to configure your Parse Server, [check out our Parse Server guide.](https://docs.parseplatform.org/parse-server/guide/#usage) | |
For more information as to how to configure your Parse Server, [check out our Parse Server guide](https://docs.parseplatform.org/parse-server/guide/#usage). |
|
Closing as too many conflicts with the newer README |
New Pull Request Checklist
Issue Description
Depending on this PR in the docs repo to update Parse Server guide to be more exhaustive than the README.md.
Related issue: 808