[tess.example.yml] arranging TeSS::Config.feature list#1224
[tess.example.yml] arranging TeSS::Config.feature list#1224kennethrioja wants to merge 1 commit intoElixirTeSS:masterfrom
tess.example.yml] arranging TeSS::Config.feature list#1224Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the feature configuration in tess.example.yml to improve readability and maintainability by grouping related features into logical categories. The changes add section comments to categorize features into "TeSS main resources", "Resources' features", "User login", "User rights", and "UI" sections.
Changes:
- Reorganized feature flags into logical, commented sections for better clarity
- Updated the "Possible features to disable" comment to include additional options
- Minor comment wording adjustment from "Be careful!" to "Caution!"
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| # Possible features to disable: | ||
| # biotools, topics, operations, sponsors, fairshare, county, ardc_fields_of_research, | ||
| # other_types, subsets, syllabus, approved_editors address_finder, |
There was a problem hiding this comment.
There's a missing comma after "approved_editors" in the list of possible features to disable. The list should have commas between all items.
| # other_types, subsets, syllabus, approved_editors address_finder, | |
| # other_types, subsets, syllabus, approved_editors, address_finder, |
| learning_paths: false | ||
| collection_curation: true | ||
| spaces: false | ||
| topics: true |
There was a problem hiding this comment.
The topics: true feature flag appears to be a new addition rather than a reorganization of existing configuration. However, the codebase doesn't check for TeSS::Config.feature['topics'] or TeSS::Config.feature[:topics]. Instead, the code checks if 'topics' is included in the TeSS::Config.feature['disabled'] array (see app/models/event.rb:202 and app/models/material.rb:139). Adding this flag here won't have any effect on the application's behavior and creates confusion about how topics are actually controlled. Consider removing this line or clarifying if this is intended as a new feature flag with corresponding code changes.
| topics: true |
Summary of changes
tess.example.ymlMotivation and context
featurebag – as an LLM may sell it "This drastically improves the DX"Checklist
to license it to the TeSS codebase under the
BSD license.