Skip to content

Commit

Permalink
Refreshes Retype-generated documentation.
Browse files Browse the repository at this point in the history 
Process triggered by nadeesha.
  • Loading branch information
Retype GitHub Action committed Jan 1, 2024
1 parent 7c354ff commit 7e10591
Show file tree
Hide file tree
Showing 19 changed files with 473 additions and 109 deletions.
8 changes: 4 additions & 4 deletions 404.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757378087026">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757412809408">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">
Expand All @@ -27,11 +27,11 @@

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="/resources/css/retype.css?v=3.5.0.757378087026" rel="stylesheet">
<link href="/resources/css/retype.css?v=3.5.0.757412809408" rel="stylesheet">

<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.757378087026" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/config.js?v=3.5.0.757412809408" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="/resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.757378087026" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="/resources/js/lunr.js?v=3.5.0.757412809408" data-turbo-eval="false" defer></script>

<script>
!function (t, e) { var o, n, p, r; e.__SV || (window.posthog = e, e._i = [], e.init = function (i, s, a) { function g(t, e) { var o = e.split("."); 2 == o.length && (t = t[o[0]], e = o[1]), t[e] = function () { t.push([e].concat(Array.prototype.slice.call(arguments, 0))) } } (p = t.createElement("script")).type = "text/javascript", p.async = !0, p.src = s.api_host + "/static/array.js", (r = t.getElementsByTagName("script")[0]).parentNode.insertBefore(p, r); var u = e; for (void 0 !== a ? u = e[a] = [] : a = "posthog", u.people = u.people || [], u.toString = function (t) { var e = "posthog"; return "posthog" !== a && (e += "." + a), t || (e += " (stub)"), e }, u.people.toString = function () { return u.toString(1) + ".people (stub)" }, o = "capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys onSessionId".split(" "), n = 0; n < o.length; n++)g(u, o[n]); e._i.push([i, s, a]) }, e.__SV = 1) }(document, window.posthog || []);
Expand Down
104 changes: 67 additions & 37 deletions changelog/index.html → advanced/advanced-usage/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,38 +3,39 @@
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757378087026">
<meta name="turbo-cache-control" content="no-cache" data-turbo-track="reload" data-track-token="3.5.0.757412809408">

<!-- See retype.com -->
<meta name="generator" content="Retype 3.5.0">

<!-- Primary Meta Tags -->
<title>CHANGELOG</title>
<meta name="title" content="CHANGELOG">
<meta name="description" content="sdk: Add setConcurrency to dynamically change host concurrency ( fcbbd40)">
<title>Advanced Usage</title>
<meta name="title" content="Advanced Usage">
<meta name="description" content="You might wish to encrypt all function arguments and return values, so that the control plane cannot see them.">

<!-- Canonical -->
<link rel="canonical" href="https://docs.differential.dev/changelog/">
<link rel="canonical" href="https://docs.differential.dev/advanced/advanced-usage/">

<!-- Open Graph / Facebook -->
<meta property="og:type" content="website">
<meta property="og:url" content="https://docs.differential.dev/changelog/">
<meta property="og:title" content="CHANGELOG">
<meta property="og:description" content="sdk: Add setConcurrency to dynamically change host concurrency ( fcbbd40)">
<meta property="og:url" content="https://docs.differential.dev/advanced/advanced-usage/">
<meta property="og:title" content="Advanced Usage">
<meta property="og:description" content="You might wish to encrypt all function arguments and return values, so that the control plane cannot see them.">

<!-- Twitter -->
<meta property="twitter:card" content="summary_large_image">
<meta property="twitter:url" content="https://docs.differential.dev/changelog/">
<meta property="twitter:title" content="CHANGELOG">
<meta property="twitter:description" content="sdk: Add setConcurrency to dynamically change host concurrency ( fcbbd40)">
<meta property="twitter:url" content="https://docs.differential.dev/advanced/advanced-usage/">
<meta property="twitter:title" content="Advanced Usage">
<meta property="twitter:description" content="You might wish to encrypt all function arguments and return values, so that the control plane cannot see them.">

<script data-cfasync="false">(function () { var el = document.documentElement, m = localStorage.getItem("doc_theme"), wm = window.matchMedia; if (m === "dark" || (!m && wm && wm("(prefers-color-scheme: dark)").matches)) { el.classList.add("dark") } else { el.classList.remove("dark") } })();</script>

<link href="../resources/css/retype.css?v=3.5.0.757378087026" rel="stylesheet">
<link href="../../resources/css/retype.css?v=3.5.0.757412809408" rel="stylesheet">

<script data-cfasync="false" src="../resources/js/config.js?v=3.5.0.757378087026" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../resources/js/lunr.js?v=3.5.0.757378087026" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../../resources/js/config.js?v=3.5.0.757412809408" data-turbo-eval="false" defer></script>
<script data-cfasync="false" src="../../resources/js/retype.js?v=3.5.0" data-turbo-eval="false" defer></script>
<script id="lunr-js" data-cfasync="false" src="../../resources/js/lunr.js?v=3.5.0.757412809408" data-turbo-eval="false" defer></script>
<script id="prism-js" data-cfasync="false" src="../../resources/js/prism.js?v=3.5.0.757412809408" defer></script>

<script>
!function (t, e) { var o, n, p, r; e.__SV || (window.posthog = e, e._i = [], e.init = function (i, s, a) { function g(t, e) { var o = e.split("."); 2 == o.length && (t = t[o[0]], e = o[1]), t[e] = function () { t.push([e].concat(Array.prototype.slice.call(arguments, 0))) } } (p = t.createElement("script")).type = "text/javascript", p.async = !0, p.src = s.api_host + "/static/array.js", (r = t.getElementsByTagName("script")[0]).parentNode.insertBefore(p, r); var u = e; for (void 0 !== a ? u = e[a] = [] : a = "posthog", u.people = u.people || [], u.toString = function (t) { var e = "posthog"; return "posthog" !== a && (e += "." + a), t || (e += " (stub)"), e }, u.people.toString = function () { return u.toString(1) + ".people (stub)" }, o = "capture identify alias people.set people.set_once set_config register register_once unregister opt_out_capturing has_opted_out_capturing opt_in_capturing reset isFeatureEnabled onFeatureFlags getFeatureFlag getFeatureFlagPayload reloadFeatureFlags group updateEarlyAccessFeatureEnrollment getEarlyAccessFeatures getActiveMatchingSurveys getSurveys onSessionId".split(" "), n = 0; n < o.length; n++)g(u, o[n]); e._i.push([i, s, a]) }, e.__SV = 1) }(document, window.posthog || []);
Expand All @@ -54,10 +55,10 @@
<!-- Logo -->
<div class="flex items-center justify-between h-full py-2 md:w-75">
<div class="flex items-center px-2 md:px-6">
<a id="docs-site-logo" href="../" class="flex items-center leading-snug text-xl">
<a id="docs-site-logo" href="../../" class="flex items-center leading-snug text-xl">
<span class="w-10 mr-2 grow-0 shrink-0 overflow-hidden">
<img class="max-h-10 dark:hidden md:inline-block" src="../256.png">
<img class="max-h-10 hidden dark:inline-block" src="../256.png">
<img class="max-h-10 dark:hidden md:inline-block" src="../../256.png">
<img class="max-h-10 hidden dark:inline-block" src="../../256.png">
</span>
<span class="dark:text-white font-semibold line-clamp-1 md:line-clamp-2">Differential Docs</span>
</a>
Expand Down Expand Up @@ -184,28 +185,50 @@
<!-- Rendered if sidebar right is enabled -->
<div id="docs-sidebar-right-toggle"></div>
<!-- Page content -->
<doc-anchor-target id="changelog" class="break-words">
<doc-anchor-target id="advanced-usage" class="break-words">
<h1>
<doc-anchor-trigger class="header-anchor-trigger" to="#changelog">#</doc-anchor-trigger>
<span>CHANGELOG</span>
<doc-anchor-trigger class="header-anchor-trigger" to="#advanced-usage">#</doc-anchor-trigger>
<span>Advanced Usage</span>
</h1>
</doc-anchor-target>
<doc-anchor-target id="0036-2023-12-24">
<doc-anchor-target id="end-to-end-encryption">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#0036-2023-12-24">#</doc-anchor-trigger>
<span><a href="https://github.com/differentialHQ/differential/compare/v0.0.0...v0.0.36">0.0.36</a> (2023-12-24)</span>
<doc-anchor-trigger class="header-anchor-trigger" to="#end-to-end-encryption">#</doc-anchor-trigger>
<span>End to End Encryption</span>
</h2>
</doc-anchor-target>
<doc-anchor-target id="features">
<h3>
<doc-anchor-trigger class="header-anchor-trigger" to="#features">#</doc-anchor-trigger>
<span>Features</span>
</h3>
<p>You might wish to encrypt all function arguments and return values, so that the control plane cannot see them. This is possible with Differential, but it requires you to configure your own encryption keys.</p>
<p>These encryption keys are used to encrypt and decrypt the function arguments and return values. The control plane does not have access to these keys.</p>
<p>The Typescript example below shows how to configure your own encryption keys.</p>
<div class="codeblock-wrapper"><doc-codeblock>
<pre class="language-typescript"><code v-pre class="language-typescript">const d = new Differential(&quot;API_SECRET&quot;, {
encryptionKeys: [
Buffer.from(&quot;abcdefghijklmnopqrstuvwxzy123456&quot;), // 32 bytes
],
});</code></pre>
</doc-codeblock></div>
<p>It accepts an array of encryption keys. This is useful if you want to rotate your encryption keys. Differential will try to decrypt the function arguments and return values with each encryption key until it finds one that works.</p>
<doc-anchor-target id="idempotency">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#idempotency">#</doc-anchor-trigger>
<span>Idempotency</span>
</h2>
</doc-anchor-target>
<p>Coming soon.</p>
<doc-anchor-target id="global-cache">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#global-cache">#</doc-anchor-trigger>
<span>Global Cache</span>
</h2>
</doc-anchor-target>
<ul>
<li><strong>sdk:</strong> Add setConcurrency to dynamically change host concurrency (<a href="https://github.com/differentialHQ/differential/commit/fcbbd401ec3aa0356aaf7e5b43d38d700c3974a4">fcbbd40</a>)</li>
<li>Updating the docs to 3.0 (<a href="https://github.com/differentialHQ/differential/commit/732247b82975553f47d23d82f9b6fd1a7106e1a4">732247b</a>)</li>
</ul>
<p>Coming soon.</p>
<doc-anchor-target id="rate-limiting">
<h2>
<doc-anchor-trigger class="header-anchor-trigger" to="#rate-limiting">#</doc-anchor-trigger>
<span>Rate Limiting</span>
</h2>
</doc-anchor-target>
<p>Coming soon.</p>


<!-- Required only on API pages -->
Expand All @@ -215,16 +238,23 @@ <h3>

<nav class="flex mt-14">
<div class="w-1/2">
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-r rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../api/differential/">
<a class="px-5 py-4 h-full flex items-center break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-l-lg transition-colors duration-150 relative hover:z-5" href="../../advanced/concepts/">
<svg xmlns="http://www.w3.org/2000/svg" class="mr-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19 11H7.41l5.29-5.29a.996.996 0 10-1.41-1.41l-7 7a1 1 0 000 1.42l7 7a1.024 1.024 0 001.42-.01.996.996 0 000-1.41L7.41 13H19c.55 0 1-.45 1-1s-.45-1-1-1z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
<span>
<span class="block text-xs font-normal text-gray-400 dark:text-dark-400">Previous</span>
<span class="block mt-1">Class: Differential</span>
<span class="block mt-1">Concepts</span>
</span>
</a>
</div>

<div class="w-1/2">
<a class="px-5 py-4 -mx-px h-full flex items-center justify-end break-normal font-medium text-blue-500 dark:text-blue-400 border border-gray-300 hover:border-gray-400 dark:border-dark-650 dark:hover:border-dark-450 rounded-r-lg transition-colors duration-150 relative hover:z-5" href="../../advanced/architecture/">
<span>
<span class="block text-xs font-normal text-right text-gray-400 dark:text-dark-400">Next</span>
<span class="block mt-1">Architecture</span>
</span>
<svg xmlns="http://www.w3.org/2000/svg" class="ml-3" width="24" height="24" viewBox="0 0 24 24" fill="currentColor" overflow="visible"><path d="M19.92 12.38a1 1 0 00-.22-1.09l-7-7a.996.996 0 10-1.41 1.41l5.3 5.3H5c-.55 0-1 .45-1 1s.45 1 1 1h11.59l-5.29 5.29a.996.996 0 000 1.41c.19.2.44.3.7.3s.51-.1.71-.29l7-7c.09-.09.16-.21.21-.33z" /><path fill="none" d="M0 0h24v24H0z" /></svg>
</a>
</div>
</nav>
</footer>
Expand All @@ -236,7 +266,7 @@ <h3>
<ul class="flex flex-wrap items-center text-sm">
</ul>
</div>
<div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2023. All rights reserved.</p></div>
<div class="docs-copyright py-2 text-gray-500 dark:text-dark-350 text-sm leading-relaxed"><p>© Copyright 2024. All rights reserved.</p></div>
</footer>
</div>
</div>
Expand Down Expand Up @@ -265,6 +295,6 @@ <h3>

<div id="docs-overlay-target"></div>

<script data-cfasync="false">window.__DOCS__ = { "title": "CHANGELOG", level: 1, icon: "file", hasPrism: false, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
<script data-cfasync="false">window.__DOCS__ = { "title": "Advanced Usage", level: 2, icon: "file", hasPrism: true, hasMermaid: false, hasMath: false, tocDepth: 23 }</script>
</body>
</html>
Loading

0 comments on commit 7e10591

Please sign in to comment.