Migrate Wiki Content to the Tycho Docs
laeubi opened this issue · 19 comments
The Wiki will go away some time and we should therefore decide what is worth being migrated:
@vogella do you like to migrate that part? It also could need an update e.g. according to how use CI Friendly versions / pomless in that process.
Did you decide already to which structure this information should go?
@vogella do you like to migrate that part? It also could need an update e.g. according to how use CI Friendly versions / pomless in that process.
I can try. Where should it go?
If you open https://tycho.eclipseprojects.io/doc/master/index.html you see whe have the automatic generated docs for the mojos, but also custom content like:
https://tycho.eclipseprojects.io/doc/master/TestingBundles.html
this is sourced by https://github.com/eclipse-tycho/tycho/tree/master/src/site/markdown
so one could add a new Deployment.md (don't forget to link it in the menu) that describes different deployment options (including maven repository).
That has the advantage that it can be adjusted when new feature are added alongisde with the code and get published together with the tycho release.
What about https://wiki.eclipse.org/Tycho/FAQ?
Also to documentation or better to a FAQ.md in the repo?
For FAQ I think its a bit more challenging:
- Some item might better get into the documentation of the mojo
- Some might be worth to add to the Wiki if they are generic https://github.com/eclipse-tycho/tycho/wiki
- Some that are really Q/A can go to the discussions as one discussion each and adding the answer as an answer afterwards https://github.com/eclipse-tycho/tycho/discussions/categories/q-a that has the advantage that other users can give potentially different answers/approaches
(but be aware that they need to be carefully reviewed as some are outdated)
For FAQ I think its a bit more challenging:
- Some item might better get into the documentation of the mojo
- Some might be worth to add to the Wiki if they are generic https://github.com/eclipse-tycho/tycho/wiki
- Some that are really Q/A can go to the discussions as one discussion each and adding the answer as an answer afterwards https://github.com/eclipse-tycho/tycho/discussions/categories/q-a that has the advantage that other users can give potentially different answers/approaches
(but be aware that they need to be carefully reviewed as some are outdated)
I could transfer is over to the wiki and any rework could be done there. The desire for a perfect solution usually leads to nothing at all.
Let me know, if the transfer approach is not good for you, I would leave to others to do the transfer.
@vogella thanks for the previous migrations, I merged them now.
For the FAQ, as said a minimal step would be to clean out outdated stuff so one need to review the entries, it does not make sense to migrate stuff like DS/Testing for example that are simply wrong these days and we already have better documentation for that. Also most items regarding Eclipse/m2e are outdated and mention very very old versions or plugins...
@vogella thanks for the previous migrations, I merged them now.
For the FAQ, as said a minimal step would be to clean out outdated stuff so one need to review the entries, it does not make sense to migrate stuff like DS/Testing for example that are simply wrong these days and we already have better documentation for that. Also most items regarding Eclipse/m2e are outdated and mention very very old versions or plugins...
Yeah, that is fine, I can do that.
Started FAQ migration for one entry (mirror), I removed it in the old wiki after adding it to the new wiki (and updating it a bit). Feel free to review or migrate more entries https://github.com/eclipse-tycho/tycho/wiki/Frequently-asked-questions
When is https://tycho.eclipseprojects.io/doc/latest/ updated? Looks like the changes did not make it yet.
When is https://tycho.eclipseprojects.io/doc/latest/ updated? Looks like the changes did not make it yet.
If you look at the latest commit in master publishing docs failed https://github.com/eclipse-tycho/tycho/actions/runs/6966338262/job/18956344509
When is https://tycho.eclipseprojects.io/doc/latest/ updated? Looks like the changes did not make it yet.
If you look at the latest commit in master publishing docs failed https://github.com/eclipse-tycho/tycho/actions/runs/6966338262/job/18956344509
Thanks, will fix this.
When is https://tycho.eclipseprojects.io/doc/latest/ updated? Looks like the changes did not make it yet.
If you look at the latest commit in master publishing docs failed https://github.com/eclipse-tycho/tycho/actions/runs/6966338262/job/18956344509
Thanks, will fix this.
Looks like the build was successful https://github.com/eclipse-tycho/tycho/actions/runs/6968230498 but still looks old https://tycho.eclipseprojects.io/doc/latest/PackagingTypes.html
After deployment it takes soem time util GH pages are synced, see here:
https://github.com/eclipse-tycho/eclipse-tycho.github.io/actions
Just noticed: latest > latest release, your change is visible here:
https://tycho.eclipseprojects.io/doc/master/TargetPlatform.html
Hi,
I've merged this page https://wiki.eclipse.org/Tycho/pomless into this page https://github.com/eclipse-tycho/tycho/wiki/Tycho-Pomless.
You might want to protect your wiki pages and enable edition by pull request only.
I fixed formatting and spelling, but couldn't tell if the actual content is up to date.
Could you please review this page ?
Thanks.