IBX-3767: Document how to use fastly CLI on post deploy hook #57
Conversation
|
You can rebase PR @Nattfarinn. #58 has been merged. |
resources/platformsh/ibexa-content/4.3.x-dev/.platform.app.yaml
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Is is really desirable to put this kind of documentation in the .platform.app.yaml file ?
On Ibexa Cloud, p.sh will (are at least supposed to ) install the .vcl and snippets during onboarding. p.sh want to avoid doing any further updates it after that, so it is good that we have some documentation on how to use Fastly CLI though.
I think the better place is doc.ibexa.co. I have this PR pending btw to improve Fastly documentation, but it does not address Fastly CLI : https://github.com/ezsystems/developer-documentation/pull/1848/files.
Not all Fastly users are necessarily on Ibexa Cloud, so I think it is important to not have the Fastly doc only in p.sh context
I don't think it hurts to have it both here and on doc.ibexa.co though, but there are then two places to maintain in regards to changes.
For instance, when Fastly-IO will be supported shortly
| # Official documentation on how to install: https://developer.fastly.com/learning/tools/cli#installing | ||
| # Example VCL snippet upload using vcl_recv hook (remember about FASTLY_SERVICE_ID and FASTLY_KEY environmental variables): | ||
| ##fastly vcl custom create --name="Ibexa VCL" --main --version=latest --autoclone --content=vendor/ibexa/fastly/fastly/ez_main.vcl | ||
| ##fastly vcl snippet create --name="Shielding" --version=active --autoclone --type recv --content=vendor/ibexa/fastly/fastly/snippet_re_enable_shielding.vcl |
There was a problem hiding this comment.
Info about fastly/ez_user_hash.vcl is missing
There was a problem hiding this comment.
This is just example of how to use Fastly CLI in general, not how to enable and configure Fastly on our side. :)
v4.3Checklist:
mainfor features, the oldest supported for bugs).@ibexa/engineering).