The Wayback Machine - https://web.archive.org/web/20201129064644/https://github.com/electron/electron/issues/25887
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

AutoUpdater documentation lacks explanation of purpose #25887

Open
NathanielPather opened this issue Oct 11, 2020 · 4 comments
Open

AutoUpdater documentation lacks explanation of purpose #25887

NathanielPather opened this issue Oct 11, 2020 · 4 comments

Comments

@NathanielPather
Copy link

@NathanielPather NathanielPather commented Oct 11, 2020

Preflight Checklist

  • I have read the Contributing Guidelines for this project.
  • I agree to follow the Code of Conduct that this project adheres to.
  • I have searched the issue tracker for a feature request that matches the one I want to file, without success.

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:

  • what an autoUpdater is,
  • why I should use an autoUpdater,
  • advantages of using an autoUpdater

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:

  • Automating the update of your user applications,
  • Removing the need to download a new setup file for each update

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

@jayantchaudhary002
Copy link

@jayantchaudhary002 jayantchaudhary002 commented Oct 19, 2020

I would like to work on this issue

1 similar comment
@4tex
Copy link

@4tex 4tex commented Oct 22, 2020

I would like to work on this issue

@PurvaT
Copy link

@PurvaT PurvaT commented Oct 25, 2020

Please assign it to me for updation of documentation

@vipulmaheshwari09042001

I would like to work on this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
7 participants
@zcbenz @NathanielPather @4tex @jayantchaudhary002 @PurvaT @vipulmaheshwari09042001 and others
You can’t perform that action at this time.