Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Dec 3, 2022
Merged

Conversation

yim-lee
Copy link
Member

@yim-lee yim-lee commented Dec 2, 2022

No description provided.

.spi.yml Outdated
version: 1
builder:
configs:
- documentation_targets: [Tracing]
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not very familiar with the Swift package index yet and its DocC support, but would this also surface the documentation from the Instrumentation target given that Tracing depends on it, or would we want to declare both as documentation_targets here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess I am not sure either. Let me include it just in case.

@yim-lee yim-lee merged commit 2b1879f into main Dec 3, 2022
@yim-lee yim-lee deleted the yim-lee-patch-1 branch December 3, 2022 17:30
@slashmo
Copy link
Collaborator

slashmo commented Dec 5, 2022

@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
Copy link
Member Author

yim-lee commented Dec 5, 2022

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

@finestructure
Copy link

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

@finestructure
Copy link

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
Copy link
Member Author

yim-lee commented Dec 5, 2022

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
Copy link
Member Author

yim-lee commented Dec 5, 2022

@slashmo - opened #74

@yim-lee
Copy link
Member Author

yim-lee commented Dec 5, 2022

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

@finestructure
Copy link

That's rebuilt with revision e8e428b

@finestructure
Copy link

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
Copy link
Member Author

yim-lee commented Dec 5, 2022

Thanks @finestructure. You are awesome!

@ktoso
Copy link
Member

ktoso commented Dec 6, 2022

Great, thanks everyone!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants