You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2021/12/02 23:36:22 UTC

[GitHub] [trafficcontrol] TaylorCFrey opened a new pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

TaylorCFrey opened a new pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398


   <!--
   Thank you for contributing! Please be sure to read our contribution guidelines: https://github.com/apache/trafficcontrol/blob/master/CONTRIBUTING.md
   If this closes or relates to an existing issue, please reference it using one of the following:
   
   Closes: #ISSUE
   Related: #ISSUE
   
   If this PR fixes a security vulnerability, DO NOT submit! Instead, contact
   the Apache Traffic Control Security Team at security@trafficcontrol.apache.org and follow the
   guidelines at https://apache.org/security regarding vulnerability disclosure.
   -->
   
   Changed the warning text for creating invalidation jobs to add clarity and emphasis to REFRESH REFETCH options.
   
   <!-- **^ Add meaningful description above** --><hr>
   
   ## Which Traffic Control components are affected by this PR?
   <!-- Please delete all components from this list that are NOT affected by this PR.
   Feel free to add the name of a tool or script that is affected but not on the list.
   -->
   - Traffic Portal
   
   ## What is the best way to verify this PR?
   <!-- Please include here ALL the steps necessary to test your PR.
   If your PR has tests (and most should), provide the steps needed to run the tests.
   If not, please provide step-by-step instructions to test the PR manually and explain why your PR does not need tests. -->
   
   Launch and run Traffic Portal (with an appropriate Traffic Ops backend).
   
   1) Navigate to the Create Invalidation request. Menu -> Tools -> Invalidate Content -> More (Dropdown menu) -> Create Invalidation Request
   1a) Verify the changed warning text appears, is correctly worded (without grammar or spelling mistakes).
   
   2) Navigate to the Delivery Service specific Create Invalidation request. Menu -> Services -> Delivery Services -> Select an appropriate service -> More (Dropdown menu) -> Manage Invalidation Requests -> Create Invalidation Request
   2a) Verify the changed warning text appears, is correctly worded (without grammar or spelling mistakes).
   
   ## PR submission checklist
   - [x] This PR has tests. Text change only, no logic or functionality to verify.
   - [x] This PR has documentation. None required.
   - [x] This PR has a CHANGELOG.md entry <!-- A fix for a bug from an ATC release, an improvement, or a new feature should have a changelog entry. -->
   - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://apache.org/security) for details)
   
   <!--
   Licensed to the Apache Software Foundation (ASF) under one
   or more contributor license agreements.  See the NOTICE file
   distributed with this work for additional information
   regarding copyright ownership.  The ASF licenses this file
   to you under the Apache License, Version 2.0 (the
   "License"); you may not use this file except in compliance
   with the License.  You may obtain a copy of the License at
   
       http://www.apache.org/licenses/LICENSE-2.0
   
   Unless required by applicable law or agreed to in writing,
   software distributed under the License is distributed on an
   "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
   KIND, either express or implied.  See the License for the
   specific language governing permissions and limitations
   under the License.
   -->
   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762006362



##########
File path: CHANGELOG.md
##########
@@ -44,6 +44,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Changed Invalidation Jobs throughout (TO, TP, T3C, etc.) to account for the ability to do both REFRESH and REFETCH requests for resources.
 - The `admin` Role is now always guaranteed to exist, and can't be deleted or modified.
 - Updated `t3c-apply` to reduce mutable state in `TrafficOpsReq` struct.
+- Traffic Portal: Changed the warning text for creating a Content Invalidation job to add clarity and to emphasize severity. 

Review comment:
       Good call. Removed.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762115455



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,16 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <dl>
+                    <dt>Refresh (preferred default)</dt>
+                    <dd>Marks the matching asset(s) as "stale" and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25" target="_blank" rel="external">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26" target="_blank" rel="external">If-None-Match</a> specification can safely invalidate content using Refresh.</dd>
+                    <dt>Refetch</dt>
+                    <dd>Marks the matching asset(s) as a cache "miss" and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is <em>highly recommended</em> that the specified regex is very specific when using Refetch.</dd>
+                    <p>For additional information please see the documentation for <a href="https://traffic-control-cdn.readthedocs.io/en/latest/overview/jobs.html" target="_blank" rel="external">Content Invalidation Jobs.</a></p>

Review comment:
       The only permitted content of a [`<dl>` element tag](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) is:
   
   > Either: Zero or more groups each consisting of one or more `<dt>` elements followed by one or more `<dd>` elements, optionally intermixed with `<script>` and `<template>` elements.
   
   i.e. `<p>` is invalid here. This paragraph doesn't appear associated with either term in specific, so it should probably go outside the `<dl>` altogether. However, if appropriate, `<p>` is "Flow Content" and therefore allowed within a `<dd>`.

##########
File path: traffic_portal/app/src/common/modules/form/_form.scss
##########
@@ -222,11 +222,15 @@ div.helptext aside.warning {
 		}
 	}
 
-	p {
+	p, dl, dt {

Review comment:
       since the only permitted parent of a `<dt>` is a `<dl>` (or a `<div>` that is a direct child of a `<dl>` in HTML 5.2), it shouldn't need explicit background setting, since the initial value for `background` is `none 0% 0% auto auto repeat padding-box border-box scroll transparent` (`transparent` being the important part there) for all display elements.
   
   This isn't a big deal, though, since the margins and padding look fine, so you wanna keep that around. I honestly wouldn't bother changing it at this point, just wanted to point it out for next time.

##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,16 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <dl>
+                    <dt>Refresh (preferred default)</dt>
+                    <dd>Marks the matching asset(s) as "stale" and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25" target="_blank" rel="external">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26" target="_blank" rel="external">If-None-Match</a> specification can safely invalidate content using Refresh.</dd>
+                    <dt>Refetch</dt>
+                    <dd>Marks the matching asset(s) as a cache "miss" and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is <em>highly recommended</em> that the specified regex is very specific when using Refetch.</dd>
+                    <p>For additional information please see the documentation for <a href="https://traffic-control-cdn.readthedocs.io/en/latest/overview/jobs.html" target="_blank" rel="external">Content Invalidation Jobs.</a></p>

Review comment:
       From [MDN's article on the Anchor element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl):
   
   > Content within each `<a>` **should** indicate the link's destination.
   
   The <kbd>.</kbd> is part of the surrounding sentence structure, not part of the link; the page it takes you to is the documentation for Content Invalidation Jobs, so I'd have phrased it like this:
   
   ```html
   <p>For additional information please see <a href="https://traffic-control-cdn.readthedocs.io/en/latest/overview/jobs.html" target="_blank" rel="external">the documentation for Content Invalidation Jobs</a>.</p>
   ```
   This is a nit, but keep in mind that people who rely on screen readers to find links for them will have this read to them as "Content Invalidation Jobs." and that's definitely vague enough to be a link to a page in TP where Jobs are managed.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r761617653



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a> specification can safely invalidate content using REFRESH.</p>
+                <p>REFETCH will mark the matching asset(s) as a cache MISS and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is HIGHLY RECOMMENDED that the specified regex is very specific when using REFETCH.</p>

Review comment:
       you should probably add `target="_blank"` to all the anchor tags.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762131308



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,16 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <dl>
+                    <dt>Refresh (preferred default)</dt>
+                    <dd>Marks the matching asset(s) as "stale" and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25" target="_blank" rel="external">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26" target="_blank" rel="external">If-None-Match</a> specification can safely invalidate content using Refresh.</dd>
+                    <dt>Refetch</dt>
+                    <dd>Marks the matching asset(s) as a cache "miss" and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is <em>highly recommended</em> that the specified regex is very specific when using Refetch.</dd>
+                    <p>For additional information please see the documentation for <a href="https://traffic-control-cdn.readthedocs.io/en/latest/overview/jobs.html" target="_blank" rel="external">Content Invalidation Jobs.</a></p>

Review comment:
       A nit, perhaps, but honestly still important.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] mitchell852 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r761601930



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 

Review comment:
       maybe they need to be `stale` and `miss` or something




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762184495



##########
File path: traffic_portal/app/src/common/modules/form/_form.scss
##########
@@ -222,11 +222,15 @@ div.helptext aside.warning {
 		}
 	}
 
-	p {
+	p, dl, dt {

Review comment:
       I would separate out the background so that it's smaller and doesn't repeat itself:
   ```scss
   p, dl {
     background: #ffedcc;
   }
   p, dl, dt {
     padding: 5px;
     margin-bottom: 0;
   }
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 merged pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398


   


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762131120



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,16 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <dl>
+                    <dt>Refresh (preferred default)</dt>
+                    <dd>Marks the matching asset(s) as "stale" and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25" target="_blank" rel="external">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26" target="_blank" rel="external">If-None-Match</a> specification can safely invalidate content using Refresh.</dd>
+                    <dt>Refetch</dt>
+                    <dd>Marks the matching asset(s) as a cache "miss" and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is <em>highly recommended</em> that the specified regex is very specific when using Refetch.</dd>
+                    <p>For additional information please see the documentation for <a href="https://traffic-control-cdn.readthedocs.io/en/latest/overview/jobs.html" target="_blank" rel="external">Content Invalidation Jobs.</a></p>

Review comment:
       This was an oversight on my part. I'll get that out of the `<dl>` tag.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r761550565



##########
File path: CHANGELOG.md
##########
@@ -44,6 +44,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
 - Changed Invalidation Jobs throughout (TO, TP, T3C, etc.) to account for the ability to do both REFRESH and REFETCH requests for resources.
 - The `admin` Role is now always guaranteed to exist, and can't be deleted or modified.
 - Updated `t3c-apply` to reduce mutable state in `TrafficOpsReq` struct.
+- Traffic Portal: Changed the warning text for creating a Content Invalidation job to add clarity and to emphasize severity. 

Review comment:
       This hasn't actually changed though, has it? I see the line 
   > - Changed Invalidation Jobs throughout (TO, TP, T3C, etc.) to account for the ability to do both REFRESH and REFETCH requests for resources.
   
   above, so that hasn't actually been released, thus the warning text is not now different in a new release than it has been before. You know what I'm trying to say? I feel like these are arcane cascading clauses and I'm getting lost in them.

##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a> specification can safely invalidate content using REFRESH.</p>
+                <p>REFETCH will mark the matching asset(s) as a cache MISS and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is HIGHLY RECOMMENDED that the specified regex is very specific when using REFETCH.</p>

Review comment:
       This looks like a [description list](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/dl) to me

##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 

Review comment:
       I don't think "stale" and "miss" are being used as initialisms here, why are they in all caps?

##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a> specification can safely invalidate content using REFRESH.</p>
+                <p>REFETCH will mark the matching asset(s) as a cache MISS and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is HIGHLY RECOMMENDED that the specified regex is very specific when using REFETCH.</p>

Review comment:
       emphasis should use [the emphasis HTML element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em), or to convey contextual urgency rather than literal verbal stress, use [the strong importance element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/em). All caps should not be used for either - and not just because there are better ways (and if you still want them in all caps that can be done accessibly through styling with `text-transform: uppercase` as a CSS rule) but because it causes accessibility problems. Screen-readers will read words in all caps letter-by-letter, which is why that should be reserved for cases where it's appropriate, like abbreviations, acronyms, and initialisms (which is why "IMS" is fine here). 




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762007073



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a> specification can safely invalidate content using REFRESH.</p>
+                <p>REFETCH will mark the matching asset(s) as a cache MISS and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is HIGHLY RECOMMENDED that the specified regex is very specific when using REFETCH.</p>

Review comment:
       TIL with `<dl>`. Thanks!
   
   Added the correct target to the anchor tag, as well as an appropriate `rel` attribute.

##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 

Review comment:
       Done




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r761604518



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 

Review comment:
       I would probably do `"stale"` and `"miss"` to indicate that a domain-specific meaning of a word somewhat different than its general definition is being used.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762007794



##########
File path: traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
##########
@@ -31,7 +31,12 @@
         <div class="helptext">
             <aside class="warning">
                 <h6>Warning</h6>
-                <p>Delivery service origin(s) must support IMS in order to safely invalidate content</p>
+                <p>REFRESH (preferred default) will mark the matching asset(s) as STALE and an IMS request of the asset(s) from the origin will be performed. Origins that fully adhere 
+                    to the <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.25">If-Modified-Since</a> 
+                    and <a href="https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.26">If-None-Match</a> specification can safely invalidate content using REFRESH.</p>
+                <p>REFETCH will mark the matching asset(s) as a cache MISS and a new full request of the asset(s) from the origin will be performed. 
+                    This operation is expensive and it is HIGHLY RECOMMENDED that the specified regex is very specific when using REFETCH.</p>

Review comment:
       Done. Please double check the changes to CSS (`_form.scss`) to ensure they are correct and maintanable.




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] TaylorCFrey commented on a change in pull request #6398: Add clarity and emphasis to REFRESH REFETCH options

Posted by GitBox <gi...@apache.org>.
TaylorCFrey commented on a change in pull request #6398:
URL: https://github.com/apache/trafficcontrol/pull/6398#discussion_r762132917



##########
File path: traffic_portal/app/src/common/modules/form/_form.scss
##########
@@ -222,11 +222,15 @@ div.helptext aside.warning {
 		}
 	}
 
-	p {
+	p, dl, dt {

Review comment:
       In the future, should I create a separate scope for just the `<dt>` to get the desired padding/marging? Perhaps:
   
   ```css
   p, dl {
     background: #ffedcc;
     padding: 5px;
     margin-bottom: 0;
   }
   
   dt {
     padding: 5px;
     margin-bottom: 0;
   }
   ```




-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org