Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Updated custom VCL documentation #6833

Merged
merged 24 commits into from
Mar 19, 2020

Conversation

meker12
Copy link
Contributor

@meker12 meker12 commented Mar 10, 2020

Purpose of this pull request

Per support feedback, updated Fastly custom VCL topics in the Cloud Guide to improve documentation for creating custom IP allowlists. (MAGECLOUD-4821)

Also, cleaned up all custom VCL topics:

  • Remove escape characters from code samples (not required for uploading VCL as a file using API, or uploading via Admin UI)
  • Added caveat about escaping special characters when submitting snippets as a JSON string in Fastly API requests with link to Fastly VCL reference for examples
  • Updated all custom VCL topics to have parallel structure and content
  • Updated "Add site map and search engine robots" topic with link to instructions for uploading the VCL snippets to Fastly configuration.

To do

  • Doc testing Successfully Generate staging preview (build 1550)
  • Technical review
  • Editorial review

Affected DevDocs pages

https://devdocs.magento.com/cloud/cdn/cloud-vcl-custom-snippets.md
https://devdocs.magento.com/cloud/cdn//fastly-vcl-badreferer.md
https://devdocs.magento.com/cloud/cdn/fastly-vcl-blocking.md
https://devdocs.magento.com/cloud/cdn/fastly-vcl-whitelist.md
https://devdocs.magento.com/cloud/cdn/fastly-vcl-wordpress.md
https://devdocs.magento.com/cloud/trouble/robots-sitemap.md

- Changed topic title from "Secure access to the Magento Admin UI" to
more generic "Create custom VCL for IP allowlist"
- Clarified VCL snippet JSON example showing allowlist logic and the
two options for adding from Magento Admin or using Fastly API
- Renamed Custom VCL for blocking topic ==> Custom VCL for IP block list
to match the topic title for allowlist
- Updated topic titles in TOC
- Updated all custom VCL example topics to have parallel structure and
content
- Removed escaping from VCL code examples -- escaping only needed if
you submit snippet as JSON string -- and added note about when to escape
special characters with link to Fastly VCL reference for examples.
@meker12 meker12 self-assigned this Mar 10, 2020
@meker12 meker12 added the Internal Dev Differentiates work between community and Magento staff label Mar 10, 2020
@meker12 meker12 added 2.3.x Magento 2.3 related changes and removed Progress: review labels Mar 10, 2020
meker12 and others added 9 commits March 13, 2020 14:45
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
Co-Authored-By: Michael Casey <mcasey@magento.com>
@meker12 meker12 requested a review from michaelcasey316 March 16, 2020 17:25
Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

There are a few minor things to look at.
I noticed repetition between three topics. It's nothing that needs fixing now, but whenever it becomes a pattern it raises my eyebrows. If you have to change one, you have to remember to change them all, maybe.

Copy link
Contributor Author

@meker12 meker12 left a comment

Choose a reason for hiding this comment

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

A few suggestions to commit

@hguthrie
Copy link
Contributor

A few suggestions to commit

Why do you not work locally? Seems to be extra work to do this in the GitHub interface for your own PR.

@meker12 meker12 requested a review from hguthrie March 17, 2020 22:30
Copy link
Contributor

@hguthrie hguthrie left a comment

Choose a reason for hiding this comment

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

This is almost approved, but I saw one small return that cut a word in half.

Co-Authored-By: hguthrie <hguthrie@users.noreply.github.com>
@meker12
Copy link
Contributor Author

meker12 commented Mar 19, 2020

running tests

@meker12 meker12 merged commit a44e6e1 into master Mar 19, 2020
@ghost
Copy link

ghost commented Mar 19, 2020

Hi @meker12, thank you for your contribution!
Please, complete Contribution Survey, it will take less than a minute.
Your feedback will help us to improve contribution process.

@meker12 meker12 deleted the mae-magecloud-4821-fastly-allowlist-updates branch March 19, 2020 15:51
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
2.3.x Magento 2.3 related changes Internal Dev Differentiates work between community and Magento staff
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants