eclipse.platform.swt icon indicating copy to clipboard operation
eclipse.platform.swt copied to clipboard

[Edge] Add link to Edge FAQ with information on installing runtime #2000

Open HeikoKlare opened this issue 8 months ago • 12 comments

When the OS lacks a WebView2 runtime installation, an error is shown once a browser is initialized since Edge is used as the default browser on Windows. This change adds a link to the according FAQ page with information on how to install such a runtime to the error message.

Resolves https://github.com/eclipse-platform/eclipse.platform.swt/issues/2000

HeikoKlare avatar Apr 17 '25 19:04 HeikoKlare

Test Results

   545 files  + 6     545 suites  +6   30m 24s ⏱️ -14s  4 373 tests +37   4 361 ✅ +35   12 💤 +3  0 ❌  - 1  16 634 runs  +37  16 520 ✅ +35  114 💤 +3  0 ❌  - 1 

Results for commit f99dc956. ± Comparison against base commit 2a00032e.

github-actions[bot] avatar Apr 17 '25 19:04 github-actions[bot]

Is GitHub raw file access supposed to be the "official" location of the FAQ now?

Or should this be published to https://eclipse.dev/eclipse/swt/faq.html somehow?

sratz avatar Apr 22 '25 11:04 sratz

Is GitHub raw file access supposed to be the "official" location of the FAQ now?

Yes. Most of the FAQs were part of the wiki and the wiki entries have been migrated to Markdown. I would suggest to move the relevant entries of the https://eclipse.dev/eclipse/swt/faq.html also to the FAQ md.

Or should this be published to https://eclipse.dev/eclipse/swt/faq.html somehow?

vogella avatar Apr 22 '25 11:04 vogella

May be we could forward https://eclipse.dev/eclipse/swt/faq.html to the GitHub raw file to at least keep the existing link point to the most up-to-date FAQ?

HeikoKlare avatar Apr 22 '25 11:04 HeikoKlare

May be we could forward https://eclipse.dev/eclipse/swt/faq.html to the GitHub raw file to at least keep the existing link point to the most up-to-date FAQ?

Hmm, there are many more SWT-specific FAQ entries in that list than we have under

https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/

So we'd lose a lot of information.

I think we would need to migrate all SWT FAQ entries that are still relevant there to markdown.

sratz avatar Apr 22 '25 13:04 sratz

Hmm, there are many more SWT-specific FAQ entries in that list than we have under

https://github.com/eclipse-platform/eclipse.platform/tree/master/docs/FAQ/

So we'd lose a lot of information.

I think we would need to migrate all SWT FAQ entries that are still relevant there to markdown.

Yeah, right. I actually meant to add a redirect once everything has been migrated. But to be honest, I was not aware that there is still so much information to be migrated (I thought that most of it was already done).

HeikoKlare avatar Apr 24 '25 07:04 HeikoKlare

I was not aware that there is still so much information to be migrated (I thought that most of it was already done).

IIRC the information on the wikis were migrated (as the wiki was going down), so far not the rest.

vogella avatar Apr 24 '25 07:04 vogella

FYI, I'm currently trying to make sense of what's all there (documentation in the form of *.md) in different repositories. I am also experimenting with client-side markdown rendering such that it's possible to embed the *.md content within the website. E.g., here we have a page that uses the query parameter file= to read the markdown file (via api.github.com) and render it locally:

image

I'm also looking to generate a list of a folder's contents (so that we don't have to maintain an index):

image

As a result, I stumbled upon this

https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/FAQ.md

I noticed that the very first link on this page is broken:

https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/FAQ/The_Official_Eclipse_FAQs.md

@vogella Can docs/FAQ.md be deleted given we have docs/FAQ/The_Official_Eclipse_FAQs.md?

In any case, I hope to make it easier to find and navigate this valuable content much of which @vogella helped migrate...

merks avatar Apr 24 '25 07:04 merks

@vogella Can docs/FAQ.md be deleted given we have docs/FAQ/The_Official_Eclipse_FAQs.md?

It is not the same content in https://github.com/eclipse-platform/eclipse.platform/blob/master/docs/FAQ.md

In theory someone would have to go though it, check if the entries are still relevant and move them to the other FAQ.I did some clean-up in this document but ran (way) out of time.

vogella avatar Apr 24 '25 08:04 vogella

I see. So we have 3 different FAQ sources, none of which are known to be complete. 😱 Oh well, one step at a time.

merks avatar Apr 24 '25 08:04 merks

FYI, the links from the website are live. As such, there are these now:

  • https://eclipse.dev/eclipse/markdown/index.html?file=eclipse-platform/eclipse.platform/master/docs/FAQ.md
  • https://eclipse.dev/eclipse/markdown/index.html?file=eclipse-platform/eclipse.platform/master/docs/FAQ/The_Official_Eclipse_FAQs.md
  • https://eclipse.dev/eclipse/swt/faq.html
  • https://eclipse.dev/eclipse/markdown/index.html?file=eclipse-platform/eclipse.platform/master/docs/FAQ/The_Official_Eclipse_FAQs.md#standard-widget-toolkit-swt

It's a bit of a hodgepodge for which no one has the time nor inclination to fix it all.

merks avatar Apr 24 '25 21:04 merks

  • https://eclipse.dev/eclipse/swt/faq.html

First link here seems also outdated it still points to https://bugs.eclipse.org/bugs/enter_bug.cgi?product=Platform&component=SWT and the first entry explains in details what to put into the Bugzilla issue. Also scrolling throw the SWT FAQ shows tons of outdated entries, like: "What do I need to run the SWT Browser inside Eclipse on Solaris?" or "Why do I get strange drawing behaviour when running 32 bit Eclipse on a 64 bit GTK platform?".

Maybe a first step would be to delete the obvious obsolete entries in the SWT FAQ. (I'm not planning to do this, but I assume that would be a relative quick thing to do for an active SWT developer).

vogella avatar Apr 25 '25 07:04 vogella

Superceded by https://github.com/eclipse-platform/eclipse.platform.swt/pull/2065

HeikoKlare avatar May 13 '25 08:05 HeikoKlare