Skip to content
This repository has been archived by the owner on Feb 22, 2024. It is now read-only.

Backend documentation? #30

Open
phamann opened this issue Jan 24, 2017 · 3 comments
Open

Backend documentation? #30

phamann opened this issue Jan 24, 2017 · 3 comments

Comments

@phamann
Copy link
Contributor

phamann commented Jan 24, 2017

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
Copy link
Member

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
Copy link
Contributor

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
Copy link
Member

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants