Skip to content

Commit

Permalink
Merge commit 'e129790ed587819ecfcaed59fc7ff90ec6ffcfa1' into gh-pages
Browse files Browse the repository at this point in the history
* 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)
  ...
  • Loading branch information
mtrezza committed Sep 6, 2019
2 parents 91a5a9b + e129790 commit d61b9db
Show file tree
Hide file tree
Showing 104 changed files with 2,976 additions and 1,396 deletions.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/---bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
---
name: "\U0001F41B Bug report"
about: Create a report to help us improve
title: "\U0001F41B "
labels: Bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
18 changes: 18 additions & 0 deletions .github/ISSUE_TEMPLATE/---docs-fix-improvement-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
---
name: "\U0001F4D9 Docs fix/improvement report"
about: Bring attention to an area of the docs with code samples that need updating
or wording that could be improved
title: "\U0001F4D9 "
labels: Documentation Improvement
assignees: ''

---

__Link to section:__
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.

__What is the issue?__
Please provide a detailed explanation of the problem, quoting parts of the docs or using screenshots if appropriate.

__Can you propose a solution?__
What changes do you think should be made? Have you considered multiple solutions? Will this be suitable for all use cases?
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/---feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "\U0001F4A1 Feature request"
about: Suggest an idea for this project
title: "\U0001F4A1 "
labels: Feature
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
14 changes: 14 additions & 0 deletions .github/ISSUE_TEMPLATE/---missing-content.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
name: "\U0001F4D5 Missing content"
about: Bring attention to features that are undocumented
title: "\U0001F4D5"
labels: Missing Content
assignees: ''

---

__References:__
Please provide links to the relevant PRs in the Parse Server repo and SDK repos where applicable.

__Proposed solution:__
Can you provide links to the sections in the relevant guides where the new content should go?
76 changes: 76 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at codeofconduct@parseplatform.org. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
34 changes: 34 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
BSD License

For Parse Server software

Copyright (c) 2015-present, Parse, LLC. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* Neither the name Parse nor the names of its contributors may be used to
endorse or promote products derived from this software without specific
prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

-----

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.
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Parse Docs

[![Join The Conversation](https://img.shields.io/discourse/https/community.parseplatform.org/topics.svg)](https://community.parseplatform.org/c/parse-server)
[![Backers on Open Collective](https://opencollective.com/parse-server/backers/badge.svg)][open-collective-link]
[![Sponsors on Open Collective](https://opencollective.com/parse-server/sponsors/badge.svg)][open-collective-link]
[![License][license-svg]][license-link]
[![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)


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.

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

-----

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

[license-svg]: https://img.shields.io/badge/license-BSD-lightgrey.svg
[license-link]: LICENSE
[open-collective-link]: https://opencollective.com/parse-server
58 changes: 53 additions & 5 deletions _app/main.js
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ App.Views = {};
this._headerHeights = headerHeights;
this._sortedHeights = sortedHeights.sort(function(a,b) { return a - b; });
},

findBestLink: function() {
var fromTop = this.scrollContent.scrollTop;
// firefox doesn't like this so we fallback to window
Expand Down Expand Up @@ -244,7 +244,7 @@ App.Views = {};
var self = this;
$('.language-toggle').each(function(i, block) {
$(block.children).each(function(i, node) {
// manually rendered
// manually rendered
var isOpt1 = false;
var isOpt2 = false;
var toggleTarget;
Expand Down Expand Up @@ -348,7 +348,7 @@ App.Views = {};
// create the TOC
this.scrollContent = document.getElementsByTagName('body')[0];


// add toggles to code blocks if necessary
if (this.platform === "ios" || this.platform === "osx" || this.platform === "macos") {
new App.Views.Docs.Toggle({
Expand Down Expand Up @@ -418,7 +418,9 @@ App.Views = {};
const _mount = localStorage.getItem('parse-server-custom-mount');
const _protocol = localStorage.getItem('parse-server-custom-protocol');
const _appId = localStorage.getItem('parse-server-custom-appid');
const _masterKey = localStorage.getItem('parse-server-custom-masterkey');
const _clientKey = localStorage.getItem('parse-server-custom-clientkey');
const _restApiKey = localStorage.getItem('parse-server-custom-restapikey');

// set existing entries
if (_url) {
Expand All @@ -437,10 +439,18 @@ App.Views = {};
$(".custom-parse-server-appid").html(_appId);
$("#parse-server-custom-appid").val(_appId);
}
if (_masterKey) {
$(".custom-parse-server-masterkey").html(_masterKey);
$("#parse-server-custom-masterkey").val(_masterKey);
}
if (_clientKey) {
$(".custom-parse-server-clientkey").html(_clientKey);
$("#parse-server-custom-clientkey").val(_clientKey);
}
if (_restApiKey) {
$(".custom-parse-server-restapikey").html(_restApiKey);
$("#parse-server-custom-restapikey").val(_restApiKey);
}
}

// set url listener
Expand Down Expand Up @@ -505,11 +515,26 @@ App.Views = {};
}
});

// set masterKey listener
$('#parse-server-custom-masterkey').keyup(function() {
var masterKey = $('#parse-server-custom-masterkey').val();
if(!masterKey.match(/^[^\s]+$/i)) {
// not a valid masterKey
return;
}
// encode any html
masterKey = masterKey.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
$(".custom-parse-server-masterkey").html(masterKey);
if (typeof(Storage) !== "undefined") {
localStorage.setItem('parse-server-custom-masterkey', masterKey);
}
});

// set clientKey listener
$('#parse-server-custom-clientkey').keyup(function() {
var clientKey = $('#parse-server-custom-clientkey').val();
if(!clientKey.match(/^[^\s]+$/i)) {
// not a valid appId
// not a valid clientKey
return;
}
// encode any html
Expand All @@ -520,6 +545,21 @@ App.Views = {};
}
});

// set restApiKey listener
$('#parse-server-custom-restapikey').keyup(function() {
var restApiKey = $('#parse-server-custom-restapikey').val();
if(!restApiKey.match(/^[^\s]+$/i)) {
// not a valid restApiKey
return;
}
// encode any html
restApiKey = restApiKey.replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;').replace(/"/g, '&quot;');
$(".custom-parse-server-restapikey").html(restApiKey);
if (typeof(Storage) !== "undefined") {
localStorage.setItem('parse-server-custom-restapikey', restApiKey);
}
});

// set reset button
$('#parse-server-custom-values-reset').click(function() {
// reset defaults
Expand All @@ -543,12 +583,20 @@ App.Views = {};
$("#parse-server-custom-appid").val(_default);
localStorage.setItem('parse-server-custom-appid', _default);

_default = $("#parse-server-custom-masterkey").attr('defaultval');
$(".custom-parse-server-masterkey").html(_default);
$("#parse-server-custom-masterkey").val(_default);
localStorage.setItem('parse-server-custom-masterkey', _default);

_default = $("#parse-server-custom-clientkey").attr('defaultval');
$(".custom-parse-server-clientkey").html(_default);
$("#parse-server-custom-clientkey").val(_default);
localStorage.setItem('parse-server-custom-clientkey', _default);


_default = $("#parse-server-custom-restapikey").attr('defaultval');
$(".parse-server-custom-restapikey").html(_default);
$("#parse-server-custom-restapikey").val(_default);
localStorage.setItem('parse-server-custom-restapikey', _default);
});

},
Expand Down
13 changes: 6 additions & 7 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,18 +6,17 @@
# 'jekyll serve'. If you change this file, please restart the server process.

# Site settings
name: Parse Open Source Docs
name: Parse Platform Docs
title: Parse Docs
email: community@parse.com
description: The open source GitHub page for the Parse platform.
email: community@parseplatform.org
description: The open source docs for the Parse platform SDKs & other guides.
url: "http://docs.parseplatform.org" # the base hostname & protocol for your site
repository: parse-community/docs
facebook_username: parseit
twitter_username: parseit
twitter_username: parseplatform
github_username: parseplatform
stackoverflow_tag: parse.com
stackoverflow_tag: parse-platform
serverfault_tag: parse
support_url: https://www.parse.com/help
support_url: https://community.parseplatform.org
apis:
osx: https://parseplatform.org/Parse-SDK-iOS-OSX/api/
android: https://parseplatform.org/Parse-SDK-Android/api/
Expand Down
4 changes: 2 additions & 2 deletions _includes/android/files.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## The ParseFile

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

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:

Expand Down Expand Up @@ -94,4 +94,4 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
}
```

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

0 comments on commit d61b9db

Please sign in to comment.