lucenenet-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [lucenenet] NightOwl888 commented on issue #399: Docs: Add migration guide
Date Mon, 22 Mar 2021 21:30:38 GMT

NightOwl888 commented on issue #399:
URL: https://github.com/apache/lucenenet/issues/399#issuecomment-804408933


   @Shazwazza
   
   > Would be easy to just convert this to something usable manually. But we should include
this file for copying/conversion in the html/markdown tool so that if/when it changes in lucene
and we make a new major version the conflicts are detected and we do a merge
   
   Looks like the tool that I made into a `dotnet` CLI installable command (https://github.com/NightOwl888/lucenenet-javadoc2markdown)
isn't yet in use in the scripts and the (older) `JavaDocToMarkdownConverter` is still in the
main repo, and still exists in the "converted" branch https://github.com/apache/lucenenet/tree/docs/markdown-converted/4.8.1/src/docs.
I just wanted to make you aware of it so we don't have multiple ever-diverging copies. I don't
want to delete it from the repo, since the script still depends on it, but we should change
that.
   
   Basically, that tool is now versioned in a NuGet package so you can specify a specific
version in the script, or not specify a version and always get the latest copy from NuGet.
The latter option isn't available to us by keeping the tool side-by-side in the same branch
as the build script. The thought is when we update the tool, those updates should be carried
across all of the "converted" branches, so the tool definitely shouldn't exist in that branch.
If for some reason we need to lock it at a specific version, that can also be done by specifying
the version explicitly.
   
   We don't have to keep the tool on GitHub - we should move it over to an Apache Git repo
so everyone involved in the project can push updates to it. I have named it accordingly, so
it should be easy to do. I guess moving the repo could be done at any point, but deleting
the copy out of the `master` and `docs/markdown-converted/4.8.1` branches should be done ASAP.
   
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



Mime
View raw message