build: update README to indicate that source has moved#1038
Conversation
Summary of ChangesHello, 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 addresses issue #10916 by updating the Highlights
Changelog
Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this comment.
Code Review
This pull request updates the README.md to inform users that the repository has been archived and its contents moved. While the intent is correct, the added note uses reStructuredText (RST) syntax within a Markdown file. This will cause rendering issues on platforms like GitHub and PyPI. I've provided a suggestion to use proper Markdown syntax to ensure the note is displayed correctly.
Note: Security Review has been skipped due to the limited scope of the PR.
| :**NOTE**: **This github repository is archived. The repository contents and history have moved to** `google-cloud-python`_. | ||
|
|
||
| .. _google-cloud-python: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-ndb |
There was a problem hiding this comment.
The README.md file is treated as Markdown, as indicated by its .md extension and its usage in setup.py with long_description_content_type="text/markdown". The current syntax for the note and link is reStructuredText (RST), which will not render correctly. To ensure the note is properly displayed on GitHub and PyPI, it should be converted to Markdown syntax. Using a blockquote will also help the note stand out.
| :**NOTE**: **This github repository is archived. The repository contents and history have moved to** `google-cloud-python`_. | |
| .. _google-cloud-python: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-ndb | |
| > **NOTE**: This github repository is archived. The repository contents and history have moved to [`google-cloud-python`](https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-ndb). |
Towards googleapis/google-cloud-python#10916