Jump to content

Topic on Talk:Service-template-node/GettingStarted

Explain spec.yaml usage better

1
Jdlrobson (talkcontribs)

A newbie (read me :-)) cloning the service template node may not realise the significance/importance of spec.template.yaml right away. It is also very large so it's not clear if it should be appended to/emptied or replaced.

I'd suggest at the very least a note is made in the README file guiding the user about what to do with this e.g. create a file spec.yaml

The fact it contains lots of pre-existing routes such as `/ex/err/manual/deny`is also confusing - it's not clear whether these are examples or ones that need to be included.

If the routes are expected to remain in the repo I'd suggest renaming this to spec.yaml in the template node itself to make that clearer (I'm still not clear on that)

Reply to "Explain spec.yaml usage better"