search

Financial-Times / fastly-tools

Command Line Utility for interacting with fastly
29 stars 9 forks source link

Backend documentation? #30

Open phamann opened 7 years ago

phamann commented 7 years ago

Hi 👋 , my name is Patrick and I work for Fastly...

I really like the simplicity of this tool and would like to use it on some internal projects. However, I'm currently struggling as the readme lacks some key documentation for certain features, such as the backends flag -b:

-b --backends <backends>  Upload the backends specified in <backends> via the api

How do I know what type of file this needs to be (.yml .json?) and the required properties needed to define each backend within the file?

Any further assistance or insight into this issue would be greatly appreciated. I'd be very happy to submit a PR updating the documentation if you could supply me with a sample backend file.

commuterjoy commented 7 years ago

Pleased to meet you.

A PR would be much appreciated.

Example backends are in ./test/fixtures

The project also lacks an explicit license or CLA, so we should fix that too :)

wheresrhys commented 7 years ago

Hi Patrick. Nice to meet you.

We were talking about sharing ownership of this tool with Fastly (I raised it in the slack channel). It's mostly non FT specific, and would be good to co-maintain it.

Regarding the data structure, I'll slack you an example for now

commuterjoy commented 7 years ago

Also just realise the repo was originally forked from @thisandagain and still contains a few bits of his code, which is MIT https://github.com/Financial-Times/fastly/blob/master/LICENSE.md