Move FLASK_ENV option out of "rarely need to be changed" to the "Directories" section and fix incorrect description

[kmoscoe]

The description erroneously claimed that this controls the directory containing static assets, i.e. static/custom_dc, which is not the case; it's controlled by server/config/app_env/config.py. In addition, it's actually necessary to set this if you're going to do any customization and don't want to get stomped/encounter merge conflicts every time you resync to the stable release.

A follow-on PR will update the UI customization doc in Docsite.

[gemini-code-assist]

Summary of Changes

Hello, I'm Gemini Code Assist¹! 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 refines the custom_dc/env.list.sample configuration file by repositioning the FLASK_ENV variable and providing a significantly improved and accurate description. The changes aim to clarify the critical role of FLASK_ENV in managing custom environments, particularly for users who are customizing their deployments, thereby helping them avoid potential configuration errors and merge conflicts during future updates.

Highlights

• FLASK_ENV Configuration: The FLASK_ENV option was relocated within custom_dc/env.list.sample from a "rarely need to be changed" section to the "Directories" section, emphasizing its importance for custom deployments.
• Description Correction: The description for FLASK_ENV was updated to accurately reflect its role in controlling custom Jinja templates and JSON files, correcting the previous erroneous claim about static assets.
• Customization Clarity: The updated description highlights that setting FLASK_ENV is essential for customization to prevent merge conflicts when syncing with stable releases.

Changelog

• custom_dc/env.list.sample
  • Moved the FLASK_ENV variable definition to a more appropriate section.
  • Corrected and expanded the description for the FLASK_ENV variable.

Activity

• No 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. ↩

[gemini-code-assist]

Code Review

This pull request correctly moves the FLASK_ENV configuration to a more appropriate section in the env.list.sample file and updates its description to be more accurate and helpful for users setting up a custom Data Commons instance. My feedback focuses on improving the readability of the new comment.

[nick-nlb]

LGTM