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

[GSoD] docs: Added revised version of the quick start guide #25760

Merged
merged 8 commits into from
Oct 13, 2020

Conversation

bandantonio
Copy link
Contributor

@bandantonio bandantonio commented Oct 3, 2020

Description of Change

This PR contains a revised version of the Quick Start Guide that helps new developers up and running their first Electron app in a matter of minutes. The quick start guide includes the following changes:

  • Added new version of the quick start guide containing app architecture and packaging/distribution section
  • Removed links to the first-app and architecture pages. Removed these pages as well
  • Updated links to the new guide and its sections in README

Checklist

Release Notes

Notes: Added a revised version of the Quick Start Guide that helps new developers up and running their first Electron app in a matter of minutes

@electron-cation electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Oct 3, 2020
@welcome
Copy link

welcome bot commented Oct 3, 2020

💖 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 removed the new-pr 🌱 PR opened in the last 24 hours label Oct 4, 2020
@zcbenz
Copy link
Contributor

zcbenz commented Oct 5, 2020

The quick start guide was intentionally split into first-app.md and application-architecture.md, please modify those guides instead if you think they can be improved.

@zcbenz zcbenz closed this Oct 5, 2020
@felixrieseberg felixrieseberg reopened this Oct 5, 2020
@felixrieseberg
Copy link
Member

👋 @zcbenz Thanks for looking out for us! I'm the one who initially split the two documents out, but @bandantonio managed to convince me in #wg-season-of-docs over in Slack that putting them back together is easier for newcomers 🙇

@zcbenz
Copy link
Contributor

zcbenz commented Oct 6, 2020

@bandantonio Can you fix the lint error?

docs/tutorial/quick-start.md
     19:1-22:4  warning  Missing code-language flag    fenced-code-flag  remark-lint
     31:1-36:4  warning  Missing code-language flag    fenced-code-flag  remark-lint
     44:1-48:4  warning  Missing code-language flag    fenced-code-flag  remark-lint
   147:1-149:4  warning  Missing code-language flag    fenced-code-flag  remark-lint
  162:5-170:24  warning  Missing code-language flag    fenced-code-flag  remark-lint
   173:1-176:8  warning  Code blocks should be fenced  code-block-style  remark-lint
   180:5-194:8  warning  Missing code-language flag    fenced-code-flag  remark-lint
   198:5-205:8  warning  Missing code-language flag    fenced-code-flag  remark-lint

And there seems to be a merging conflict in first-app.md, can you rebase the PR on latest master branch?

@zcbenz zcbenz requested a review from a team October 8, 2020 07:19
@erickzhao erickzhao self-requested a review October 9, 2020 04:43
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Show resolved Hide resolved
docs/tutorial/windows-arm.md Outdated Show resolved Hide resolved
@bandantonio bandantonio self-assigned this Oct 9, 2020
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
docs/tutorial/quick-start.md Outdated Show resolved Hide resolved
Copy link
Member

@ckerr ckerr left a comment

Choose a reason for hiding this comment

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

I'm a little late to the party on this PR, but it LGTM. The rewrite has a good flow and the explanations are clear.

@codebytere codebytere merged commit 8dfb1cf into electron:master Oct 13, 2020
@welcome
Copy link

welcome bot commented Oct 13, 2020

Congrats on merging your first pull request! 🎉🎉🎉

@release-clerk
Copy link

release-clerk bot commented Oct 13, 2020

Release Notes Persisted

Added a revised version of the Quick Start Guide that helps new developers up and running their first Electron app in a matter of minutes

erickzhao pushed a commit to erickzhao/ericktron that referenced this pull request Dec 1, 2020
@bandantonio bandantonio changed the title docs: Added revised version of the quick start guide [GSoD] docs: Added revised version of the quick start guide Dec 4, 2020
@thrnd
Copy link

thrnd commented Dec 15, 2020

When you were changing "quick start" article you forgot these lines of code:

// Open the DevTools.
win.webContents.openDevTools()

UPDATE:
just discovered that everything is ok here, on github, but those 2 lines of code are missing on your web-site.
image

@erickzhao erickzhao mentioned this pull request May 14, 2021
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants