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

Generate PrebidMobile Documentation #1034

Merged
merged 38 commits into from
Oct 3, 2024
Merged

Conversation

OlenaPostindustria
Copy link
Collaborator

@OlenaPostindustria OlenaPostindustria commented Aug 5, 2024

@OlenaPostindustria OlenaPostindustria force-pushed the 990/generate-documentation branch from 69653a3 to a9a2754 Compare August 21, 2024 14:21
@YuriyVelichkoPI YuriyVelichkoPI force-pushed the 990/generate-documentation branch from 7cabbda to 609bf41 Compare September 24, 2024 13:11
@YuriyVelichkoPI YuriyVelichkoPI force-pushed the 990/generate-documentation branch from cd3be8b to 630602e Compare September 25, 2024 10:10
@YuriyVelichkoPI YuriyVelichkoPI marked this pull request as ready for review September 25, 2024 13:16
.github/workflows/upload-docs-ios.yml Outdated Show resolved Hide resolved
@bretg
Copy link
Contributor

bretg commented Sep 26, 2024

Thanks for checking the docs_new directory size. Does this generate docs on every commit, on merge to master, or on release? I would think that on-release is what we'd want.

I propose that we merge this when happy, then wait for a release to happen to test the update script before placing the links around docs.prebid.org.

@OlenaPostindustria
Copy link
Collaborator Author

Does this generate docs on every commit, on merge to master, or on release? I would think that on-release is what we'd want.

Documentation generation starts when a tag is pushed(f.e., 1.0.0), so it happens on release.

Copy link
Contributor

@YuriyVelichkoPI YuriyVelichkoPI left a comment

Choose a reason for hiding this comment

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

LGTM

@YuriyVelichkoPI YuriyVelichkoPI requested review from bretg and removed request for bretg September 30, 2024 06:32
Copy link
Contributor

@bretg bretg left a comment

Choose a reason for hiding this comment

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

My review was limited to the workflow script. My take is this can be released when ready. We're not going to link to the results until after the next SDK release after confirming the release did the right thing to the documentation repo.

thanks!

@YuriyVelichkoPI YuriyVelichkoPI merged commit a20b62e into master Oct 3, 2024
4 checks passed
@YuriyVelichkoPI YuriyVelichkoPI deleted the 990/generate-documentation branch October 3, 2024 13:52
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.

Investigate creating API documentation for iOS Prebid SDK
3 participants