From 20cff642821cf9dc57b55fef4414fa0b010d329f Mon Sep 17 00:00:00 2001 From: David Sanders Date: Mon, 2 Jan 2023 02:52:18 -0800 Subject: [PATCH] docs: update links (#36657) --- docs/README.md | 2 +- docs/api/auto-updater.md | 6 +++--- docs/api/utility-process.md | 2 +- docs/tutorial/boilerplates-and-clis.md | 2 +- docs/tutorial/forge-overview.md | 2 +- docs/tutorial/notifications.md | 2 +- docs/tutorial/performance.md | 2 +- docs/tutorial/snapcraft.md | 6 +++--- docs/tutorial/tutorial-4-adding-features.md | 2 +- docs/tutorial/tutorial-6-publishing-updating.md | 4 ++-- 10 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/README.md b/docs/README.md index 57172020a8..83c3df1fde 100644 --- a/docs/README.md +++ b/docs/README.md @@ -42,7 +42,7 @@ an issue: * [Web embeds in Electron](tutorial/web-embeds.md) * [Boilerplates and CLIs](tutorial/boilerplates-and-clis.md) * [Boilerplate vs CLI](tutorial/boilerplates-and-clis.md#boilerplate-vs-cli) - * [electron-forge](tutorial/boilerplates-and-clis.md#electron-forge) + * [Electron Forge](tutorial/boilerplates-and-clis.md#electron-forge) * [electron-builder](tutorial/boilerplates-and-clis.md#electron-builder) * [electron-react-boilerplate](tutorial/boilerplates-and-clis.md#electron-react-boilerplate) * [Other Tools and Boilerplates](tutorial/boilerplates-and-clis.md#other-tools-and-boilerplates) diff --git a/docs/api/auto-updater.md b/docs/api/auto-updater.md index d181dfaccb..dc82b783ba 100644 --- a/docs/api/auto-updater.md +++ b/docs/api/auto-updater.md @@ -32,9 +32,9 @@ This is a requirement of `Squirrel.Mac`. On Windows, you have to install your app into a user's machine before you can use the `autoUpdater`, so it is recommended that you use the -[electron-winstaller][installer-lib], [electron-forge][electron-forge-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer. +[electron-winstaller][installer-lib], [Electron Forge][electron-forge-lib] or the [grunt-electron-installer][installer] package to generate a Windows installer. -When using [electron-winstaller][installer-lib] or [electron-forge][electron-forge-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app. +When using [electron-winstaller][installer-lib] or [Electron Forge][electron-forge-lib] make sure you do not try to update your app [the first time it runs](https://github.com/electron/windows-installer#handling-squirrel-events) (Also see [this issue for more info](https://github.com/electron/electron/issues/7155)). It's also recommended to use [electron-squirrel-startup](https://github.com/mongodb-js/electron-squirrel-startup) to get desktop shortcuts for your app. The installer generated with Squirrel will create a shortcut icon with an [Application User Model ID][app-user-model-id] in the format of @@ -139,6 +139,6 @@ application starts. [squirrel-windows]: https://github.com/Squirrel/Squirrel.Windows [installer]: https://github.com/electron/grunt-electron-installer [installer-lib]: https://github.com/electron/windows-installer -[electron-forge-lib]: https://github.com/electron-userland/electron-forge +[electron-forge-lib]: https://github.com/electron/forge [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter diff --git a/docs/api/utility-process.md b/docs/api/utility-process.md index ed9b44af1a..2c228598de 100644 --- a/docs/api/utility-process.md +++ b/docs/api/utility-process.md @@ -132,7 +132,7 @@ Returns: Emitted when the child process sends a message using [`process.parentPort.postMessage()`](process.md#processparentport). [`child_process.fork`]: https://nodejs.org/dist/latest-v16.x/docs/api/child_process.html#child_processforkmodulepath-args-options -[Services API]: https://chromium.googlesource.com/chromium/src/+/master/docs/mojo_and_services.md +[Services API]: https://chromium.googlesource.com/chromium/src/+/main/docs/mojo_and_services.md [stdio]: https://nodejs.org/dist/latest/docs/api/child_process.html#optionsstdio [event-emitter]: https://nodejs.org/api/events.html#events_class_eventemitter [`MessagePortMain`]: message-port-main.md diff --git a/docs/tutorial/boilerplates-and-clis.md b/docs/tutorial/boilerplates-and-clis.md index f344ae1b25..68a7a5728f 100644 --- a/docs/tutorial/boilerplates-and-clis.md +++ b/docs/tutorial/boilerplates-and-clis.md @@ -24,7 +24,7 @@ development and release. They are more helpful and supportive but enforce guidelines on how your code should be structured and built. *Especially for beginners, using a command line tool is likely to be helpful*. -## electron-forge +## Electron Forge Electron Forge is a tool for packaging and publishing Electron applications. It unifies Electron's tooling ecosystem into a single extensible interface so that anyone can jump right into making Electron apps. diff --git a/docs/tutorial/forge-overview.md b/docs/tutorial/forge-overview.md index e297e700c4..0ec6872ce7 100644 --- a/docs/tutorial/forge-overview.md +++ b/docs/tutorial/forge-overview.md @@ -31,6 +31,6 @@ template and submit a new issue. [(package)]: https://www.electronforge.io/cli#package [(make)]: https://www.electronforge.io/cli#make [(publish)]: https://www.electronforge.io/cli#publish -[GitHub issue tracker]: https://github.com/electron-userland/electron-forge/issues +[GitHub issue tracker]: https://github.com/electron/forge/issues [discord]: https://discord.gg/APGC3k5yaH [tutorial]: https://www.electronjs.org/docs/latest/tutorial/tutorial-prerequisites diff --git a/docs/tutorial/notifications.md b/docs/tutorial/notifications.md index 3d3b5ff7ef..3a37dab622 100644 --- a/docs/tutorial/notifications.md +++ b/docs/tutorial/notifications.md @@ -138,4 +138,4 @@ GNOME, KDE. [notification-spec]: https://developer-old.gnome.org/notification-spec/ [app-user-model-id]: https://msdn.microsoft.com/en-us/library/windows/desktop/dd378459(v=vs.85).aspx [set-app-user-model-id]: ../api/app.md#appsetappusermodelidid-windows -[squirrel-events]: https://github.com/electron/windows-installer/blob/master/README.md#handling-squirrel-events +[squirrel-events]: https://github.com/electron/windows-installer/blob/main/README.md#handling-squirrel-events diff --git a/docs/tutorial/performance.md b/docs/tutorial/performance.md index d06a8220cf..e45e68a0e5 100644 --- a/docs/tutorial/performance.md +++ b/docs/tutorial/performance.md @@ -438,7 +438,7 @@ Call `Menu.setApplicationMenu(null)` before `app.on("ready")`. This will prevent [request-idle-callback]: https://developer.mozilla.org/en-US/docs/Web/API/Window/requestIdleCallback [multithreading]: ./multithreading.md [caniuse]: https://caniuse.com/ -[jquery-need]: http://youmightnotneedjquery.com/ +[jquery-need]: https://youmightnotneedjquery.com/ [service-workers]: https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API [webpack]: https://webpack.js.org/ [parcel]: https://parceljs.org/ diff --git a/docs/tutorial/snapcraft.md b/docs/tutorial/snapcraft.md index f87e4cf9af..c315e831cf 100644 --- a/docs/tutorial/snapcraft.md +++ b/docs/tutorial/snapcraft.md @@ -13,7 +13,7 @@ system modification. There are three ways to create a `.snap` file: -1) Using [`electron-forge`][electron-forge] or +1) Using [Electron Forge][electron-forge] or [`electron-builder`][electron-builder], both tools that come with `snap` support out of the box. This is the easiest option. 2) Using `electron-installer-snap`, which takes `electron-packager`'s output. @@ -162,7 +162,7 @@ building blocks. If you do not already have a `.deb` package, using `electron-installer-snap` might be an easier path to create snap packages. However, multiple solutions -for creating Debian packages exist, including [`electron-forge`][electron-forge], +for creating Debian packages exist, including [Electron Forge][electron-forge], [`electron-builder`][electron-builder] or [`electron-installer-debian`][electron-installer-debian]. @@ -239,7 +239,7 @@ apps: [snapcraft-syntax]: https://docs.snapcraft.io/build-snaps/syntax [electron-packager]: https://github.com/electron/electron-packager -[electron-forge]: https://github.com/electron-userland/electron-forge +[electron-forge]: https://github.com/electron/forge [electron-builder]: https://github.com/electron-userland/electron-builder [electron-installer-debian]: https://github.com/unindented/electron-installer-debian [electron-winstaller]: https://github.com/electron/windows-installer diff --git a/docs/tutorial/tutorial-4-adding-features.md b/docs/tutorial/tutorial-4-adding-features.md index b5fd630ed6..fc74559cee 100644 --- a/docs/tutorial/tutorial-4-adding-features.md +++ b/docs/tutorial/tutorial-4-adding-features.md @@ -63,7 +63,7 @@ into end users' hands. [discord]: https://discord.gg/electronjs -[github]: https://github.com/electron/electronjs.org-new/issues/new +[github]: https://github.com/electron/website/issues/new [how-to]: ./examples.md [node-platform]: https://nodejs.org/api/process.html#process_process_platform diff --git a/docs/tutorial/tutorial-6-publishing-updating.md b/docs/tutorial/tutorial-6-publishing-updating.md index a5a67e7683..f10c536968 100644 --- a/docs/tutorial/tutorial-6-publishing-updating.md +++ b/docs/tutorial/tutorial-6-publishing-updating.md @@ -222,8 +222,8 @@ rest of our docs and happy developing! If you have questions, please stop by our [code-signed]: ./code-signing.md [discord server]: https://discord.gg/electronjs [electron fiddle]: https://electronjs.org/fiddle -[fiddle-build]: https://github.com/electron/fiddle/blob/master/.github/workflows/build.yaml -[fiddle-forge-config]: https://github.com/electron/fiddle/blob/master/forge.config.js +[fiddle-build]: https://github.com/electron/fiddle/blob/main/.github/workflows/build.yaml +[fiddle-forge-config]: https://github.com/electron/fiddle/blob/main/forge.config.js [github actions]: https://github.com/features/actions [github publisher]: https://www.electronforge.io/config/publishers/github [github releases]: https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository