search

ggrossetie / antora-lunr

Integration of Lunr in Antora
MIT License
66 stars 26 forks source link

docs: update README to clarify move #139

Closed thor closed 3 years ago

thor commented 3 years ago

Quick and relatively dirty attempt at clarifying the move. Hopefully it conveys the point that activity continues, just not here.

mojavelinux commented 3 years ago

My only concern is how we handle the transition period. We should not be promoting the extension for general purpose use until Antora 3 is final. Until then, it should be intended for testing and evaluation only. I don't think it's right to say that the repository is archived until that time. What it should say instead is...

if you are preparing to migrate to Antora 3, and you're using the Lunr integration, then you should also be testing the extension instead of the integration in this repository. Once Antora 3 is released, this repository will go into maintenance mode for users who have not yet transitioned from Antora 2 to Antora 3. After some time, the repository will be archived.

Let's not scare users ;)

ggrossetie commented 3 years ago

That's a good point. Indeed, the following sentence may sound scary: "This repository is no longer maintained and has been archived" 😱

thor commented 3 years ago

Great point. Absolutely, the original suggestion seemed to come across as scarier than necessary. (And not just a little bit.)

I liked your suggestion, @Mogztter, and thought it was friendlier and yet equally, if not more, informative. :)

mojavelinux commented 3 years ago

That rephrasing looks great to me! Nice work.

ggrossetie commented 3 years ago

Thanks again @thor 🤗