Skip to content

Commit d61b9db

Browse files
committed
Merge commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1' into gh-pages
* commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1': (84 commits) Add `cascadeSave` option in ParseObject to JS docs (parse-community#664) Update apple sign in documentation (parse-community#662) Bump mixin-deep from 1.3.1 to 1.3.2 (parse-community#670) Update GraphQL docs with latest changes (parse-community#669) remove a bunch of parse cloud references (parse-community#654) docs: fixed examples for pipeline in aggregation (parse-community#661) Add beta notice to the GraphQL Guide (parse-community#659) iOS Documentation Revamp (parse-community#650) Fix doc for creating a subscription in javascript (parse-community#658) GraphQL Customisation (parse-community#652) added PhantAuth authData docs (parse-community#655) Fix typo in keys.md (parse-community#656) Fix typo in cloud-code.md (parse-community#657) add reference to afterFind, add more detail on predefined classes (parse-community#653) Add `keys` and `excludeKeys` options to REST docs (parse-community#649) document push type and priority keys for notifications (parse-community#639) Documentation for Sign In With Apple (parse-community#648) Documentation for isDataAvailable (parse-community#647) Remove line for 3.x (parse-community#646) Add documentation for query.withCount (parse-community#645) ...
2 parents 91a5a9b + e129790 commit d61b9db

File tree

104 files changed

+2976
-1396
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

104 files changed

+2976
-1396
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: "\U0001F41B Bug report"
3+
about: Create a report to help us improve
4+
title: "\U0001F41B "
5+
labels: Bug
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: "\U0001F4D9 Docs fix/improvement report"
3+
about: Bring attention to an area of the docs with code samples that need updating
4+
or wording that could be improved
5+
title: "\U0001F4D9 "
6+
labels: Documentation Improvement
7+
assignees: ''
8+
9+
---
10+
11+
__Link to section:__
12+
Please provide a specific link to the section in question. In the docs, you can click on a heading and then copy the relative link from the address bar.
13+
14+
__What is the issue?__
15+
Please provide a detailed explanation of the problem, quoting parts of the docs or using screenshots if appropriate.
16+
17+
__Can you propose a solution?__
18+
What changes do you think should be made? Have you considered multiple solutions? Will this be suitable for all use cases?
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: "\U0001F4A1 Feature request"
3+
about: Suggest an idea for this project
4+
title: "\U0001F4A1 "
5+
labels: Feature
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
name: "\U0001F4D5 Missing content"
3+
about: Bring attention to features that are undocumented
4+
title: "\U0001F4D5"
5+
labels: Missing Content
6+
assignees: ''
7+
8+
---
9+
10+
__References:__
11+
Please provide links to the relevant PRs in the Parse Server repo and SDK repos where applicable.
12+
13+
__Proposed solution:__
14+
Can you provide links to the sections in the relevant guides where the new content should go?

CODE_OF_CONDUCT.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our project and
7+
our community a harassment-free experience for everyone, regardless of age, body
8+
size, disability, ethnicity, sex characteristics, gender identity and expression,
9+
level of experience, education, socio-economic status, nationality, personal
10+
appearance, race, religion, or sexual identity and orientation.
11+
12+
## Our Standards
13+
14+
Examples of behavior that contributes to creating a positive environment
15+
include:
16+
17+
* Using welcoming and inclusive language
18+
* Being respectful of differing viewpoints and experiences
19+
* Gracefully accepting constructive criticism
20+
* Focusing on what is best for the community
21+
* Showing empathy towards other community members
22+
23+
Examples of unacceptable behavior by participants include:
24+
25+
* The use of sexualized language or imagery and unwelcome sexual attention or
26+
advances
27+
* Trolling, insulting/derogatory comments, and personal or political attacks
28+
* Public or private harassment
29+
* Publishing others' private information, such as a physical or electronic
30+
address, without explicit permission
31+
* Other conduct which could reasonably be considered inappropriate in a
32+
professional setting
33+
34+
## Our Responsibilities
35+
36+
Project maintainers are responsible for clarifying the standards of acceptable
37+
behavior and are expected to take appropriate and fair corrective action in
38+
response to any instances of unacceptable behavior.
39+
40+
Project maintainers have the right and responsibility to remove, edit, or
41+
reject comments, commits, code, wiki edits, issues, and other contributions
42+
that are not aligned to this Code of Conduct, or to ban temporarily or
43+
permanently any contributor for other behaviors that they deem inappropriate,
44+
threatening, offensive, or harmful.
45+
46+
## Scope
47+
48+
This Code of Conduct applies both within project spaces and in public spaces
49+
when an individual is representing the project or its community. Examples of
50+
representing a project or community include using an official project e-mail
51+
address, posting via an official social media account, or acting as an appointed
52+
representative at an online or offline event. Representation of a project may be
53+
further defined and clarified by project maintainers.
54+
55+
## Enforcement
56+
57+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
58+
reported by contacting the project team at [email protected]. All
59+
complaints will be reviewed and investigated and will result in a response that
60+
is deemed necessary and appropriate to the circumstances. The project team is
61+
obligated to maintain confidentiality with regard to the reporter of an incident.
62+
Further details of specific enforcement policies may be posted separately.
63+
64+
Project maintainers who do not follow or enforce the Code of Conduct in good
65+
faith may face temporary or permanent repercussions as determined by other
66+
members of the project's leadership.
67+
68+
## Attribution
69+
70+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71+
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
72+
73+
[homepage]: https://www.contributor-covenant.org
74+
75+
For answers to common questions about this code of conduct, see
76+
https://www.contributor-covenant.org/faq

LICENSE

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
BSD License
2+
3+
For Parse Server software
4+
5+
Copyright (c) 2015-present, Parse, LLC. All rights reserved.
6+
7+
Redistribution and use in source and binary forms, with or without modification,
8+
are permitted provided that the following conditions are met:
9+
10+
* Redistributions of source code must retain the above copyright notice, this
11+
list of conditions and the following disclaimer.
12+
13+
* Redistributions in binary form must reproduce the above copyright notice,
14+
this list of conditions and the following disclaimer in the documentation
15+
and/or other materials provided with the distribution.
16+
17+
* Neither the name Parse nor the names of its contributors may be used to
18+
endorse or promote products derived from this software without specific
19+
prior written permission.
20+
21+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
22+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
23+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
24+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
25+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
26+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
27+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
28+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31+
32+
-----
33+
34+
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

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,12 @@
11
# Parse Docs
22

3+
[![Join The Conversation](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
4+
[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
5+
[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
6+
[![License][license-svg]][license-link]
7+
[![Twitter Follow](https://img.shields.io/twitter/follow/ParsePlatform.svg?label=Follow%20us%20on%20Twitter&style=social)](https://twitter.com/intent/follow?screen_name=ParsePlatform)
8+
9+
310
These are the markdown sources for all of the [Parse SDK guides](https://parse-community.github.io/#sdks). The content for the guides is stored in this repo, and we use Jekyll to generate a static site that is hosted on GitHub Pages.
411

512
## Repository Structure
@@ -49,4 +56,8 @@ Finally, open http://localhost:4000/ in your web browser.
4956

5057
-----
5158

52-
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.
59+
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.
60+
61+
[license-svg]: https://img.shields.io/badge/license-BSD-lightgrey.svg
62+
[license-link]: LICENSE
63+
[open-collective-link]: https://opencollective.com/parse-server

_app/main.js

Lines changed: 53 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ App.Views = {};
110110
this._headerHeights = headerHeights;
111111
this._sortedHeights = sortedHeights.sort(function(a,b) { return a - b; });
112112
},
113-
113+
114114
findBestLink: function() {
115115
var fromTop = this.scrollContent.scrollTop;
116116
// firefox doesn't like this so we fallback to window
@@ -244,7 +244,7 @@ App.Views = {};
244244
var self = this;
245245
$('.language-toggle').each(function(i, block) {
246246
$(block.children).each(function(i, node) {
247-
// manually rendered
247+
// manually rendered
248248
var isOpt1 = false;
249249
var isOpt2 = false;
250250
var toggleTarget;
@@ -348,7 +348,7 @@ App.Views = {};
348348
// create the TOC
349349
this.scrollContent = document.getElementsByTagName('body')[0];
350350

351-
351+
352352
// add toggles to code blocks if necessary
353353
if (this.platform === "ios" || this.platform === "osx" || this.platform === "macos") {
354354
new App.Views.Docs.Toggle({
@@ -418,7 +418,9 @@ App.Views = {};
418418
const _mount = localStorage.getItem('parse-server-custom-mount');
419419
const _protocol = localStorage.getItem('parse-server-custom-protocol');
420420
const _appId = localStorage.getItem('parse-server-custom-appid');
421+
const _masterKey = localStorage.getItem('parse-server-custom-masterkey');
421422
const _clientKey = localStorage.getItem('parse-server-custom-clientkey');
423+
const _restApiKey = localStorage.getItem('parse-server-custom-restapikey');
422424

423425
// set existing entries
424426
if (_url) {
@@ -437,10 +439,18 @@ App.Views = {};
437439
$(".custom-parse-server-appid").html(_appId);
438440
$("#parse-server-custom-appid").val(_appId);
439441
}
442+
if (_masterKey) {
443+
$(".custom-parse-server-masterkey").html(_masterKey);
444+
$("#parse-server-custom-masterkey").val(_masterKey);
445+
}
440446
if (_clientKey) {
441447
$(".custom-parse-server-clientkey").html(_clientKey);
442448
$("#parse-server-custom-clientkey").val(_clientKey);
443449
}
450+
if (_restApiKey) {
451+
$(".custom-parse-server-restapikey").html(_restApiKey);
452+
$("#parse-server-custom-restapikey").val(_restApiKey);
453+
}
444454
}
445455

446456
// set url listener
@@ -505,11 +515,26 @@ App.Views = {};
505515
}
506516
});
507517

518+
// set masterKey listener
519+
$('#parse-server-custom-masterkey').keyup(function() {
520+
var masterKey = $('#parse-server-custom-masterkey').val();
521+
if(!masterKey.match(/^[^\s]+$/i)) {
522+
// not a valid masterKey
523+
return;
524+
}
525+
// encode any html
526+
masterKey = masterKey.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
527+
$(".custom-parse-server-masterkey").html(masterKey);
528+
if (typeof(Storage) !== "undefined") {
529+
localStorage.setItem('parse-server-custom-masterkey', masterKey);
530+
}
531+
});
532+
508533
// set clientKey listener
509534
$('#parse-server-custom-clientkey').keyup(function() {
510535
var clientKey = $('#parse-server-custom-clientkey').val();
511536
if(!clientKey.match(/^[^\s]+$/i)) {
512-
// not a valid appId
537+
// not a valid clientKey
513538
return;
514539
}
515540
// encode any html
@@ -520,6 +545,21 @@ App.Views = {};
520545
}
521546
});
522547

548+
// set restApiKey listener
549+
$('#parse-server-custom-restapikey').keyup(function() {
550+
var restApiKey = $('#parse-server-custom-restapikey').val();
551+
if(!restApiKey.match(/^[^\s]+$/i)) {
552+
// not a valid restApiKey
553+
return;
554+
}
555+
// encode any html
556+
restApiKey = restApiKey.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
557+
$(".custom-parse-server-restapikey").html(restApiKey);
558+
if (typeof(Storage) !== "undefined") {
559+
localStorage.setItem('parse-server-custom-restapikey', restApiKey);
560+
}
561+
});
562+
523563
// set reset button
524564
$('#parse-server-custom-values-reset').click(function() {
525565
// reset defaults
@@ -543,12 +583,20 @@ App.Views = {};
543583
$("#parse-server-custom-appid").val(_default);
544584
localStorage.setItem('parse-server-custom-appid', _default);
545585

586+
_default = $("#parse-server-custom-masterkey").attr('defaultval');
587+
$(".custom-parse-server-masterkey").html(_default);
588+
$("#parse-server-custom-masterkey").val(_default);
589+
localStorage.setItem('parse-server-custom-masterkey', _default);
590+
546591
_default = $("#parse-server-custom-clientkey").attr('defaultval');
547592
$(".custom-parse-server-clientkey").html(_default);
548593
$("#parse-server-custom-clientkey").val(_default);
549594
localStorage.setItem('parse-server-custom-clientkey', _default);
550595

551-
596+
_default = $("#parse-server-custom-restapikey").attr('defaultval');
597+
$(".parse-server-custom-restapikey").html(_default);
598+
$("#parse-server-custom-restapikey").val(_default);
599+
localStorage.setItem('parse-server-custom-restapikey', _default);
552600
});
553601

554602
},

_config.yml

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,17 @@
66
# 'jekyll serve'. If you change this file, please restart the server process.
77

88
# Site settings
9-
name: Parse Open Source Docs
9+
name: Parse Platform Docs
1010
title: Parse Docs
11-
email: community@parse.com
12-
description: The open source GitHub page for the Parse platform.
11+
email: community@parseplatform.org
12+
description: The open source docs for the Parse platform SDKs & other guides.
1313
url: "http://docs.parseplatform.org" # the base hostname & protocol for your site
1414
repository: parse-community/docs
15-
facebook_username: parseit
16-
twitter_username: parseit
15+
twitter_username: parseplatform
1716
github_username: parseplatform
18-
stackoverflow_tag: parse.com
17+
stackoverflow_tag: parse-platform
1918
serverfault_tag: parse
20-
support_url: https://www.parse.com/help
19+
support_url: https://community.parseplatform.org
2120
apis:
2221
osx: https://parseplatform.org/Parse-SDK-iOS-OSX/api/
2322
android: https://parseplatform.org/Parse-SDK-Android/api/

_includes/android/files.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## The ParseFile
44

5-
`ParseFile` lets you store application files in the cloud that would otherwise be too large or cumbersome to fit into a regular `ParseObject`. The most common use case is storing images but you can also use it for documents, videos, music, and any other binary data (up to 10 megabytes).
5+
`ParseFile` lets you store application files in the cloud that would otherwise be too large or cumbersome to fit into a regular `ParseObject`. The most common use case is storing images but you can also use it for documents, videos, music, and any other binary data.
66

77
Getting started with `ParseFile` is easy. First, you'll need to have the data in `byte[]` form and then create a `ParseFile` with it. In this example, we'll just use a string:
88

@@ -94,4 +94,4 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
9494
}
9595
```
9696

97-
Note, however, that files can't be parceled if they are not saved on the server. If you try to do so, an exception will be thrown. If you are not sure if your file has been saved, plaese check for `!isDirty()` to be true before writing it to a parcel.
97+
Note, however, that files can't be parceled if they are not saved on the server. If you try to do so, an exception will be thrown. If you are not sure if your file has been saved, please check for `!isDirty()` to be true before writing it to a parcel.

0 commit comments

Comments
 (0)