Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
AutoUpdater documentation lacks explanation of purpose #25887
Comments
I would like to work on this issue |
1 similar comment
I would like to work on this issue |
Please assign it to me for updation of documentation |
I would like to work on this issue. |
Preflight Checklist
Problem Description
As a graduate developer I have little experience with automated deployment. While learning autoUpdater the guide didn't explicitly say what autoUpdater is and what it is used for.
Proposed Solution
AutoUpdater guide should explain:
Example
An autoUpdater is an automated deployment system that regularly updates your users with the latest version of your application. The advantages of using an auto updater include:
Alternatives Considered
If the guide isn't edited, then new documentation should be added.
Additional Information
autoUpdater API documentation: https://www.electronjs.org/docs/api/auto-updater
autoUpdater guide: https://www.electronjs.org/docs/tutorial/updates
autoUpdater guide code: https://github.com/electron/electron/blob/master/docs/tutorial/updates.md