devfile-web e2e testing fails on documentation updates

[michael-valdron]

/kind bug

Which area is this bug related to?

/area landing-page

What versions of software are you using?

Node.js project

Operating System and version: Fedora 39

Node.js version: 18

Yarn version: 1.22.19

Project.json: N/A

Bug Summary

Describe the bug:

The e2e test check fails to pass if a PR is opened with doc page changes, the cause is the links check fails due to the Eclipse domain switch from eclipse.org to eclipse.dev. Though the old domain redirects to the new one, the check is considers this a broken URL.

To Reproduce:

1. Make a change to a doc page on your local branch
2. Install dependencies on your local workspace yarn install
3. Run yarn nx affected --target=e2e --configuration=production --parallel=1

Expected behavior

The e2e testing should pass if all changes given in the PR are valid, e.g. no broken links.

Any logs, error output, screenshots etc? Provide the devfile that sees this bug, if applicable

E2E error

-  /home/runner/work/devfile-web/devfile-web/dist/cypress/apps/landing-page-e2e/scr     (1280x720)
     eenshots/app.cy.ts/Docs -- Version 2.0.0 -- Section Get started -- Page Quick st               
     art with Eclipse Che -- has valid links (failed).png                                           
-  /home/runner/work/devfile-web/devfile-web/dist/cypress/apps/landing-page-e2e/scr     (1280x720)
     eenshots/app.cy.ts/Docs -- Version 2.0.0 -- Section Get started -- Page Developi               
     ng with devfiles -- has valid links (failed).png

Note: Error is misleading, the pages mentioned are correct however it is not image links that are failing to pass, its the eclipse.org links. See my comment for context.

Additional context

Any workaround?

Trivial fix is to update all eclipse.org links:

• libs/docs/src/docs/no-version/quickstart-che.md#L16
• libs/docs/src/docs/no-version/quickstart-che.md#L19
• libs/docs/src/docs/no-version/quickstart-che.md#L209
• libs/docs/src/docs/no-version/developing-with-devfiles.md#L22

Suggestion on how to fix the bug

I would say the workaround (trivial fix) is good enough to resolve this, however if we intend this to fail test case only if the links are broken, an investigation into how to consider redirect status as a valid test expectation is recommended.