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

RAD-1766: Docs for adding a bidder adapter to Prebid Server #324

Merged
merged 3 commits into from
Aug 17, 2017

Conversation

rmloveland
Copy link
Contributor

No description provided.

@rmloveland
Copy link
Contributor Author

@mjacobsonny and @dbemiller would appreciate a review on this draft from you guys. Matt since you're the guy who requested the work, and Dave since it looks like you did some code docs in adapter.go (which we paraphrase here and point the reader to as the authority).

@dbemiller
Copy link
Contributor

dbemiller commented Aug 14, 2017

Looks fairly accurate overall... but one super important missing step: Adapters also have to be added to setupExchanges before PBS will know about them. See https://github.com/prebid/prebid-server/blob/master/pbs_light.go#L634

Perhaps an equally important question... given that we know we want to move the site docs into PrebidJS (to avoid sync issues), do you want to repeat the same pattern with Prebid Server too?

Or do you think it makes more sense to just start with a .md file in prebid-server, and then direct the prebid.org link there?

@rmloveland
Copy link
Contributor Author

rmloveland commented Aug 15, 2017

@dbemiller Thanks for the review, and for your comments! Really appreciate the attention to detail. Responses below:

Looks fairly accurate overall... but one super important missing step: Adapters also have to be added to setupExchanges before PBS will know about them. See https://github.com/prebid/prebid-server/blob/master/pbs_light.go#L634

Ach! Will add that as the final step. Thanks.

Perhaps an equally important question... given that we know we want to move the site docs into PrebidJS (to avoid sync issues), do you want to repeat the same pattern with Prebid Server too?

Eventually yes. For right now I'll probably just finish up this page on Prebid.org (mostly due to bandwidth). Probably gonna focus on getting the Prebid.js API docs into shape first before embarking on a similar project PBS-side.

Once Prebid.js is looking good in terms of a good process for updating API docs, building and syncing them over to Prebid.org, will circle back and reassess on the PBS side.

Or do you think it makes more sense to just start with a .md file in prebid-server, and then direct the prebid.org link there?

Not right now, since it's kind of a weird experience for someone who is reading the docs website to click over and be reading docs in Github. I'm also not 100% sure how it would interact with search engines (Prebid.org has a very good PageRank). IMO it would probably be better to document the PBS API using godoc in the code directly and build & sync to Prebid.org (eventually), as mentioned above.

@rmloveland
Copy link
Contributor Author

@dbemiller addressed your missing step feedback in ee20ff6

@mjacobsonny any comments? If not I think we're good to merge/publish.

@rmloveland rmloveland merged commit 439216c into master Aug 17, 2017
@rmloveland rmloveland deleted the RAD-1766 branch August 17, 2017 19:04
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.

2 participants