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.

Sign up for GitHub

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

Jump to bottom

Split and rename helix-config.yaml #190

Closed
trieloff opened this issue Oct 30, 2019 · 2 comments
Closed

Split and rename helix-config.yaml #190

trieloff opened this issue Oct 30, 2019 · 2 comments
Labels
enhancement New feature or request question Further information is requested

Comments

@trieloff
Copy link
Contributor

I had a chat with @davidnuescheler last night regarding our helix-config.yaml and how fstab.json (adobe/helix-pages#67) helix-index.yaml (adobe/helix-home#67) may fit into it.

David's recommendation (and I agree) is to move away from the single-config file approach that has been our guidance so far and instead adopt an approach that is more like UNIX's /etc than Win32's Registry, i.e. have one config file for each task and allow the user to simply ignore (or never create) the files they don't need.

We would end up with following config files:

  1. strains.yaml – what used to be helix-config.yaml
  2. fstab.yaml – what used to be fstab.json
  3. queries.yaml – what used to be helix-index.yaml, also includes Make Queries Configurable helix-index-files#3
  4. markup.yaml – a new file for Declaratively Configurable Markup helix-pipeline#516

For ease of development, helix-shared should read all available files and provide a unified API across all of them.

In addition, we should extend helix-shared so that it can retrieve the files from a GitHub repo when owner, repo, ref, and optionally token are set. Using an HTTP/2 client (paging @stefan-guggisberg), this should not have any negative performance impact over the fetching of fstab.json we do in Helix Pages right now.
@trieloff trieloff added enhancement New feature or request question Further information is requested labels Oct 30, 2019
@trieloff trieloff mentioned this issue Oct 30, 2019
Closed
@trieloff trieloff mentioned this issue Nov 6, 2019
Merged
trieloff added a commit that referenced this issue Dec 18, 2019
@trieloff
feat(config): add (basic) support for fstab.yaml
e0c5516 
see #190
trieloff added a commit that referenced this issue Dec 19, 2019
@trieloff
feat(query): add schemas and config class for index and query configs
ece8df4 
see adobe/helix-index-files#3 and #190
@trieloff trieloff mentioned this issue Dec 19, 2019
Merged
adobe-bot pushed a commit that referenced this issue Dec 20, 2019
@semantic-release-bot
chore(release): 3.2.0 [skip ci]
382d3b9 
# [3.2.0](v3.1.2...v3.2.0) (2019-12-20)

### Bug Fixes

* **config:** bring up test coverage ([61e0134](61e0134))
* **config:** fix (and test) default value coercion ([67511d0](67511d0))
* **config:** make recusive access work in schema-derived config ([d267e40](d267e40))
* **schema:** fix query schema id ([2128767](2128767))
* **schema:** fix query schema id ([1d45c3d](1d45c3d))
* **validate:** use correct ajv instance ([4340d63](4340d63))

### Features

* **config:** add (basic) support for `fstab.yaml` ([e0c5516](e0c5516)), closes [#190](#190)
* **config:** NamedMapProxy allows turning a JSON Schema into a config class ([e1744d7](e1744d7)), closes [#195](#195)
* **query:** add schemas and config class for index and query configs ([ece8df4](ece8df4)), closes [#190](#190)
@tripodsan
Copy link
Contributor

I think this can be closed

@trieloff
Copy link
Contributor Author

trieloff commented Mar 2, 2021

We never renamed helix-config.yaml to strains.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request question Further information is requested
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@trieloff @tripodsan