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

Add-FAQ-to-README #344

Closed
wants to merge 1 commit into from

Conversation

athenaozanich
Copy link
Contributor

Added brief description of how to troubleshoot the issue of incorrect data ordering, using the suggested steps provided by @mckennapsean

Copy link
Collaborator

@mckennapsean mckennapsean left a comment

Choose a reason for hiding this comment

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

Thanks so much, @athenaozanich for the contributions! Apologies it took me so late to look at this (no idea how I missed it). Very nice to create this PR, and thank you for sharing this FAQ for others!

Most of the changes here are minor or just make the FAQ sound more professional, let me know if there are questions or anything is unclear.

@@ -377,6 +377,9 @@ Let us know if you have any questions!

- No. While data that is sent over POST may be more protected, the information could easily be intercepted by a third party or middleman, and Google has complete access to the data inside a Google Spreadsheet. Email is also not a very secure communication medium by default. We would recommend you invest in a secure platform and server for storing your data if this is a requirement.

8. _What if my data is being collected or sent in the wrong order?_
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: this reads a little odd, could change to "being stored" or just have it say "sent"

@@ -377,6 +377,9 @@ Let us know if you have any questions!

- No. While data that is sent over POST may be more protected, the information could easily be intercepted by a third party or middleman, and Google has complete access to the data inside a Google Spreadsheet. Email is also not a very secure communication medium by default. We would recommend you invest in a secure platform and server for storing your data if this is a requirement.

8. _What if my data is being collected or sent in the wrong order?_

- If your data is being collected and or sent in the wrong order, it is recommended to test that you are loading the Clientside JS correctly. The most affective way to do this is to place a ```debugger``` call inside the ```handleFormSubmit()``` function, if it hits the debugger and opens the respective Dev tools for the broswer/environment then the Client side JS is being loaded and the issue is not that. If the debugger isn't executed then the JS is **not** being loaded and as a result not handling the form submission, defaulting the data to a plain object which will have it's own alphabetic ordering.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nit: "and/or" but I would probably just rephrase that whole sentence to "If your data is in the wrong order..."

@@ -377,6 +377,9 @@ Let us know if you have any questions!

- No. While data that is sent over POST may be more protected, the information could easily be intercepted by a third party or middleman, and Google has complete access to the data inside a Google Spreadsheet. Email is also not a very secure communication medium by default. We would recommend you invest in a secure platform and server for storing your data if this is a requirement.

8. _What if my data is being collected or sent in the wrong order?_

- If your data is being collected and or sent in the wrong order, it is recommended to test that you are loading the Clientside JS correctly. The most affective way to do this is to place a ```debugger``` call inside the ```handleFormSubmit()``` function, if it hits the debugger and opens the respective Dev tools for the broswer/environment then the Client side JS is being loaded and the issue is not that. If the debugger isn't executed then the JS is **not** being loaded and as a result not handling the form submission, defaulting the data to a plain object which will have it's own alphabetic ordering.
Copy link
Collaborator

Choose a reason for hiding this comment

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

spelling: "effective"

@@ -377,6 +377,9 @@ Let us know if you have any questions!

- No. While data that is sent over POST may be more protected, the information could easily be intercepted by a third party or middleman, and Google has complete access to the data inside a Google Spreadsheet. Email is also not a very secure communication medium by default. We would recommend you invest in a secure platform and server for storing your data if this is a requirement.

8. _What if my data is being collected or sent in the wrong order?_

- If your data is being collected and or sent in the wrong order, it is recommended to test that you are loading the Clientside JS correctly. The most affective way to do this is to place a ```debugger``` call inside the ```handleFormSubmit()``` function, if it hits the debugger and opens the respective Dev tools for the broswer/environment then the Client side JS is being loaded and the issue is not that. If the debugger isn't executed then the JS is **not** being loaded and as a result not handling the form submission, defaulting the data to a plain object which will have it's own alphabetic ordering.
Copy link
Collaborator

Choose a reason for hiding this comment

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

in-line code callouts are just one back-tick rather than three.

@@ -377,6 +377,9 @@ Let us know if you have any questions!

- No. While data that is sent over POST may be more protected, the information could easily be intercepted by a third party or middleman, and Google has complete access to the data inside a Google Spreadsheet. Email is also not a very secure communication medium by default. We would recommend you invest in a secure platform and server for storing your data if this is a requirement.

8. _What if my data is being collected or sent in the wrong order?_

- If your data is being collected and or sent in the wrong order, it is recommended to test that you are loading the Clientside JS correctly. The most affective way to do this is to place a ```debugger``` call inside the ```handleFormSubmit()``` function, if it hits the debugger and opens the respective Dev tools for the broswer/environment then the Client side JS is being loaded and the issue is not that. If the debugger isn't executed then the JS is **not** being loaded and as a result not handling the form submission, defaulting the data to a plain object which will have it's own alphabetic ordering.
Copy link
Collaborator

Choose a reason for hiding this comment

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

spelling/grammar: "its" since it is not a contraction for "it is" in this context

@mckennapsean
Copy link
Collaborator

@athenaozanich - would you be able to make some of the brief changes above? If not, anyone could probably add another commit that does this in a new PR. Thank you!

@mckennapsean
Copy link
Collaborator

I'll create a new PR (#398) to resolve the concerns & get the changes here merged in :) thanks for your contribution!!

mckennapsean added a commit that referenced this pull request Feb 7, 2021
* Add-FAQ-to-README

* Address Sean's code review feedback for FAQ (#344)

Co-authored-by: athenaozanich <[email protected]>
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.

2 participants