You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by oc...@apache.org on 2021/12/03 19:18:01 UTC
[trafficcontrol] branch master updated: Add clarity and emphasis to REFRESH REFETCH options (#6398)
This is an automated email from the ASF dual-hosted git repository.
ocket8888 pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new a79ae15 Add clarity and emphasis to REFRESH REFETCH options (#6398)
a79ae15 is described below
commit a79ae15fdd7d7b61b5a2f218d81ce694dc02f2e3
Author: Taylor Clayton Frey <ta...@gmail.com>
AuthorDate: Fri Dec 3 12:17:50 2021 -0700
Add clarity and emphasis to REFRESH REFETCH options (#6398)
* Add clarity and emphasis to REFRESH REFETCH options
* Use description list html element.
Add appropriate attributes to anchor tags.
Add additional styling for aside warning inner elements.
Use emphasis rather than visual representation.
Remove unnecessary CHANGELOG entry.
* Move <p> tag outside of <dl>
Move fullstop out of anchor element.
Co-authored-by: Taylor Frey <ta...@comcast.com>
---
traffic_portal/app/src/common/modules/form/_form.scss | 6 +++++-
.../form/deliveryServiceJob/form.deliveryServiceJob.tpl.html | 11 ++++++++++-
.../app/src/common/modules/form/job/form.job.tpl.html | 11 ++++++++++-
3 files changed, 25 insertions(+), 3 deletions(-)
diff --git a/traffic_portal/app/src/common/modules/form/_form.scss b/traffic_portal/app/src/common/modules/form/_form.scss
index 5ba09e0..a831ca0 100644
--- a/traffic_portal/app/src/common/modules/form/_form.scss
+++ b/traffic_portal/app/src/common/modules/form/_form.scss
@@ -222,11 +222,15 @@ div.helptext aside.warning {
}
}
- p {
+ p, dl, dt {
background: #ffedcc;
padding: 5px;
margin-bottom: 0;
}
+
+ em {
+ text-transform: uppercase;
+ }
}
/********** bootstrap overriding user-agent styling.... **********/
diff --git a/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html b/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
index 6001000..8cd6f26 100644
--- a/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
+++ b/traffic_portal/app/src/common/modules/form/deliveryServiceJob/form.deliveryServiceJob.tpl.html
@@ -31,7 +31,16 @@ under the License.
<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>
+ </dl>
+ <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>
</aside>
</div>
<br>
diff --git a/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html b/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
index 76e4a38..0526dc5 100644
--- a/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
+++ b/traffic_portal/app/src/common/modules/form/job/form.job.tpl.html
@@ -29,7 +29,16 @@ under the License.
<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>
+ </dl>
+ <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>
</aside>
</div>
<br>