Proposal: Update and Modernize "Eclipse Corner" as Eclipse Platform Knowledgebase
Eclipse Corner has a list of partly very old but also very good articles helping people extending the Eclipse Platform or writing RCPs. While the information is still valid it has a dated look and also many links are broken or should point to different locations (e.g., latest Eclipse help).
I would volunteer to bring all these articles to a modern Eclipse Hugo style web-page, update the links and where it is necessary also update content (e.g., new screenshots). In order to test this I did a first PoC on my machine where I created a Hugo page using the Eclipse IDE web-page theming, with a landing page containing article groups, an overview page per article group, and one article converted. The results look good and it should be pretty straight forward to do it.
However there are a few questions that I think should be clarified upfront:
-
Is this legally possible? Are there copyright headers required? Can the dates be removed?
-
Should the existing file/folder structure be preserved to not break any existing links (e.g., from tutorials like the Vogella tutorials), or should for the old pages forwards to the new ones be created? Both is technically possible but the first one may affect the navigation and look and feel a bit.
-
Where and how should the "Eclipse Platform Knowledgebase" be hosted. Options are: a. As part of the eclipse.org hugo page as hugo subpage b. as part of eclispeide.org as hugo subpage (here it would fit better and at least a link to Eclipse Platform Knowledgebase should be added to the resource menu) c. Own hugo page, either located at the existing address or a new one
The last option gives the most flexibility especially regarding navigation, the first and last are the only ones that allow to preserve the file and folder structure. Option b would be as said the best place.
-
While the articles can be transferred to Hugo Markdown I got the better results translating the articles themselves to ascidoc. For that #6150 (closed) needs to be sorted out. But I think we are nearly there.
I think at that point it should be mentioned that not all articles have to be migrated at once. This can be done in a step by step approach. Only the landing and grouping pages would need to be done first. This would also fit my availability for this proposal.
PS: https://www.eclipse.org/articles/ is currently redirecting to a file in the platform ui documentation. This files gives a very nice overview on available the articles. PPS: I should also point out that by now I have quite some ascidoc knowledge not only did I finish the first conversion of the Eclipse UI Guidelines after export from the Eclipse Wiki, I also converted the full Eclipse 4diac documentation and I'm heavily involved in the Eclipse 4diac Hugo web-page where we are using quite advanced features of the eclipse theme.