docs: Updated list numbering #32991

alvinphilips · 2022-02-19T02:30:30Z

The steps on the section to Package and Distribute an Application using Electron Forge had incorrect numbering

Description of Change

Checklist

relevant documentation is changed or added

Release Notes

Notes: none

The steps to package and distribute an application using electron had incorrect numbering

welcome · 2022-02-19T02:30:32Z

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

jkleinsc

Thanks for the PR @PolarVoid!

jkleinsc

It looks like lint is failing on this change. Not sure why, but marking this as changes requested so that it doesn't accidentally get merged.

jkleinsc · 2022-02-23T17:03:48Z

@PolarVoid lint is failing because the code blocks under each point need to be indented (see DavidAnson/markdownlint#226 for more details)

Eg the change needed to fix lint would be:

 1. Add Electron Forge as a development dependency of your app, and use its `import` command to set up
 Forge's scaffolding:

-```sh npm2yarn
-npm install --save-dev @electron-forge/cli
-npx electron-forge import
+    ```sh npm2yarn
+    npm install --save-dev @electron-forge/cli
+    npx electron-forge import

-✔ Checking your system
-✔ Initializing Git Repository
-✔ Writing modified package.json file
-✔ Installing dependencies
-✔ Writing modified package.json file
-✔ Fixing .gitignore
+    ✔ Checking your system
+    ✔ Initializing Git Repository
+    ✔ Writing modified package.json file
+    ✔ Installing dependencies
+    ✔ Writing modified package.json file
+    ✔ Fixing .gitignore

-We have ATTEMPTED to convert your app to be in a format that electron-forge understands.
+    We have ATTEMPTED to convert your app to be in a format that electron-forge understands.

-Thanks for using "electron-forge"!!!
-```
+    Thanks for using "electron-forge"!!!
+    ```

 2. Create a distributable using Forge's `make` command:

-```sh npm2yarn
-npm run make
-
-> my-electron-app@1.0.0 make /my-electron-app
-> electron-forge make
-
-✔ Checking your system
-✔ Resolving Forge Config
-We need to package your application before we can make it
-✔ Preparing to Package Application for arch: x64
-✔ Preparing native dependencies
-✔ Packaging Application
-Making for the following targets: zip
-✔ Making for target: zip - On platform: darwin - For arch: x64
-```
+    ```sh npm2yarn
+    npm run make
+
+    > my-electron-app@1.0.0 make /my-electron-app
+    > electron-forge make
+
+    ✔ Checking your system
+    ✔ Resolving Forge Config
+    We need to package your application before we can make it
+    ✔ Preparing to Package Application for arch: x64
+    ✔ Preparing native dependencies
+    ✔ Packaging Application
+    Making for the following targets: zip
+    ✔ Making for target: zip - On platform: darwin - For arch: x64
+    ```

 Electron Forge creates the `out` folder where your package will be located:

alvinphilips · 2022-02-23T18:54:05Z

@jkleinsc Aah okay, I get what you mean. I figured it was something wrong with how it was formatted. I'll get on it and make the required changes.

jkleinsc

I tested this locally, and it looks like you need to indent the code blocks with 4 spaces to resolve the lint issue.

jkleinsc · 2022-02-24T20:21:35Z

docs/tutorial/quick-start.md

+  ```sh npm2yarn
+  npm install --save-dev @electron-forge/cli
+  npx electron-forge import
+
+  ✔ Checking your system
+  ✔ Initializing Git Repository
+  ✔ Writing modified package.json file
+  ✔ Installing dependencies
+  ✔ Writing modified package.json file
+  ✔ Fixing .gitignore
+
+  We have ATTEMPTED to convert your app to be in a format that electron-forge understands.
+ 
+  Thanks for using "electron-forge"!!!
+  ```


This block needs to be indented 2 more spaces to resolve the lint issue.

jkleinsc · 2022-02-24T20:22:19Z

docs/tutorial/quick-start.md

+  ```sh npm2yarn
+  npm run make
+
+  > my-electron-app@1.0.0 make /my-electron-app
+  > electron-forge make
+
+  ✔ Checking your system
+  ✔ Resolving Forge Config
+  We need to package your application before we can make it
+  ✔ Preparing to Package Application for arch: x64
+  ✔ Preparing native dependencies
+  ✔ Packaging Application
+  Making for the following targets: zip
+  ✔ Making for target: zip - On platform: darwin - For arch: x64
+  ```
+
+  Electron Forge creates the `out` folder where your package will be located:
+
+  ```plain
+  // Example for macOS
+  out/
+  ├── out/make/zip/darwin/x64/my-electron-app-darwin-x64-1.0.0.zip
+  ├── ...
+  └── out/my-electron-app-darwin-x64/my-electron-app.app/Contents/MacOS/my-electron-app
+  ```


This block needs to be indented 2 more spaces to resolve the lint issue.

jkleinsc · 2022-03-03T23:35:46Z

Merging as CI failure unrelated to PR change.

welcome · 2022-03-03T23:35:53Z

Congrats on merging your first pull request! 🎉🎉🎉

release-clerk · 2022-03-03T23:35:54Z

No Release Notes

trop · 2022-03-03T23:36:15Z

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

trop · 2022-03-03T23:36:18Z

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

trop · 2022-03-03T23:36:21Z

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

trop · 2022-03-03T23:36:38Z

I have automatically backported this PR to "17-x-y", please check out #33146

trop · 2022-03-03T23:36:41Z

I have automatically backported this PR to "18-x-y", please check out #33147

* docs: Updated list numbering The steps to package and distribute an application using electron had incorrect numbering * Indented text within ordered list sections * Removed single space * Fixed indentation

docs: Updated list numbering

1c7db3c

The steps to package and distribute an application using electron had incorrect numbering

electron-cation bot added the new-pr 🌱 PR opened in the last 24 hours label Feb 19, 2022

This comment was marked as off-topic.

Sign in to view

jkleinsc approved these changes Feb 23, 2022

View reviewed changes

jkleinsc requested changes Feb 23, 2022

View reviewed changes

alvinphilips added 2 commits February 24, 2022 00:27

Indented text within ordered list sections

41141e4

Removed single space

5b12468

jkleinsc requested changes Feb 24, 2022

View reviewed changes

electron-cation bot removed the new-pr 🌱 PR opened in the last 24 hours label Feb 26, 2022

Fixed indentation

1cb8fd2

jkleinsc approved these changes Mar 2, 2022

View reviewed changes

jkleinsc added semver/none target/14-x-y labels Mar 2, 2022

jkleinsc merged commit 41c81ed into electron:main Mar 3, 2022
6 checks passed

trop bot added needs-manual-bp/14-x-y and removed target/14-x-y labels Mar 3, 2022

trop bot removed the target/15-x-y label Mar 3, 2022

trop bot mentioned this pull request Mar 3, 2022

docs: Updated list numbering #33146

Merged

trop bot added needs-manual-bp/15-x-y and removed target/16-x-y labels Mar 3, 2022

trop bot mentioned this pull request Mar 3, 2022

docs: Updated list numbering #33147

Merged

trop bot added the needs-manual-bp/16-x-y label Mar 3, 2022

trop bot added in-flight/17-x-y and removed target/17-x-y labels Mar 3, 2022

erickzhao removed needs-manual-bp/14-x-y labels Mar 9, 2022

commit-lint bot mentioned this pull request Apr 21, 2022

[pull] main from electron:main Blaquez-home/electron#3

Open

dsanders11 added the documentation 📓 label May 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Updated list numbering #32991

docs: Updated list numbering #32991

alvinphilips commented Feb 19, 2022

welcome bot commented Feb 19, 2022

This comment was marked as off-topic.

jkleinsc left a comment

jkleinsc left a comment

jkleinsc commented Feb 23, 2022

alvinphilips commented Feb 23, 2022

jkleinsc left a comment

jkleinsc Feb 24, 2022

jkleinsc Feb 24, 2022

jkleinsc commented Mar 3, 2022

welcome bot commented Mar 3, 2022

release-clerk bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

docs: Updated list numbering #32991

docs: Updated list numbering #32991

Conversation

alvinphilips commented Feb 19, 2022

Description of Change

Checklist

Release Notes

welcome bot commented Feb 19, 2022

This comment was marked as off-topic.

jkleinsc left a comment

Choose a reason for hiding this comment

jkleinsc left a comment

Choose a reason for hiding this comment

jkleinsc commented Feb 23, 2022

alvinphilips commented Feb 23, 2022

jkleinsc left a comment

Choose a reason for hiding this comment

jkleinsc Feb 24, 2022

Choose a reason for hiding this comment

jkleinsc Feb 24, 2022

Choose a reason for hiding this comment

jkleinsc commented Mar 3, 2022

welcome bot commented Mar 3, 2022

release-clerk bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022

trop bot commented Mar 3, 2022