search

plunkettscott / laravel-otel

Instant OpenTelemetry instrumentation for Laravel applications.
MIT License
19 stars 4 forks source link

Finish writing documentation #24

Open plunkettscott opened 5 months ago

plunkettscott commented 5 months ago

Finish writing documentation so that the documentation site may be published.

WildEgo commented 3 months ago

Hey are there any updates on this? Would highly appreciate an example on how to use the package itself even if a little bit in the readme.md.

Regards, Luis Bizarro

plunkettscott commented 3 months ago

Hey @WildEgo!

I'm working on getting docs and a quick demo app up before 1.0, but I don't have an ETA yet. For the most part, the package is plug-and-play once you've got it configured. The basic usage information in the README should help you get it installed, but it doesn't go into detail on configuration. For the most part, though, the configuration is well-documented on the config itself. I went with fully-typed configuration classes to aid in this.

With that being said, is there something specific you're looking for an example of? I can try to help here, but I'll also be sure to include it as an example in the docs.

WildEgo commented 3 months ago

Hey @WildEgo!

I'm working on getting docs and a quick demo app up before 1.0, but I don't have an ETA yet. For the most part, the package is plug-and-play once you've got it configured. The basic usage information in the README should help you get it installed, but it doesn't go into detail on configuration. For the most part, though, the configuration is well-documented on the config itself. I went with fully-typed configuration classes to aid in this.

With that being said, is there something specific you're looking for an example of? I can try to help here, but I'll also be sure to include it as an example in the docs.

My biggest issue was the fact that the service provider was not auto discovered so I had to manually add it to my bootstrap in my L11 app, at the moment I'm making my own scout watcher, tho that also means I need to implement my own meilisearch client.

I'd just add a bit about the provider in the docs and that's about it for now, everything else has been pretty easy to follow since everything is verbose.

plunkettscott commented 3 months ago

Glad to hear you've gotten it working so far, @WildEgo!

I've actually been thinking about a Scout watcher myself. If you're open to it, I'd accept a PR for that Watcher. If you have Discord and you want to chat about it feel free to reach out to me, I'm plscott0 on Discord.

Thanks for the documentation suggestions as well, I'll be sure to get that added.