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.

Sign up for GitHub

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

Jump to bottom

docs: update Quick Start Guide for Electron 12 #28223

Merged
merged 6 commits into from
Mar 16, 2021
Merged

docs: update Quick Start Guide for Electron 12 #28223

merged 6 commits into from
Mar 16, 2021

Conversation

itsananderson
Copy link
Contributor

Description of Change

With contextIsolation enabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values from process.versions, this change adds a preload.js to the example.

Adding a preload script does increase the complexity of the "hello world" example, but setting contextIsolation: false in the example code seemed like a less ideal solution since it encourages insecure practices

Checklist

  • PR description included and stakeholders cc'd
  • relevant documentation is changed or added

Release Notes

Notes: no-notes

@itsananderson
docs: Update Quick Start Guide for Electron 12
1fe6ea3 
With `contextIsolation` enabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values from `process.versions`, we need to add a `preload.js` to the example.
@itsananderson
fix: annotate preload code block with a language
8c4855d
@itsananderson
docs: update quick-start Fiddle example to use preload to provide ver…
e03d3d6 
…sion info
@itsananderson
fix: ensure example files end in a newline
e3d9e1b
@welcome
Copy link

welcome bot commented Mar 16, 2021

💖 Thanks for opening this pull request! 💖

We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix.

Examples of commit messages with semantic prefixes:

  • fix: don't overwrite prevent_default if default wasn't prevented
  • feat: add app.isPackaged() method
  • docs: app.isDefaultProtocolClient is now available on Linux

Things that will help get your PR across the finish line:

  • Follow the JavaScript, C++, and Python coding style.
  • Run npm run lint locally to catch formatting errors earlier.
  • Document any user-facing changes you've made following the documentation styleguide.
  • Include tests when adding/changing behavior.
  • Include screenshots and animated GIFs whenever possible.

We get a lot of pull requests on this repo, so please be patient and we will get back to you as soon as we can.

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Mar 16, 2021
@itsananderson itsananderson changed the title docs: Update Quick Start Guide for Electron 12 docs: update Quick Start Guide for Electron 12 Mar 16, 2021
jkleinsc
jkleinsc requested changes Mar 16, 2021
View reviewed changes
Copy link
Contributor

@jkleinsc jkleinsc left a comment

Choose a reason for hiding this comment

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

Overall, looks good to me - just a few tweaks.

docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
@itsananderson
docs: add security warning to instructions for turning off contextIso…
5beb934 
…lation

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
@jkleinsc jkleinsc mentioned this pull request Mar 16, 2021
Closed
1 task
@itsananderson
docs: treat preload as an adjective instead of a noun
ca8d005 
Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
@jkleinsc jkleinsc mentioned this pull request Mar 16, 2021
Closed
@jkleinsc jkleinsc merged commit b6ff12e into electron:master Mar 16, 2021
@welcome
Copy link

welcome bot commented Mar 16, 2021

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Mar 16, 2021

No Release Notes

@trop
Copy link
Contributor

trop bot commented Mar 16, 2021

I was unable to backport this PR to "12-x-y" cleanly;
you will need to perform this backport manually.

@trop
Copy link
Contributor

trop bot commented Mar 16, 2021

I was unable to backport this PR to "13-x-y" cleanly;
you will need to perform this backport manually.

@itsananderson itsananderson mentioned this pull request Mar 17, 2021
Merged
2 tasks
@trop
Copy link
Contributor

trop bot commented Mar 17, 2021

@itsananderson has manually backported this PR to "12-x-y", please check out #28227

@itsananderson itsananderson mentioned this pull request Mar 17, 2021
Merged
2 tasks
@trop
Copy link
Contributor

trop bot commented Mar 17, 2021

@itsananderson has manually backported this PR to "13-x-y", please check out #28229

@itsananderson itsananderson mentioned this pull request Mar 17, 2021
Merged
3 tasks
@electron-cation electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Mar 18, 2021
mlaurencin pushed a commit that referenced this pull request Mar 18, 2021
@itsananderson @mlaurencin
docs: update Quick Start Guide for Electron 12 (#28223)
5702146 
* docs: Update Quick Start Guide for Electron 12

With `contextIsolation` enabled by default in Electron 12, the Getting Started Guide no longer works as it is written. In order for the basic example to display values from `process.versions`, we need to add a `preload.js` to the example.

* fix: annotate preload code block with a language

* docs: update quick-start Fiddle example to use preload to provide version info

* fix: ensure example files end in a newline

* docs: add security warning to instructions for turning off contextIsolation

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>

* docs: treat preload as an adjective instead of a noun

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>

Co-authored-by: John Kleinschmidt <jkleinsc@github.com>
@erickzhao erickzhao mentioned this pull request May 14, 2021
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@jkleinsc jkleinsc jkleinsc approved these changes

@erickzhao erickzhao erickzhao approved these changes

@MarshallOfSound MarshallOfSound Awaiting requested review from MarshallOfSound

Assignees
No one assigned
Labels
documentation 📓 semver/none
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@itsananderson @jkleinsc @erickzhao