apple / swift-distributed-tracing

Instrumentation library for Swift server applications
https://swiftpackageindex.com/apple/swift-distributed-tracing/main/documentation/tracing
Apache License 2.0
224 stars 34 forks source link

Add .spi.yml for Swift Package Index DocC support #72

Closed yim-lee closed 2 years ago

slashmo commented 1 year ago

@yim-lee I just checked, with this SPI configuration when you click on "Documentation" on the SPI website it takes you to the Instrumentation documentation instead of Tracing without any UI to switch to the Tracing documentation. Changing the path works, but IMHO we should definitely optimize for folks seeing the Tracing documentation first. I don't know if it's enough to flip the order of the documentation_targets array to do so.

yim-lee commented 1 year ago

@finestructure Please see slashmo's comment above. Is there a way for us to specify the "landing" target?

finestructure commented 1 year ago

That's down to the order - we're landing on the first target in the list IIRC!

finestructure commented 1 year ago

I can manually trigger a doc re-build out of turn to verify without waiting for the 24 cooldown, just let me know.

yim-lee commented 1 year ago

That's down to the order - we're landing on the first target in the list IIRC!

Oh great! Thanks for the quick response @finestructure!

yim-lee commented 1 year ago

@slashmo - opened https://github.com/apple/swift-distributed-tracing/pull/74

yim-lee commented 1 year ago

@finestructure Can you please trigger a rebuild? Thanks in advance! 🙏

finestructure commented 1 year ago

That's rebuilt with revision e8e428b6db9d2b1a4675feb5dbfbd947a7b5bc1c

finestructure commented 1 year ago

Ok, both are there, got confused by our own UX there for a sec and couldn't find the target switcher 😅🤔

CleanShot 2022-12-05 at 19 29 16@2x
yim-lee commented 1 year ago

Thanks @finestructure. You are awesome!

ktoso commented 1 year ago

Great, thanks everyone!