Automated checks if bidders & modules are in sync with documentation

[muuki88]

This repository hosts the documentation for all those projects:

• https://github.com/prebid/Prebid.js
• https://github.com/prebid/prebid-server
• https://github.com/prebid/prebid-server-java
• https://github.com/prebid/prebid-mobile-ios
• https://github.com/prebid/prebid-mobile-android

Keeping the documentation in sync with the latest releases is non-trivial.

• bidders get removed, but the documentation doesn't
• bidder files get renamed, trashing the download page ( The prebid.org Download PrebidJS page is refering to some modules incorrectly #5636 )
• bidders are added, but documentation is not
• aliases are added, but documentation is not updated
• bidders get removed in a major version, but have no prebid version indicator
• case sensitivity

🎯 Goal

Reviewers or contributors get automated help if a change breaks documentation.

prebid docs meta data

There are a couple of meta data fields that provide solutions for common problems

• filename if biddercode and the actual bid adapter filename, don't match. incrementx.md example
• pbjs_version_notes - add text description about prebid version availability iqm.md example

🗒️ Requirements

A propose solution should work for all prebid projects (js, server, app), but does not need to be implemented for all of them.

💡 Ideas

The docs committee thought about github workflows that could be triggered for every pull request. Depending on the repository, the logic could be adapted.

An alternativ would be an external job that regularly checks if stuff is in sync and spit out warnings somewhere.

🔗 Relates issues

• Update warning message Prebid.js#5565
• feature request: Using video duration or other fields to score bid in addition to cpm Prebid.js#4411
• Onevideo Adaptor ccpa support Prebid.js#4558
• The prebid.org Download PrebidJS page is refering to some modules incorrectly #5636
• ucfunnel adapter support CCPA and remove utils.js in adapter Prebid.js#4541 - attempt to find an alternative that supports versioned docs

[dgirardi]

I recommend extracting all relevant metadata into a new repo. Instead of say aliases being repeated in js, server, docs, etc; have them in one place and make all the others take them from there during build. Let's not: add an Nth new project used for github checks that also needs to be updated on every metadata update.

[muuki88]

@ChrisHuie you had a prototype that fetched those meta data somewhere?