-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Migrate JDT wiki pages #54
Comments
Note that the converter has a problem with
So the
I'll look into changing the wiki pages so this is not necessary. |
Looks like nothing is done for images. E.g.: https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/Concurrency-related_refactorings_for_JDT.md While the original is: https://wiki.eclipse.org/Concurrency-related_refactorings_for_JDT
I guess I'll have to ask about this in the |
I wrote a small crawler to download the images. Local disk paths have to be adjusted, of course.
|
@iloveeclipse can you check this? https://github.com/trancexpress/eclipse.jdt/tree/gh54/wiki We have the files now, we probably want to check each page for obvious problems. But first, how do we want to structure the wiki? Do we want to place project specific pages in the projects repository? E.g. JDT core topics in the JDT core repository? Or do we want all pages in this repository, like I've done on my fork and branch? Please involve whoever you think is active to decide this. |
Note that there are some hard-coded links to the wiki within the wiki pages (i.e. the full webpage address is in the |
Simeon, looking on the converted result, I think we want only jdt core part converted, which would inclide That should be inside https://github.com/eclipse-jdt/eclipse.jdt.core/wiki repo. We can also check individually if something can be migrated to JDT UI/Debug repos, but so far the pages I've seen are only about very old plans and have no practical use anymore. However, if I look at https://wiki.eclipse.org/Category:JDT and under some of the pages referenced there, I miss some content in the "converted" repo. E.g. missing :
Looking on above, it looks like entry pages are missing in general. |
If I may suggest these outdated UI/Debug wiki pages to be stripped of the outdated content whenever seen as that has huge impact when searching for smth. |
https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Code_Setup_Using_Oomph.md
https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Core.md
https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Core/Null_Analysis.md
https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT/FAQ.md What is missing? |
I'm not sure you understand the structure after the converting, there are a lot more articles. The folders are a result of nested pages. Most JDT pages are in the directory as I think it will be more simple if you point to the wiki pages you want to have, from https://wiki.eclipse.org/Category:JDT. Just the names copied from the list will be enough, or call me if you want to show which ones; it will likely save time. |
OK, I've expected to see entry pages inside the matching directory, but they seem to be placed one level higher. E.g. https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Core_Programmer_Guide.md points to https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Core_Committer_FAQ which is not there, but at https://github.com/trancexpress/eclipse.jdt/blob/gh54/wiki/JDT_Core_Committer_FAQ.md |
No idea, this is all generated by |
Another thing I see that is not good, the converter tool replaces empty spaces with |
@iloveeclipse I think we'll have to prune the pages we are adding from outdated information (where we can tell the information is outdated, at least). IMO better to not have the pages than add something so outdated as e.g. explaining how |
I would separate things that are "trivial" to prune (like simply not including entire pages) from non-trivial ones, where some parts of the page have to be reviewed carefully. So to get things done, I would propose to avoid non-automated content editing as much as possible, so we have one big "move" step where it's easy to review the content by checking old/new page, considering only "automated" changes are applied to content. Once we have the content in the wiki, one can go through the pages one by one, manually throwing away obsoleted parts. |
Sure, but lets do that while the wiki contents are on my fork. Before they go "live" in JDT. |
Also there I personally would find it easier to review the first "big" move without manual edits. |
I'm not sure what you mean. You want the full contents on the JDT core wiki (and not just on my fork) and then we prune it from old information? Or you want to review the "freshly generated" |
My assumption was that the automated "migration" is one step, manual editing & polishing is anoher one. In which repo it is done I don't care, I assume in yours would be easier for you. |
I've already started the manual work, though it won't be in a separate commit (I'm amending and force pushing). The automated content is up though: https://github.com/trancexpress/eclipse.jdt.core/wiki Its just full of dead links and missing images. |
@trancexpress : thanks for this crawler, I did some improvements to make it work for exporting the EGit wiki.
|
Sure, no problem.
3-clause BSD is fine with me, but choose whichever license you think fits best - you are uploading the code after all. |
Initial version by Simeon Andreev (@trancexpress) posted here eclipse-jdt/eclipse.jdt#54 (comment)
I pushed the repo to https://github.com/msohn/EclipseWikiCrawler |
See: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/681
Essentially we'll try the automatic process: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/681#note_414703
Aiming to convert everything under: https://wiki.eclipse.org/Category:JDT
There is also the question of whether we can link the old wiki pages to the new ones, assuming the old wiki pages will be archived.
The text was updated successfully, but these errors were encountered: