search

ruflin / Elastica.io

Documentation for Elastica client
15 stars 30 forks source link

Update docs for 7.3 release #45

Open kstefanini opened 1 year ago

kstefanini commented 1 year ago

Docs is only for 7.0-beta but 7.3 is out

ruflin commented 1 year ago

Very good point. Recently we started to do more and more releases by just creating a release on Github and that's it. Historically I also went through the release checklist and did run the phpdocs command and published the new docs. By now, it is not just me anymore that does releases which is a great thing. But it also means we should add automation around this.

I'm challenging if the right place for docs is on Elastica.io still. Where should these phpdocs go to? Where do other libs host it?

@deguif @thePanz I'm sure you can also chime in here?

kstefanini commented 1 year ago

Maybe gh-pages branch could be a good place to host docs?

ruflin commented 1 year ago

That is where the page is already published ;-) https://github.com/ruflin/elastica/tree/gh-pages

ScarVite commented 1 month ago

any plans to get this up to date?

ruflin commented 1 month ago

Sorry for the delay here. I'll try to take care of it in the next days and hopefully figure out ways how to automate it more so it always happens automatically.

ruflin commented 1 week ago

Quick (late) update: The commands I used so far to generate this quickly do not work anymore, seems some lib updates broke it. Working on it but not fully on top of the priority list, hope you understand.

ruflin commented 1 week ago

For anyone following, I updated the docs build for 8.x: https://github.com/ruflin/Elastica/pull/2230 Backport to 7.x is in progress but seems something with the composer setup does not work anymore: https://github.com/ruflin/Elastica/pull/2231 Docs build locally again but also the publishing has a a few hickups, haven't done it for too long ;-)