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

Site search and Bidders updates #2733

Merged
merged 186 commits into from
Mar 3, 2021
Merged

Site search and Bidders updates #2733

merged 186 commits into from
Mar 3, 2021

Conversation

bookwyrm
Copy link
Contributor

@bookwyrm bookwyrm commented Mar 2, 2021

Adds doc search to the site via Algolia.
Restructures Bidders page to add autocomplete support and updated design that groups bidders by name.

Includes a helper script (find-ungrouped-bidders.sh) to verify that all Bidders have been assigned to a list_group for proper display on the Bidders page.

Only bring in what we need to keep CSS size down
So that we can include it separately and still use it in webpack build pipeline
For styling and JS
Via browsersync

Without this change I was having to wait for Jekyll to finish rebuilding the site in order to see CSS changes
bootstrap import stubbed till we can figure out just which bits we need and can limit the import to keep JS size down
Removing some unneeded CSS/JS dn prep work for new site fonts
Use the same nav struct for mobile view as well
Should see if we can trim this down at some point and not load _all_ of the utility classes
Also fix unbalanced tags and add comments to sort out unbalanced tag
We will be styilng via native site CSS
For more readable customizations
Per feedback
To get updated CSS to be used.
So that we can edit it w/out battling with Jekyll/Liquid parsing and formatting.
For saner result display
This reverts commit a6b9e8e.

These updates are not ready to launch yet - revert them so they’re not part of the PR for bidder updates
This reverts commit 23d00e5.

These updates are not ready to launch yet - revert them so they’re not part of the PR for bidder updates
# Conflicts:
#	assets/css/main-bundle.css
#	dev-docs/bidders/adhese.md
#	dev-docs/bidders/adkernel.md
#	dev-docs/bidders/adkernelAdn.md
#	dev-docs/bidders/adot.md
#	dev-docs/bidders/adprime.md
#	dev-docs/bidders/beachfront.md
#	dev-docs/bidders/between.md
#	dev-docs/bidders/brightroll.md
#	dev-docs/bidders/colossus.md
#	dev-docs/bidders/decenterads.md
#	dev-docs/bidders/improvedigital.md
#	dev-docs/bidders/inmobi.md
#	dev-docs/bidders/kidoz.md
#	dev-docs/bidders/kubient.md
#	dev-docs/bidders/livewrapped.md
#	dev-docs/bidders/mobilefuse.md
#	dev-docs/bidders/readpeak.md
#	dev-docs/bidders/revcontent.md
#	dev-docs/bidders/richaudience.md
#	dev-docs/bidders/rtbhouse.md
#	dev-docs/bidders/smartrtb.md
#	dev-docs/bidders/sonobi.md
#	dev-docs/bidders/synacormedia.md
#	dev-docs/bidders/tappx.md
#	dev-docs/bidders/ucfunnel.md
#	dev-docs/bidders/vdoai.md
#	dev-docs/bidders/visx.md
#	download.md
Whenever bidders are added to the site they need to be assigned to a `list_group` from `dev-docs/bidders.md` via the individual bidder frontmatter. If a bidder isn’t assigned to a `list_group` then they won’t appear on the Bidders page.

This script checks all bidders and lists those that aren’t assigned to a `list_group`.

Exclude the script so it’s not included in the generated site.
Restore expected CNAME for production site.

This reverts commit 0c0166c.
Allow indexing of production site.

This reverts commit 543ea07.
@bretg
Copy link
Contributor

bretg commented Mar 2, 2021

@bookwyrm - thanks, but I'm not real fond of the new 'list_group' header value. These values are set and maintained by hundreds of different companies, and they will certainly screw them up. It will end up adding a bunch of error-prone work on the part of the doc reviewers... we're going to have to A) remember to make sure it's there and B) keep a list of the valid values.

Is there no way to automate this grouping another way? How about this:

{% assign bidder_pages = site.pages | where: "layout", "bidder" | where: "pbjs", true %}

/* 0 and a */
{% for page in bidder_pages %}
    {% assign firstletter = page | slice:0 | downcase %}
    {% unless firstletter == "0" or  firstletter == "a" %}{% continue %}{% endunless %}
    ... do stuff ...
{% endfor %}

/* b and c */
{% for page in bidder_pages %}
    {% assign firstletter = page | slice:0 | downcase %}
    {% unless firstletter == "b" or  firstletter == "c" %}{% continue %}{% endunless %}
    ... do stuff ...
{% endfor %}

This is a better approach do it by parsing the title rather than relying on a value in the frontmatter
Make them sorted by title in a case-insensitive manner
Now that we are grouping by parsing title, we no longer need the list_group in the frontmatter.
@bookwyrm
Copy link
Contributor Author

bookwyrm commented Mar 2, 2021

Thanks, @bretg. This is a much better approach.

@bretg bretg merged commit c68150e into prebid:dev Mar 3, 2021
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