eclipse-platform
Fix dead case studies link and preserve archived RCP case studies content with screenshots
Problem
The "Case Studies" section in docs/Rich_Client_Platform.md contained a broken link to https://www.eclipse.org/community/rcpcp.php, which returns a 404 error. This page appears to have been removed or relocated on the Eclipse website, resulting in the loss of valuable historical information about commercial RCP applications.
Solution
-
Created
docs/RCP_Case_Studies.md- A new markdown file containing the archived content from the web archive (last captured February 12, 2024). This preserves the historical case studies information that was previously lost. -
Updated
docs/Rich_Client_Platform.md- Modified the Case Studies section to link to the new local file and also reference the current Eclipse Community page for up-to-date information. -
Added application screenshots - Extracted and included 51 screenshot images from the archived content to provide visual representations of each RCP application.
Changes
- Created new file
docs/RCP_Case_Studies.md(473 lines) with archived commercial RCP applications case studies - Updated
docs/Rich_Client_Platform.mdto link toRCP_Case_Studies.mdinstead of the dead URL - Added reference to the current Eclipse Community page for users seeking current information
- Created
docs/images/rcp_case_studies/directory containing 51 screenshot images (816KB total) - Integrated screenshots into the markdown document for each application entry
Content Preserved
The archived case studies document includes descriptions and screenshots for 50+ commercial RCP applications including:
- AB ZealCore System Debugger
- Actuate BIRT Report Designer
- AlterPoint DeviceAuthority
- Applied Biosystems Sequence Scanner Software
- And many more commercial Eclipse RCP applications
Justification
This approach:
- Preserves historical case studies content that would otherwise be lost
- Provides users with valuable information about RCP applications and use cases, enhanced with visual screenshots
- Maintains a reference to the current Eclipse Community page for up-to-date information
- Follows the suggestion from the issue to archive the content locally
- Includes images as requested in code review feedback, making the documentation more engaging and informative
Fixes eclipse-platform/eclipse.platform.ui#3391
Original prompt
This section details on the original issue you should resolve
<issue_title>Documentation Invalid "case studies" Link ?</issue_title> <issue_description>In the documentation, the link for the case studies is dead (404): https://github.com/eclipse-platform/eclipse.platform.ui/blob/80643f01a5c44deba501be12972bbdb9d67ec56b/docs/Rich_Client_Platform.md?plain=1#L17C9-L17C9
Was it moved elsewhere ?</issue_description>
Comments on the Issue (you are @copilot in this section)
Fixes eclipse-platform/eclipse.platform.ui#3391
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.
@copilot can you recover the information from the web-archive here: https://web.archive.org/web/20240601000000*/https://www.eclipse.org/community/rcpcp.php and store it in a new mad file in the docs f...
I'm unable to access the web archive URL from this environment due to network restrictions (the domain appears to be blocked). To proceed with creating the markdown file with the archived content, I would need either:
- The archived content provided directly, or
- A snapshot/export of the web archive page content, or
- Access to be granted to web.archive.org
Could you provide the archived content from https://web.archive.org/web/20240601000000*/https://www.eclipse.org/community/rcpcp.php, or would you prefer a different approach?
[!WARNING]
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
web.archive.org
- Triggering command:
curl -s REDACTED*/REDACTED(dns block)- Triggering command:
curl -s REDACTED(dns block)If you need me to access, download, or install something from one of these locations, you can either:
- Configure Actions setup steps to set up my environment, which run before the firewall is enabled
- Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)
@copilot I saved a dump here rcp_website_dump.zip does it work?
Yes, that worked perfectly! I've successfully created docs/RCP_Case_Studies.md with the archived content from the dump. The file contains the commercial RCP applications case studies that were previously at the dead URL. I've also updated docs/Rich_Client_Platform.md to link to this new file. Changes committed in d9e4edf.
We're missing the images/screenshots, which are very useful ("a picture is worth a thousand words")
@copilot can you add the preview images as well to the markdown? For what it might helps, the full URL with the content can also be found here: https://web.archive.org/web/20240212113300/https://www.eclipse.org/community/rcpcp.php
Apart from that how specifically one would configure copilote to allow it to access the https://web.archive.org page?
@copilot can you add the preview images as well to the markdown? For what it might helps, the full URL with the content can also be found here: https://web.archive.org/web/20240212113300/https://www.e...
I've added all 51 preview images/screenshots to the markdown file. The images are now stored in docs/images/rcp_case_studies/ and referenced in the case studies document. Each application entry now includes its screenshot where available. Changes committed in the latest commit.
Regarding web.archive.org access: The environment I work in has network restrictions that block certain domains. Access would need to be configured at the infrastructure level, which is outside my control.
@mickaelistria should we merge this? It seems not we are making progress in restore the content in the near future...
I don't think we should merge this as it's incomplete (some other interesting pages are missing) and since such "marketing"/non-technical content might better be handled by the IDE WG. We should IMO let resolution happen on https://gitlab.eclipse.org/eclipsefdn/software-dev/websites/eclipseide.org/-/issues/120 .