fabrikate icon indicating copy to clipboard operation
fabrikate copied to clipboard

README.md improvements

Open timfpark opened this issue 5 years ago • 0 comments

A new user ran through the documentation and had the following feedback - let's iterate on the right documentation / code changes and address:

  • [ ] When reading through doc, its not clear why one component is defined in yaml and why one component is defined in json. Both serialization formats are the same functionally? Maybe state so.

  • [ ] I added fabrikate-isto-service to my cluster, and then followed the doc to add prod.yaml with namespace: services. I was stuck here for awhile because this does not generate a manifest for creating the Namespace “services” in k8s. I knew what I needed to generate, but couldn’t determine the elegant Fabrikate way to do it. Looking at several other components, I came up with creating a manifests folder that contains the services-namespace.yaml and adding this subcomponent to my component.yaml:

- name: namespaces
  generator: static
  path: "./manifests"

I also toyed with adding path: “./manifests” to the top-level component, but this didn’t seem to have any effect.

timfpark avatar May 10 '19 15:05 timfpark