Skip to content

Clean up documentation and clarify fork attribution#34

Open
kantselovich wants to merge 2 commits intomasterfrom
docs_cleanup_29
Open

Clean up documentation and clarify fork attribution#34
kantselovich wants to merge 2 commits intomasterfrom
docs_cleanup_29

Conversation

@kantselovich
Copy link

Summary

  • remove stale Datafold marketing and dead links from the main documentation entrypoints
  • preserve concise attribution that data-diff was originally developed by Datafold
  • clarify that this fork is maintained by the Gannett / USA TODAY LOCALiQ Data Engineering team
  • replace stale hosted-doc links with current repo links or Internet Archive references where local replacements do not exist

Fixes #29

@gemini-code-assist
Copy link

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 focuses on a comprehensive cleanup and clarification of the project's documentation. The primary goal was to remove stale marketing content and dead links associated with the original Datafold project, while explicitly establishing the current maintenance and ownership by the Gannett / USA TODAY LOCALiQ Data Engineering team. These changes ensure that the documentation accurately reflects the current state of the fork and provides users with up-to-date and relevant information.

Highlights

  • Documentation Cleanup: Removed outdated Datafold marketing content, dead links, and promotional material from the README.md and other documentation files to streamline the user experience.
  • Fork Attribution Clarification: Clearly stated that this repository is an improved fork maintained by the Gannett / USA TODAY LOCALiQ Data Engineering team, while acknowledging Datafold as the original developer of data-diff.
  • Link Updates: Updated all internal and external links across the documentation to point to the correct GannettDigital/data-diff repository, relevant local documentation files, or archived versions on the Internet Archive where original hosted documentation was no longer applicable.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog
  • CONTRIBUTING.md
    • Updated GitHub issue and discussion links to point to the GannettDigital repository.
    • Modified the git clone command example to use the GannettDigital repository URL.
    • Changed the link for the new database driver guide to reference a local documentation file instead of a hosted ReadTheDocs link.
  • README.md
    • Replaced the Datafold logo and marketing taglines with a generic data-diff logo and a concise project description.
    • Added a clear attribution statement for the fork, crediting Datafold as the original developer and Gannett/USA TODAY LOCALiQ Data Engineering as the current maintainers.
    • Rewrote sections like 'What's a Data Diff?' and 'Use Cases' for improved clarity and conciseness, removing Datafold Cloud specific mentions.
    • Updated dbt integration references, replacing Datafold-specific links with an archived workflow guide and a link to GitHub discussions.
    • Refined 'Getting Started' examples, including installation commands and TOML configuration, using generic placeholders for sensitive information.
    • Adjusted the formatting of the 'Supported Databases' table and removed a note about MS SQL Server performance in Datafold Cloud.
    • Streamlined the 'How It Works' section and provided an archived link for the original technical explainer.
    • Simplified the 'Contributors' section and removed extraneous blank lines throughout the document.
  • docs/conf.py
    • Updated the copyright field to include the Gannett | USA TODAY LOCALiQ Data Engineering team as maintainers of the fork.
    • Modified the author field to reflect contributions from Datafold, general contributors, and the Gannett | USA TODAY LOCALiQ Data Engineering team.
  • docs/index.rst
    • Expanded the toctree to include new documentation sections such as common_use_cases, technical-explanation, usage_analytics, and new-database-driver-guide.
    • Changed the toctree caption from 'API Reference' to 'Documentation'.
    • Updated the introductory text to clarify the project's status as a maintained fork.
    • Revised the 'Resources' section to link directly to the GannettDigital GitHub repository for source code, issues, and discussions, and added an archived CLI reference link.
  • docs/new-database-driver-guide.rst
    • Updated the link to CONTRIBUTING.md to point to the GannettDigital repository.
  • docs/python_examples.rst
    • Updated internal links for connect_to_table and diff_tables to use relative paths within the documentation.
    • Corrected reStructuredText formatting for help() function calls by changing single backticks to double backticks.
Activity
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.

Copy link

@orca-security-us orca-security-us bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

Copy link

@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 effectively cleans up the documentation, removing outdated marketing material and broken links while clarifying the project's status as a fork. The changes significantly improve the clarity and usability of the documentation for new and existing users. My review includes a couple of minor suggestions to further enhance the readability and structure of the markdown files.

Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com>
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.

Documentation cleanup

1 participant