Patrice Chalin

Add tooling in support of auto-update of code excerpts in docs

11

@svrnm - I remember you mentioning this somewhere, but I can't find the reference. Anyhow, I'm creating this issue to track progress on this work. /cc @cartermp At the start...

Address GDPR compliance requirements

5

I'd suggest implementing this using a bottom [offcanvas] [modal dialog] from [Bootstrap 5.2+]. If we go this route, we might want to wait for Docsy to migrate. In the meantime,...

Don't link to raw.github.com images and resources, deploy them with the site

1

For example see, https://github.com/open-telemetry/opentelemetry.io/blame/main/content/en/docs/_index.md#L36: ```html ``` --- Edit: I'm generalizing this to don't serve resources from GH. Another example is the iconography.zip. Serve all of the following resources from the...

Define and enforce a policy for introducing redirects when site pages are deleted

2

> Generally speaking, when pages disappear, we should add an appropriate redirect rule. (Related: #635) _Originally posted by @chalin in https://github.com/open-telemetry/opentelemetry.io/pull/643#discussion_r687738802_

When building or serving the site in development mode, sourcemaps aren't being generated. I see nothing in the site files that should prevent this. Using the same version of Hugo...

Post-docsy 2020/10 cleanup

1

Some resources that were used to generate the site prior to the adoption of the Docsy theme are still present in the repo. They're like "dead code", and should be...

Registry entries with invalid fields are ignored

1

Registry entries with invalid fields are ignored -- cf. https://github.com/open-telemetry/opentelemetry.io/pull/892#pullrequestreview-803528760. Invalid fields should be reported at build time.

@anuraaga wrote in https://github.com/open-telemetry/opentelemetry.io/issues/989#issuecomment-999247927: > @chalin If it's possible for the docs build to generate a list of referenced external URLs, I think we could add a link checking job...

There is too much custom front-matter magic happening in https://github.com/open-telemetry/opentelemetry.io/blob/615d79f338ab87c6d944077de6dac51ff78a4dfa/scripts/adjust-spec-pages.pl#L28-L45 Probably all script-created front-matter entries other than the title when fetched from a level-1 heading, should be removed from the...

Originally from https://github.com/open-telemetry/opentelemetry.io/pull/1062#issue-1109429877 > Note that I'll revisit the Registry instructions in another PR, possibly creating a [Hugo archetype file][archetypes] for that too. [archetypes]: https://gohugo.io/content-management/archetypes