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

Simplify README and transition content to docs.parseplatform.org #7108

Closed
wants to merge 5 commits into from

Conversation

dblythy
Copy link
Member

@dblythy dblythy commented Jan 4, 2021

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

@codecov
Copy link

codecov bot commented Jan 4, 2021

Codecov Report

Merging #7108 (ee51950) into master (16b4aad) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            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     
Impacted Files Coverage Δ
src/RestWrite.js 93.67% <0.00%> (-0.17%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 16b4aad...ef1606a. Read the comment docs.

- [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.
Copy link
Member

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...

Copy link
Member Author

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!

@TomWFox
Copy link
Contributor

TomWFox commented Jan 5, 2021

The fileKey option should be removed as it is option and only required for an advanced feature.

As it's in the license, we might as well remove the last sentence...

As of April 5, 2017, Parse, LLC has transferred this code to the parse-community organization, and will no longer be contributing to or distributing this code.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@TomWFox
Copy link
Contributor

TomWFox commented Jan 5, 2021

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.

What do you think? cc @mtrezza @Moumouls

@dblythy
Copy link
Member Author

dblythy commented Jan 6, 2021

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?

@mtrezza
Copy link
Member

mtrezza commented Jan 6, 2021

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:

  • a) Get Parse Server running
  • b) Implement an SDK with some sample code

Since this is the Parse Server repo, it could focus on a) and provide a link list for b) to the SDK docs:

Getting started with:

  • JavaScript SDK
  • Android SDK
  • ...

Co-authored-by: Tom Fox <[email protected]>
@dblythy
Copy link
Member Author

dblythy commented Jan 6, 2021

Maybe some inspiration from the Parse Server Getting Started section helps?

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:

serverStartComplete : function() {
  console.log('parse-server-example running on port 1337.');
}
app.listen(1337, function() {
  console.log('parse-server-example running on port 1337.');
});

Copy link
Contributor

@TomWFox TomWFox left a 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.

README.md Outdated Show resolved Hide resolved
Co-authored-by: Tom Fox <[email protected]>
@dblythy
Copy link
Member Author

dblythy commented Jan 31, 2021

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)
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
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).

@mtrezza
Copy link
Member

mtrezza commented Sep 3, 2021

⚠️ Important change for merging PRs from Parse Server 5.0 onwards!

We are planning to release the first beta version of Parse Server 5.0 in October 2021.

If a PR contains a breaking change and is not merged before the beta release of Parse Server 5.0, it cannot be merged until the end of 2022. Instead it has to follow the Deprecation Policy and phase-in breaking changes to be merged during the course of 2022.

One of the most voiced community feedbacks was the demand for predictability in breaking changes to make it easy to upgrade Parse Server. We have made a first step towards this by introducing the Deprecation Policy in February 2021 that assists to phase-in breaking changes, giving developers time to adapt. We will follow-up with the introduction of Release Automation and a branch model that will allow breaking changes only with a new major release, scheduled for the beginning of each calendar year.

We understand that some PRs are a long time in the making and we very much appreciate your contribution. We want to make it easy for PRs that contain a breaking change and were created before the introduction of the Deprecation Policy. These PRs can be merged with a breaking change without being phased-in before the beta release of Parse Server 5.0. We are making this exception because we appreciate that this is a time of transition that requires additional effort from contributors to adapt. We encourage everyone to prepare their PRs until the end of September and account for review time and possible adaptions.

If a PR contains a breaking change and should be merged before the beta release, please mention @parse-community/server-maintenance and we will coordinate with you to merge the PR.

Thanks for your contribution and support during this transition to Parse Server release automation!

@dblythy
Copy link
Member Author

dblythy commented Sep 8, 2021

Closing as too many conflicts with the newer README

@dblythy dblythy closed this Sep 8, 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.

4 participants