Skip to content

Remove obsolete fragment identifier from IDE manual download link #1430

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

Merged
merged 1 commit into from
Sep 14, 2022
Merged

Remove obsolete fragment identifier from IDE manual download link #1430

merged 1 commit into from
Sep 14, 2022

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Sep 14, 2022

The Arduino IDE has an auto update capability (#797). A new version is checked for on every startup, and if available the user is offered an update.

Although this update can usually be done automatically by the IDE, under some conditions this is not possible. For example:

  • The IDE package in use does not support auto update (i.e., Linux ZIP package)
  • The file could not be downloaded due to a transient network service outage

In this case, the user is presented with a friendly dialog that explains the situation and links to the "Software" page on arduino.cc, where the user can manually download and install the new version:

image

Motivation

During the pre-release development phase of the project, the download links for Arduino IDE 2.x were on a sub-section of the "Software" page. For this reason, the linked URL included the fragment identifier #experimental-software so that the page would load scrolled down to the anchor at that section of the page.

With the 2.0.0 release, the Arduino IDE 2.x project has graduated to a production development phase. For this reason, the download links have been moved to the top of the "Software" page and the now inaccurate experimental-software anchor removed from the page.

The previous link with that fragment is still perfectly functional, but the fragment to a non-existent anchor serves no purpose and also miscommunicates the project status to users who notice the URL that was loaded.

Change description

Remove the obsolete fragment identifier from the software page URL.

Reviewer checklist

  • PR addresses a single concern.
  • The PR has no duplicates (please search among the Pull Requests before creating one)
  • PR title and description are properly filled.
  • Docs have been added / updated (for bug fixes / features)

The Arduino IDE has an auto update capability. A new version is checked for on every startup, and if available the user
is offered an update.

Although this update can usually be done automatically by the IDE, under some conditions this is not possible. For
example:

- The IDE package in use does not support auto update (i.e., Linux ZIP package)
- The file could not be downloaded due to a transient network service outage

In this case, the user is presented with a friendly dialog that explains the situation and links to the "Software" page
on arduino.cc, where the user can manually download and install the new version.

During the pre-release development phase of the project, the download links for Arduino IDE 2.x were on a sub-section of
the "Software" page. For this reason, the linked URL included the fragment identifier `#experimental-software` so that
the page would load scrolled down to the anchor at that section of the page.

With the 2.0.0 release, the Arduino IDE 2.x project has graduated to a production development phase. For this reason,
the download links have been moved to the top of the "Software" page and the now inaccurate `experimental-software`
anchor removed from the page.

The previous link with that fragment is still perfectly functional, but the fragment to a non-existent anchor serves no
purpose and also miscommunicates the project status to users who notice the URL that was loaded. For this reason, it is
hereby removed from the link.
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself labels Sep 14, 2022
@per1234 per1234 self-assigned this Sep 14, 2022
Copy link
Contributor

@kittaakos kittaakos left a comment

Choose a reason for hiding this comment

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

Thank you!

@per1234 per1234 merged commit 35fcfb8 into arduino:main Sep 14, 2022
@per1234 per1234 deleted the update-manual-download-link branch September 14, 2022 12:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants