Documentation

Overview

The dataset documentation is made up of an introduction as well as rich text (documentation blocks) that provide researchers with the information they need to know about your dataset. You can edit either of these fields by clicking on them in the dataset editor.

The introduction is limited to 256 characters, and will show up in previews and search results for the dataset. The documentation can contain formatted text, links, images, and embedded files up to 50MB.

All information provided in the introduction and documentation will be indexed for researchers' search queries — detailed and accurate content will best help researchers find your dataset.

Provide rich documentation to help researchers understand your dataset

Limiting access

By default, all dataset documentation is visible to anyone with overview access to the dataset. However, there may be some content in the documentation that is sensitive — for example, information about named variables that would require metadata access.

To support this use case, you can create several documentation blocks, each with a corresponding access level. Users without the appropriate level of access will only see a placeholder for that section of the documentation.

Create documentation blocks with different access levels
Users without the appropriate access will see a placeholder for that documentation block

Other metadata

In addition to documentation, you may add up to 25 tags to your dataset, which will help researchers discover and understand the dataset.

Additionally, information about the dataset's size and temporal range will be automatically computed from the metadata on its tables. Additional table documentation, as well as the variable metadata, will be indexed and surfaced as part of the dataset discovery process.