Migration of https://wiki.eclipse.org/PDE/UI/SourceReferences

[vogella]

Additional changes:

• Standardized headings to ATX style (#, ##, ###).
• Converted indented code blocks and inline code with complex content to
  triple-backtick fenced code blocks with language hints (xml, properties,
  text).
• Fixed a broken/messy inline link within the Eclipse-SourceReferences
  example.
• Removed unnecessary backslash escaping in XML comments.
• Removed the manual Table of Contents as it is synthesized by the website.
• Reformatted paragraphs to start each sentence on a new line for easier
  future editing.

[github-actions]

Test Results

  147 files  ±0    147 suites  ±0   36m 5s ⏱️ -10s
3 497 tests ±0  3 443 ✅ ±0   54 💤 ±0  0 ❌ ±0 
9 312 runs  ±0  9 182 ✅ ±0  130 💤 ±0  0 ❌ ±0 

Results for commit 254e8df. ± Comparison against base commit 1aece37.

♻️ This comment has been updated with latest results.

[merks]

Given both the GitHub page and the website markdown renderer synthesize a table of contents, wouldn’t it be better to omit it?

For future editing it would be better if a paragraph were not one huge long line. Better would be each sentence start on a new line.

[merks]

Thank you. That’s much nicer!

[laeubi]

Image files are actually text files that show 404 not found

[merks]

I thought it was just my bad internet on my phone.

[vogella]

Looks like I did not update the image URl in my script... Update will be posted soon

[vogella]

URLs like https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Repo-import-1.png will currently still go 404 as the images has not yet been committed.

[laeubi]

URLs like https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Repo-import-1.png will currently still go 404 as the images has not yet been committed.

Why not using a relative URL so one can review the results right in this PR?

[vogella]

URLs like https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Repo-import-1.png will currently still go 404 as the images has not yet been committed.

Why not using a relative URL so one can review the results right in this PR?

IIRC this did not work with raw display.

[laeubi]

URLs like https://raw.githubusercontent.com/eclipse-pde/eclipse.pde/master/docs/images/Repo-import-1.png will currently still go 404 as the images has not yet been committed.

Why not using a relative URL so one can review the results right in this PR?

IIRC this did not work with raw display.

I'm not sure what we are talking about here? Github markdown does not need any "raw" links... see for example https://github.com/eclipse-m2e/m2e-core/blob/main/README.md that has ![M2E-Banner](assets/m2e-Banner.svg) as a reference to an image inside the repo.

Also the images itself still seem broken, looking at https://github.com/vogella/eclipse.pde/blob/a77c21af15818bf5fff7ec5550747d64bac3fa51/docs/images/Repo-import-1.png it still shows me a textfile that contains the text "Not found".

Also github complains:

[vogella]

https://github.com/eclipse-pde/eclipse.pde/blob/master/docs/SourceReferences.md renders fine, please feel free to continue improving the page.

[HannesWell]

Thank you Lars for the immediate addition.
I've already incorporated it into

• Fix links and metadata in template HTML files eclipse-cbi/p2repo-analyzers#62

[merks]

When you force pushed the last change it appears that you undid the changes to remove the TOC and went back to long one-line paragraphs.