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

Evaluate alternative static site generators #4541

Open
muuki88 opened this issue May 4, 2023 · 0 comments
Open

Evaluate alternative static site generators #4541

muuki88 opened this issue May 4, 2023 · 0 comments
Assignees

Comments

@muuki88
Copy link
Contributor

muuki88 commented May 4, 2023

With the upcoming prebid 8 release we again have the question on how to handle this in the documentation.
We have a prebid releases page in the references section, which gives a nice overview, but the documentation is lacking some info

  • is this module/feature/config only supported in my prebid version as well?
  • where can I find the specific documentation for my version

Currently, we solve this by adding meta data to bidders or specific configs/modules if there's a restriction on a prebid version.

Goals

There are a few goals we would like to achieve

  1. Reduce friction between code and documentation
    1. no documentation PRs required for prebid.js changes
    2. generated API documentation, reducing the chance of out-dated-api docs
  2. Allow a versioned documentation to time travel to the correct version
    1. Get rid of annotations in the documentation when to use what
    2. Always up-to-date download page
    3. separate versions for the different prebid projects along with a documented and implemented release process
      1. prebid.js
      2. prebid server (go & java)
      3. prebid mobile
  3. Reduce code review remarks by
  4. required types for certain layouts
  5. enum / string literal union types for allowed values
  6. Replace tables where possible with a more responsive / mobile friendly layout

Requirements

  1. Easy to contribute like now - open a PR and change a markdown file
  2. Migration with as a little as possible directory structure changes. See Rework navigation and update or remove outdated pages #5630 for a list of important pages
/download.html
/dev-docs/bidders.html
/dev-docs/publisher-api-reference/setConfig.html
/
/prebid/prebidjs.html
/dev-docs/getting-started.html
/dev-docs/pbs-bidders.html
/dev-docs/modules/userId.html
/dev-docs/examples/basic-example.html
/prebid-server/overview/prebid-server-overview.html
/dev-docs/bidder-adaptor.html
/adops/step-by-step.html
/dev-docs/publisher-api-reference.html
/troubleshooting/troubleshooting-guide.html
/dev-docs/adunit-reference.html
/overview/intro.html
  1. Algolia support for site search
  2. SEO support
  3. Migrate all existing customizations
  4. Google Analytics page view tracking

Customizations

There are a couple of customizations and extensions in the code base.

Generating tables and list from front matter meta data

We use jekyll meta data to generate listings of things.

Using the layout meta data to provide a list of certain module types, e.g. layout: bidder or layout: userid

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

Search Input Fields

<input type="text" id="autocomplete-filter" class="autocomplete-filter">
<script src="https://cdnjs.cloudflare.com/ajax/libs/awesomplete/1.1.5/awesomplete.min.js" integrity="sha512-HcBl0GSJvt4Qecm4srHapirUx0HJDi2zYXm6KUKNNUGdTIN9cBwakVZHWmRVj4MKgy1AChqhWGYcMDbRKgO0zg==" crossorigin="anonymous"></script>
<script>
var AutocompleteList = [{% for page in bidder_pages %}{ label: '{{ page.title }}', value: '{{ page.url }}' },{% endfor %}];
</script>
<script src="{{site.baseurl}}/assets/js/autocomplete.js"></script>
<div class="c-bidder-list-group" markdown="1">

Download Page

This page enables users to download a prebid.js distribution with the selected modules

https://github.com/prebid/prebid.github.io/blob/master/assets/js/download.js

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

No branches or pull requests

1 participant