tracing/assets/warning.html
Eliza Weisman e0d130e5c0
chore: add a warning header to docs built from master (#1765)
This branch adds a warning header to documentation built from the
`master` branch, noting that this is _not_ documentation for the release
version, and suggesting that users refer to docs.rs for the release
documentation instead. Netlify is configured to include this header when
building documentation. This should make it clearer that documentation
built from `master` does _not_ document the currently documented release
versions on crates.io.

I'm very far from a web developer, so it's almost certainly possible
that the warning header could look nicer. I'll happily take suggestions
for improving the styling, but at least this gets the point across.

Additionally, I've added a [`noindex` meta tag][1] to the documentation's
HTML `<head>`. This should prevent it from showing up in search engines,
so that when people Google tracing APIs, they end up on the docs.rs
documentation, rather than the `master` branch dev docs.

You can see what it looks like in the netlify deploy preview, but basically,
it looks like this: 
![image](https://user-images.githubusercontent.com/2796466/144482665-908cbaee-076e-441b-8689-1e6cd1b03f31.png)

Closes #1592

[1]: https://developers.google.com/search/docs/advanced/crawling/block-indexing
2021-12-03 11:09:55 -08:00

9 lines
No EOL
319 B
HTML

<div id="tracing-warning-header">
<p>
<strong>&#x1F6C8; Note</strong>: This is <em>pre-release</em> documentation
for the upcoming <code>tracing</code> 0.2.0 ecosystem.
</p>
<p>
For the release documentation, please see <a href="https://docs.rs">docs.rs</a>, instead.
</p>
</div>