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

docs: add best practice page #7541

Closed

Conversation

mtrezza
Copy link
Member

@mtrezza mtrezza commented Sep 2, 2021

New Pull Request Checklist

Issue Description

Related issue: #7540

Approach

Add best practice page.

This PR is just to add a page so others can extend it. It does not claim to be complete by any means.

There is an extensive list of optimizations in the forum, but a forum post is likely to become harder to find and partially obsolete over time, so these would be easy candidates to be added to this page:
https://community.parseplatform.org/t/share-your-performance-tips/1572/

TODOs before merging

  • Add entry to changelog
  • Add changes to documentation (guides, repository pages, in-code descriptions)

@mtrezza mtrezza requested review from davimacedo and dblythy and removed request for davimacedo September 2, 2021 14:52
@codecov
Copy link

codecov bot commented Sep 2, 2021

Codecov Report

Merging #7541 (4e70e7b) into master (6ad3e6f) will decrease coverage by 0.00%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #7541      +/-   ##
==========================================
- Coverage   93.93%   93.92%   -0.01%     
==========================================
  Files         181      181              
  Lines       13279    13279              
==========================================
- Hits        12473    12472       -1     
- Misses        806      807       +1     
Impacted Files Coverage Δ
src/RestWrite.js 93.94% <0.00%> (-0.16%) ⬇️

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 6ad3e6f...4e70e7b. Read the comment docs.

@dblythy
Copy link
Member

dblythy commented Sep 2, 2021

Nice work on this PR @mtrezza!

Whilst I support the idea of a centralized location for best practices, I'm not sure if the GitHub repo is the one. In my opinion, this resouce (as well as many of the GitHub resources), would be best centralized on the docs site. I feel as though this would be the location where it would be most accessed.

@mtrezza
Copy link
Member Author

mtrezza commented Sep 2, 2021

You are absolutely right, that should go into the docs repo.

@mtrezza
Copy link
Member Author

mtrezza commented Sep 2, 2021

replaced by parse-community/docs#845

@mtrezza mtrezza closed this Sep 2, 2021
@mtrezza mtrezza deleted the add-best-practice-page branch September 2, 2021 17:43
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.

None yet

2 participants