Skip to content

feat: add fastly documentation - #2430

Open
Patrick Derks (TrayserCassa) wants to merge 1 commit into
mainfrom
paas-fastly
Open

feat: add fastly documentation#2430
Patrick Derks (TrayserCassa) wants to merge 1 commit into
mainfrom
paas-fastly

Conversation

@TrayserCassa

@TrayserCassa Patrick Derks (TrayserCassa) commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Summary

Related links

Checklist

  • I reviewed affected links, code samples, and cross-references, including PageRef references where relevant.
  • I added or updated redirects in .gitbook.yaml if pages were moved, renamed, or deleted.
  • I updated .wordlist.txt (and sorted it) if spellcheck flags new legitimate terms.
  • Any required dependent changes in downstream modules have already been merged and published.
  • This pull request is ready for review.

Notes

Copilot AI lite review requested due to automatic review settings August 7, 2026 12:31
@shopware-dev-docs-connector

shopware-dev-docs-connector Bot commented Aug 7, 2026

Copy link
Copy Markdown

Developer Docs healthcheck

Status: Completed with success.
Repository: shopware/docs
Commit: e60542f
Preview: https://developer-documentation-klpzzzvuv-shopware-frontends.vercel.app
Workflow run: #4742

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

📊 Documentation Impact Analyzer

Metric Result
Score 22
Recommendation ✅ Highly meaningful
Categories None

Reasons

  • +12: 6 new headings
  • +8: Code examples
  • +2: Code examples

This score is automatically generated based on documentation impact heuristics.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds and expands Shopware PaaS Native documentation for configuring Fastly and deploying custom VCL snippets, connecting application.yaml configuration with a dedicated snippets guide.

Changes:

  • Documented services.fastly options (disable_default_snippets, snippets_path) in application.yaml.
  • Reworked/expanded the Fastly snippets page with configuration steps, required folder layout, naming rules, ordering, and validation behavior.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File Description
products/paas/shopware/fundamentals/application-yaml.md Adds a new services.fastly section with example configuration and option reference.
products/paas/shopware/cdn/fastly-snippets.md Replaces the placeholder Fastly snippets content with a full guide covering configuration and repository layout rules.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread products/paas/shopware/fundamentals/application-yaml.md
Comment thread products/paas/shopware/cdn/fastly-snippets.md Outdated

The `FASTLY_API_KEY` and `FASTLY_SERVICE_ID` are automatically provided to the Shopware instance.
- Add your own snippets, which are deployed alongside the default ones.
- Disable the default snippets with `disable_default_snippets: true` and take full control.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write fastly.disable_default_snippets: true, since this form is used few line later.

```

::: warning
Snippet files in your repository are only picked up when `services.fastly.snippets_path` points at their directory. Without that option the files are ignored and never reach Fastly.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say: and never configured in Fastly instead of and never reach Fastly.


## Snippet order

Within a type, files are sorted by file name and the priority is assigned in that order: the first file gets priority 1 (highest), the next gets 2, and so on.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The priority is related to the custom snippet right? For instance the 1st snippet get priority 101 in Fastly and the 2nd 102?


```text
config/fastly/recv/
├── 001-auth.vcl # priority 1

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think here you should show a real example of a file including storefront and cdn.
I'm also a bit confused about the prefix, what should be the order?

001-storefront-foo.vcl
storefront-001-foo.vcl

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants