Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make JSON config files more findable #956

Open
kgudel opened this issue May 11, 2021 · 4 comments
Open

Make JSON config files more findable #956

kgudel opened this issue May 11, 2021 · 4 comments
Labels
Backlog enhancement New feature or request

Comments

@kgudel
Copy link
Contributor

kgudel commented May 11, 2021

Currently there are a number of json, human readable, config files that the frontend picks up and uses for documentation and other copy on the site.

These config files are intended to be able to be editable by non-developers. There is good documentation on how to find these files, however, it would also be useful to have these files be more findable simply through the file structure of the project rather than having them buried in the src files of the code.

As such, it would be helpful to have something like a centralized folder at the top level of the directory structure where you can find all of the files meant to be editable by non-developers.

@meissadia meissadia added the enhancement New feature or request label May 12, 2021
@meissadia
Copy link
Contributor

One small road bump here is that those files need to live under the /src directory in order to be built into our React app. Perhaps we could work around this by adding a pre-commit hook that copies the requisite files into the src directory.

Thoughts:

  • Maybe an admin tool to edit these files?
  • Move this content to an API? w/ an admin tool
  • Smaller fix: Direct links from the documentation to the files?
  • Internal docs: Make a TOC of how-to-edit's and their source files, for configs that are commonly edited

@meissadia
Copy link
Contributor

I actually don't see any mention of the config files in the Frontend README, so that is one thing I can update.

  • add config locations
  • add documentation of each config key

@meissadia
Copy link
Contributor

Config docs live in the repo wiki: https://github.com/cfpb/hmda-frontend/wiki/Front-end-Configuration

@meissadia
Copy link
Contributor

As discussed during Sprint Planning, in practice these files are never modified by non-developers. We have scripts to generate PRs for common modifications, such as maintenance announcements.

Maybe moving files to /src/config from /src/common/constants/ would improve discoverability, but again, only frontend devs actually directly edit these files.

Dropping this back into the Backlog for now.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backlog enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants