Overhaul of Parse Server Guide by dblythy · Pull Request #809 · parse-community/docs

dblythy · 2021-01-04T13:17:31Z

This PR is intended to replace the README of the Parse Server repo, ensuring that all documentation is in one place.

I personally think that the README of the Parse Server repo should be stripped back to capture what Parse Server is about in a few lines, and then point to the docs for the most updated references.

Not sure if we want the contributors / sponsors on the site as well - I think it's a nice touch.

Closes#808

dblythy · 2021-01-31T14:55:40Z

Any further comments around this PR @TomWFox 😊

…rverGuide

TomWFox · 2021-02-01T18:02:49Z

I kind of thought I'd submitted a review on this but clearly not, it's still pending!

dblythy · 2021-02-01T18:08:03Z

No worries @TomWFox. No rush at all. If you have bulk changes suggested I can happily share my branch with you.

TomWFox

Thats what I've got so far...

Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

…rverGuide

This reverts commit db0fd81.

Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

dblythy · 2021-02-10T17:01:38Z

Before merging, I'll have to go back through again and add changes to the GitHub readme, such as Localization.

TomWFox · 2021-02-10T22:26:27Z

I have looked it all over now so we're getting there 😀

Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

dblythy · 2021-02-11T00:48:13Z

I've added Localization but I couldn't get the table to format. Are markdown tables supported or do we need to reformat?

mtrezza · 2021-02-11T01:26:20Z

Keep the empty lines before and after the table. Empty lines are missing at many places of the Localization part that you pasted. Try to keep the content and copy/paste without much modification, because empty lines are important in MD.

dblythy · 2021-02-11T01:34:48Z

Thanks! My mac must have removed them in the copy/paste bc I don't think I deliberately removed them.

Anyway, here's how the table looks now. Any ideas as to how to optimize?

mtrezza · 2021-02-11T01:41:50Z

Table formatting for the GitHub MD interpreter is a topic on its own - but it's possible. If you're interested, see here why.

TomWFox · 2021-02-11T11:04:25Z

Markdown tables are not fun, learnt that the hard way!

Edit: feel free to play around with it but my guess is that a different format will work best here

mtrezza · 2021-02-11T14:31:06Z

I agree with different format, like in the API docs. I also think this would be better placed in the docs than in the README.

TomWFox · 2021-02-12T00:40:05Z

Is this ready for another review?

dblythy · 2021-02-12T00:42:42Z

Yes plz 👍

TomWFox

Just a few wee bits...

TomWFox · 2021-02-13T18:10:41Z

-
-| Parameter | Optional | Type | Default value | Example values | Environment variable | Description |
-|----------------------------|----------|-----------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `idempotencyOptions` | yes | `Object` | `undefined` | | PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_OPTIONS | Setting this enables idempotency enforcement for the specified paths. |
-| `idempotencyOptions.paths` | yes | `Array<String>` | `[]` | `.*` (all paths, includes the examples below), <br>`functions/.*` (all functions), <br>`jobs/.*` (all jobs), <br>`classes/.*` (all classes), <br>`functions/.*` (all functions), <br>`users` (user creation / update), <br>`installations` (installation creation / update) | PARSE_SERVER_EXPERIMENTAL_IDEMPOTENCY_PATHS | An array of path patterns that have to match the request path for request deduplication to be enabled. The mount path must not be included, for example to match the request path `/parse/functions/myFunction` specifiy the path pattern `functions/myFunction`. A trailing slash of the request path is ignored, for example the path pattern `functions/myFunction` matches both `/parse/functions/myFunction` and `/parse/functions/myFunction/`. |


So we have lost some of the extra info provided in this table.
@mtrezza you're better placed to comment on the importance of this

There have been no changes to the feature, the table's content should remain.

Maybe hold off addressing this until #809 (comment) has been resolved

mtrezza

Good restructuring, just some formatting...

mtrezza · 2021-02-13T18:20:22Z

+
+The following parameter and placeholder keys are reserved because they are used related to features such as password reset or email verification. They should not be used as translation keys in the JSON resource or as manually defined placeholder keys in the configuration: `appId`, `appName`, `email`, `error`, `locale`, `publicServerUrl`, `token`, `username`.
+
+### Parameters


Not in favor of this format, IMO harder to read than the table. Can we find something better visually structured? Edit: I am referring to the "Parameters" paragraph.

Potentially naive question - is this something that is or can be documented in the api reference?

mtrezza · 2021-02-13T18:21:52Z

@@ -0,0 +1,9 @@
+# Want to ride the bleeding edge?


Do we really need an extra page for 1 sentence?

We could perhaps remove this entirely as it's 'how to use npm packages' info rather than 'how to use Parse Server'.
Anyone that doesn't know about how to use the master branch before reading this probably shouldn't be anyway.

dblythy added 2 commits January 5, 2021 00:11

update server guide
8cb0260

Update experimental.md
db64ac4

dblythy mentioned this pull request Jan 4, 2021
Simplify README and transition content to docs.parseplatform.org parse-community/parse-server#7108
Closed
2 tasks

TomWFox reviewed Jan 4, 2021
View reviewed changes

Comment thread_includes/parse-server/adapters.md Outdated

Update usage.md
1997c9c

dblythy added 2 commits February 1, 2021 12:33

include config and security
1a32324

Merge branch 'serverGuide' ofhttps://github.com/dblythy/docsinto se…
2675ada
…rverGuide

TomWFox suggested changes Feb 1, 2021
View reviewed changes

dblythyand others added 11 commits February 2, 2021 11:57

Update _includes/parse-server/adapters.md
0e4e3c0
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/parse-server/bleeding-edge.md
769c845
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/parse-server/experimental.md
1287301
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/parse-server/experimental.md
dc9d002
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/parse-server/logging.md
7e3dc71
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/parse-server/logging.md
15947a7
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

update
db0fd81

Merge branch 'serverGuide' ofhttps://github.com/dblythy/docsinto se…
4ae08b3
…rverGuide

Revert "update"
f44eb1c
This reverts commit db0fd81.

recommit
10a3a45

Update _includes/parse-server/logging.md
d1b34ce
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

TomWFox added 4 commits February 10, 2021 20:45

fix formatting
4b912f6

reordering email section & nits
eb715a3

nits
eec4cdb

nit
e7437c3

TomWFox suggested changes Feb 10, 2021
View reviewed changes

Comment thread_includes/parse-server/experimental.md Outdated

remove migration guide contents
198c568

dblythyand others added 3 commits February 11, 2021 11:35

Update _includes/parse-server/experimental.md
6e843fc
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

Update _includes/common/security.md
2369495
Co-authored-by: Tom Fox <13188249+TomWFox@users.noreply.github.com>

add localization
6c6f032

Update experimental.md
93c1902

Update experimental.md
b4cfa74

TomWFox suggested changes Feb 13, 2021
View reviewed changes

TomWFox reviewed Feb 13, 2021
View reviewed changes

mtrezza requested changes Feb 13, 2021
View reviewed changes

Comment thread_includes/parse-server/experimental.md Outdated
Comment thread_includes/parse-server/experimental.md Outdated

TomWFox added 3 commits May 26, 2021 11:35

Apply suggestions from code review
859b535

improve experimental note
ed55f5d

improve direct access explanation
9ba83e9


		The following parameter and placeholder keys are reserved because they are used related to features such as password reset or email verification. They should not be used as translation keys in the JSON resource or as manually defined placeholder keys in the configuration: `appId`, `appName`, `email`, `error`, `locale`, `publicServerUrl`, `token`, `username`.

		### Parameters

Uh oh!

Uh oh!

Conversation

dblythy commented Jan 4, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

dblythy commented Jan 31, 2021

Uh oh!

TomWFox commented Feb 1, 2021

Uh oh!

dblythy commented Feb 1, 2021

Uh oh!

TomWFox left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dblythy commented Feb 10, 2021

Uh oh!

Uh oh!

TomWFox commented Feb 10, 2021

Uh oh!

dblythy commented Feb 11, 2021

Uh oh!

mtrezza commented Feb 11, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dblythy commented Feb 11, 2021

Uh oh!

mtrezza commented Feb 11, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

TomWFox commented Feb 11, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mtrezza commented Feb 11, 2021

Uh oh!

TomWFox commented Feb 12, 2021

Uh oh!

dblythy commented Feb 12, 2021

Uh oh!

TomWFox left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

TomWFoxFeb 13, 2021

Choose a reason for hiding this comment

Uh oh!

mtrezzaFeb 13, 2021

Choose a reason for hiding this comment

Uh oh!

TomWFoxFeb 13, 2021

Choose a reason for hiding this comment

Uh oh!

mtrezza left a comment

Choose a reason for hiding this comment

Uh oh!

mtrezzaFeb 13, 2021• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

TomWFoxMay 26, 2021

Choose a reason for hiding this comment

Uh oh!

mtrezzaFeb 13, 2021

Choose a reason for hiding this comment

Uh oh!

dblythy commented Jan 4, 2021•
edited
Loading

mtrezza commented Feb 11, 2021•
edited
Loading

mtrezza commented Feb 11, 2021•
edited
Loading

TomWFox commented Feb 11, 2021•
edited
Loading

mtrezzaFeb 13, 2021•
edited
Loading