Skip to content

Rewrite provenance/source/dataset documentation#690

Merged
kmoscoe merged 68 commits intodatacommonsorg:masterfrom
kmoscoe:concepts
Mar 20, 2026
Merged

Rewrite provenance/source/dataset documentation#690
kmoscoe merged 68 commits intodatacommonsorg:masterfrom
kmoscoe:concepts

Conversation

@kmoscoe
Copy link
Copy Markdown
Contributor

@kmoscoe kmoscoe commented Mar 16, 2026

The "Key concepts" section on provenances etc. was incorrect in several places, including the diagram. This PR rewrites that section and:

  • Updates the diagram
  • Adds provenance, dataset, and source as terms to the glossary
  • Removes some Liquid tags that were breaking images preview

Staged at http://bullie.svl.corp.google.com:4000

kmoscoe and others added 30 commits June 11, 2025 19:07
@kmoscoe kmoscoe requested review from ajaits and carojahn March 16, 2026 20:45
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request significantly improves the accuracy and clarity of the Data Commons documentation, particularly for the fundamental concepts of provenance, source, and dataset. It addresses previous inaccuracies in the "Key concepts" section, updates associated diagrams for correct rendering, and expands the glossary to include formal definitions for these critical terms, ensuring a more consistent and understandable data model explanation for users.

Highlights

  • Documentation Rewrite: The "Key concepts" section, specifically on provenance, source, and dataset, was completely rewritten to correct inaccuracies and provide clearer explanations.
  • Diagram Updates: All diagrams within the data_model.md file were updated, primarily by removing Liquid tags that were causing rendering issues.
  • Glossary Expansion: New terms, "Provenance", "Dataset", and "Source", were added to the glossary.md file to provide formal definitions for key concepts.
Changelog
  • data_model.md
    • Removed {{site.url}} Liquid tags from image paths to fix image rendering.
    • Rewrote the "Provenance, Source, Dataset" section, clarifying definitions and relationships between these concepts.
    • Added a {: #sources} anchor to the "Provenance, Source, Dataset" heading for direct linking.
  • glossary.md
    • Updated the main heading from "Glossary of Common Terms" to "Glossary of common terms".
    • Updated the "Term List" subheading to "Term list".
    • Added a new glossary entry for "Dataset" with its definition and an example.
    • Added a new glossary entry for "Provenance" with its definition and context within datasets.
    • Added a new glossary entry for "Source" with its definition and an example.
Activity
  • No specific activity has been recorded for this pull request yet.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

@kmoscoe kmoscoe requested a review from beets March 16, 2026 20:46
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request provides a much-needed rewrite of the documentation for provenance, source, and dataset, improving correctness and clarity. It also fixes broken image links by removing unnecessary Liquid tags. The changes are a significant improvement. I've added a few comments to address minor typos and suggest a clarification for a potentially confusing sentence.

Comment thread data_model.md Outdated
Comment thread data_model.md Outdated
Comment thread glossary.md Outdated
kmoscoe and others added 5 commits March 16, 2026 14:28
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
@kmoscoe kmoscoe requested review from hareesh-ms and removed request for ajaits and beets March 17, 2026 17:15
Copy link
Copy Markdown
Contributor

@beets beets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thanks for the update!

@kmoscoe kmoscoe enabled auto-merge (squash) March 20, 2026 21:05
@kmoscoe kmoscoe merged commit 1b63c12 into datacommonsorg:master Mar 20, 2026
2 checks passed
@kmoscoe kmoscoe deleted the concepts branch March 23, 2026 19:21
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