Migrate M2E documention to GH wiki

HannesWell commented 2 years ago

At the moment some documentation of M2E is provided at https://www.eclipse.org/m2e/documentation/m2e-documentation.html I think it would good to migrate that documentation into M2E's Wiki at GitHub and to update and extend it.

In general the documentation could be split into the following parts:

for Maven users Useful information for ordinary Maven users in the Eclipse IDE using M2E, tips&tricks, etc. like
- How to create a Project (with Archetype)
- How to launch a Maven build and some infos about the most important settings
- How to find dependencies in the Editor (maybe a Link to LemMinX)
- How to find connectors (and what even is that?)
- ...
for M2E-Extension and Connector developers Useful information for developers of M2E extensions and connectors
- Documentation of the M2E core API (do we even have more?) and maybe some small examples
- Also the migration guide suggested here: https://github.com/eclipse-m2e/m2e-core/issues/816
- Doc of the Lifecycle-Mapping-Metadata format
- ...
for Maven-plugin developers Useful information for those that develop Maven-plugins either in Eclipse+M2E or those that want to make their plug-in work well with M2E:
- Doc of embedded Lifecylce-Mapping-Metadata
- How to make my Plugin M2E compatible (i.e. use the BuildContext if doing File-IO): https://www.eclipse.org/m2e/documentation/m2e-making-maven-plugins-compat.html
- ...

mickaelistria commented 2 years ago

-1 for using yet-another-wiki. All experiences I've had with wikis have demonstrated they become too easily outdated, of low quality (because they don't promote review before merge), and hard to track who actually contributes to project. I prefer much having a documentation folder at the root of the project, and maybe publish it to GitHub sites or something else if browsing sources is not sufficient. That brings more capability to review and track contributions, and also can allow updating code and doc in the same PRs.

laeubi commented 2 years ago

I prefer much having a documentation folder at the root of the project, and maybe publish it to GitHub sites or something else

Why not using GH-Pages at the first place? https://pages.github.com/

Also the mentioned docs are rather "static" so having it at the wiki (witch you can also checkout/edit with git), might be equally appropriate and might be more accessible to the usual user.

HannesWell commented 2 years ago

Actually I don't care where the doc is located in the end. It just should be one place that is easily accessible for m2e committers and also allows others to contribute easily. This does not seem to be the case for the current website. That being said I agree with Mickael that it would be good to modify the content via PRs, which allows discussions about changes and at least informs others about changes (I get a email notifcation for a new PR in m2e, but I don't think I get this for the wiki?). If that also works with GH pages, I'm fine with that as well. :) I just have not yet used it until know so I'm not familiar with it.

kwin commented 2 years ago

The link https://www.eclipse.org/m2e/documentation/m2e-documentation.html and https://www.eclipse.org/m2e/documentation/m2e-making-maven-plugins-compat.html does no longer work. Where is the content previously available from the Eclipse wiki? Please make sure to set up proper redirects in case the documentation has been moved elsewhere.

HannesWell commented 2 years ago

The link https://www.eclipse.org/m2e/documentation/m2e-documentation.html and https://www.eclipse.org/m2e/documentation/m2e-making-maven-plugins-compat.html does no longer work. Where is the content previously available from the Eclipse wiki? Please make sure to set up proper redirects in case the documentation has been moved elsewhere.

We noticed that as well and were surprised too: https://github.com/eclipse-m2e/m2e-core/discussions/912#discussioncomment-3991686 That being said, proper redirects should be added, yes!

HannesWell commented 2 years ago

Can anyone clone the content of https://git.eclipse.org/c/www-deleted/m2e.git/ ? For me neither https nor ssh works.

I suggest that we contribute the current state of the site to this repo, then deploy it as it is to a new location and ask for a re-direct. @laeubi can you make some suggestions how do that, since you did that for Tycho? I have to admit I lost the overview.

laeubi commented 2 years ago

I can open tickets for infra but @fbricon need to approve them, about the git, I can download the last tag as a zip (missing some last changes) but not clone the repo. But maybe @mickaelistria has a more recent clone, alternatively one can use the tag-zip and download the patches from the missing commits and apply them locally.

laeubi commented 2 years ago

I have opened https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/2171

HannesWell commented 2 years ago

I have opened https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/2171

Thanks a lot!

I can open tickets for infra but @fbricon need to approve them, about the git, I can download the last tag as a zip (missing some last changes) but not clone the repo. But maybe @mickaelistria has a more recent clone, alternatively one can use the tag-zip and download the patches from the missing commits and apply them locally.

It is a bit strange. From the web-view I also have the impression that the content is actually still available. So lets hope that the Infra-team can fix it.

mickaelistria commented 1 year ago

Links are now working. Is there any action left to do?

HannesWell commented 1 year ago

I have opened https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/issues/2171

We now have https://github.com/eclipse-m2e/eclipse-m2e.github.io

eclipse-m2e / m2e-core

Migrate M2E documention to GH wiki #831