Skip to content

Commit

Permalink
Deploy website from source
Browse files Browse the repository at this point in the history
  • Loading branch information
eliben committed Aug 21, 2023
1 parent 4aaca33 commit d0d857b
Show file tree
Hide file tree
Showing 11 changed files with 764 additions and 60 deletions.
94 changes: 94 additions & 0 deletions docstore/internal/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,94 @@
<!DOCTYPE html>
<html lang="en-us">
<head>
<meta http-equiv="content-type" content="text/html; charset=utf-8">
<meta name="generator" content="Hugo 0.54.0" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Internals &middot; Go CDK</title>

<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700|Source+Code+Pro|Work+Sans:400,700">
<link type="text/css" rel="stylesheet" href="/css/syntax.css">
<link type="text/css" rel="stylesheet" href="/css/style.css">
<link rel="shortcut icon" href="/favicon-32x32.png">

<script type="application/javascript">
var doNotTrack = false;
if (!doNotTrack) {
window.ga=window.ga||function(){(ga.q=ga.q||[]).push(arguments)};ga.l=+new Date;
ga('create', 'UA-135118641-1', 'auto');

ga('send', 'pageview');
}
</script>
<script async src='https://www.google-analytics.com/analytics.js'></script>

</head>
<body>
<div class="PageLayout">
<header class="PageHeader">
<a href="https://gocloud.dev/"><h1 class="PageLogo"><img class="PageLogo-image" src="/go-cdk-logo-white.png" alt="Go CDK"></h1></a>
</header>
<main class="MainContent">
<div class="MainContent-bounds"><h1>Internals</h1>


</div>
</main>
<nav class="Sidenav">
<ul class="Sidenav-list">
<li class="Sidenav-section">
<a href="/" class="Sidenav-sectionLink">Home</a>
</li>
<li class="Sidenav-section">
<a href="/tutorials/" class="Sidenav-sectionLink">Tutorials</a>
<ul class="Sidenav-pageList">
<li class="Sidenav-page">
<a href="/tutorials/cli-uploader/" class="Sidenav-pageLink">Command-Line Uploader</a>
</li>
<li class="Sidenav-page">
<a href="/tutorials/guestbook/" class="Sidenav-pageLink">Guestbook</a>
</li>
<li class="Sidenav-page">
<a href="/tutorials/order/" class="Sidenav-pageLink">Order Processor</a>
</li>
</ul>
</li>
<li class="Sidenav-section">
<a href="/howto/" class="Sidenav-sectionLink">How-To Guides</a>
<ul class="Sidenav-pageList">
</ul>
</li>
<li class="Sidenav-section">
<a href="/concepts/" class="Sidenav-sectionLink">Concepts</a>
<ul class="Sidenav-pageList">
<li class="Sidenav-page">
<a href="/concepts/structure/" class="Sidenav-pageLink">Structuring Portable Code</a>
</li>
<li class="Sidenav-page">
<a href="/concepts/urls/" class="Sidenav-pageLink">URLs</a>
</li>
<li class="Sidenav-page">
<a href="/concepts/as/" class="Sidenav-pageLink">Using provider-specific APIs</a>
</li>
</ul>
</li>
</ul>
</nav>
<footer class="PageFooter">
<nav>
<ul class="FooterLinks">
<li class="FooterLinks-item"><a href="https://github.com/google/go-cloud/" class="FooterLinks-link">GitHub</a></li>
<li class="FooterLinks-item"><a href="https://github.com/google/go-cloud/issues" class="FooterLinks-link">Contact Team</a></li>
</ul>
</nav>

<p class="PageFooter-paragraph">
Copyright © 2018–2019 The Go Cloud Development Kit Authors.
All content released under an <a href="https://github.com/google/go-cloud/blob/master/LICENSE" target="_blank" class="PageFooter-link">Apache 2.0 License</a>.
</p>
<p class="PageFooter-paragraph"><a href="https://github.com/google/go-cloud/edit/master/internal/website/content/" class="PageFooter-link">Improve this page</a> on GitHub.</p>
</footer>
</div>
</body>
</html>
111 changes: 84 additions & 27 deletions howto/blob/index.html

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions howto/pubsub/publish/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ <h4 id="sqs-ctor"> Amazon SQS Constructor<a class="anchor" href="#sqs-ctor" aria
<span class="k">defer</span> <span class="nx">topic</span><span class="p">.</span><span class="nf">Shutdown</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>
</code></pre></div>
<h3 id="azure"> Azure Service Bus<a class="anchor" href="#azure" aria-label="Link to Section">🔗</a></h3>
<p>The Go CDK can publish to an <a href="https://azure.microsoft.com/en-us/services/service-bus/">Azure Service Bus</a> topic over <a href="https://www.amqp.org/">AMQP 1.0</a>.
<p>The Go CDK can publish to an <a href="https://azure.microsoft.com/en-us/services/service-bus/">Azure Service Bus</a> topic.
The URL for publishing is the topic name. <code>pubsub.OpenTopic</code> will use the
environment variable <code>SERVICEBUS_CONNECTION_STRING</code> to obtain the Service Bus
connection string. The connection string can be obtained
Expand All @@ -304,7 +304,7 @@ <h3 id="azure"> Azure Service Bus<a class="anchor" href="#azure" aria-label="Lin
</code></pre></div>
<h4 id="azure-ctor"> Azure Service Bus Constructor<a class="anchor" href="#azure-ctor" aria-label="Link to Section">🔗</a></h4>
<p>The <a href="https://godoc.org/gocloud.dev/pubsub/azuresb#OpenTopic"><code>azuresb.OpenTopic</code></a> constructor opens an Azure Service Bus topic. You
must first connect to the topic using the <a href="https://github.com/Azure/azure-service-bus-go">Azure Service Bus library</a> and
must first connect to the topic using the <a href="https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus">Azure Service Bus library</a> and
then pass it to <code>azuresb.OpenTopic</code>. There are also helper functions in the
<code>azuresb</code> package to make this easier.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="kn">import</span> <span class="p">(</span>
Expand All @@ -323,18 +323,18 @@ <h4 id="azure-ctor"> Azure Service Bus Constructor<a class="anchor" href="#azure
<span class="p">}</span>

<span class="c1">// Connect to Azure Service Bus for the given topic.
</span><span class="c1"></span><span class="nx">busNamespace</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewNamespaceFromConnectionString</span><span class="p">(</span><span class="nx">connString</span><span class="p">)</span>
</span><span class="c1"></span><span class="nx">sbClient</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewClientFromConnectionString</span><span class="p">(</span><span class="nx">connString</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
<span class="nx">busTopic</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewTopic</span><span class="p">(</span><span class="nx">busNamespace</span><span class="p">,</span> <span class="nx">topicName</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="nx">sbSender</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewSender</span><span class="p">(</span><span class="nx">sbClient</span><span class="p">,</span> <span class="nx">topicName</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
<span class="k">defer</span> <span class="nx">busTopic</span><span class="p">.</span><span class="nf">Close</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>
<span class="k">defer</span> <span class="nx">sbSender</span><span class="p">.</span><span class="nf">Close</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>

<span class="c1">// Construct a *pubsub.Topic.
</span><span class="c1"></span><span class="nx">topic</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">OpenTopic</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="nx">busTopic</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
</span><span class="c1"></span><span class="nx">topic</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">OpenTopic</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="nx">sbSender</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
Expand Down Expand Up @@ -363,11 +363,11 @@ <h3 id="rabbitmq"> RabbitMQ<a class="anchor" href="#rabbitmq" aria-label="Link t
</code></pre></div>
<h4 id="rabbitmq-ctor"> RabbitMQ Constructor<a class="anchor" href="#rabbitmq-ctor" aria-label="Link to Section">🔗</a></h4>
<p>The <a href="https://godoc.org/gocloud.dev/pubsub/rabbitpubsub#OpenTopic"><code>rabbitpubsub.OpenTopic</code></a> constructor opens a RabbitMQ exchange. You
must first create an <a href="https://godoc.org/github.com/streadway/amqp#Connection"><code>*amqp.Connection</code></a> to your RabbitMQ instance.</p>
must first create an <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Connection"><code>*amqp.Connection</code></a> to your RabbitMQ instance.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="kn">import</span> <span class="p">(</span>
<span class="s">&#34;context&#34;</span>

<span class="s">&#34;github.com/streadway/amqp&#34;</span>
<span class="nx">amqp</span> <span class="s">&#34;github.com/rabbitmq/amqp091-go&#34;</span>
<span class="s">&#34;gocloud.dev/pubsub/rabbitpubsub&#34;</span>
<span class="p">)</span>

Expand Down
26 changes: 10 additions & 16 deletions howto/pubsub/subscribe/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,7 @@ <h3 id="sqs"> Amazon Simple Queueing Service<a class="anchor" href="#sqs" aria-l
whether the message bodies are raw or <a href="https://aws.amazon.com/sns/faqs/#Raw_message_delivery">SNS JSON</a>.</p>
<p>Messages with a <code>base64encoded</code> message attribute will be automatically
<a href="https://en.wikipedia.org/wiki/Base64">Base64</a> decoded before being returned. See the <a href="https://gocloud.dev/howto/pubsub/publish/#sns">SNS publishing guide</a>
or the [SQS publshing guide][] for more details.</p>
or the <a href="https://gocloud.dev/howto/pubsub/publish/#sqs">SQS publishing guide</a> for more details.</p>
<h4 id="sqs-ctor"> Amazon SQS Constructor<a class="anchor" href="#sqs-ctor" aria-label="Link to Section">🔗</a></h4>
<p>The <a href="https://godoc.org/gocloud.dev/pubsub/awssnssqs#OpenSubscription"><code>awssnssqs.OpenSubscription</code></a> constructor opens an SQS queue. You must
first create an <a href="https://docs.aws.amazon.com/sdk-for-go/api/aws/session/">AWS session</a> with the same region as your topic:</p>
Expand Down Expand Up @@ -277,8 +277,8 @@ <h4 id="sqs-ctor"> Amazon SQS Constructor<a class="anchor" href="#sqs-ctor" aria
<span class="k">defer</span> <span class="nx">subscription</span><span class="p">.</span><span class="nf">Shutdown</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>
</code></pre></div>
<h3 id="azure"> Azure Service Bus<a class="anchor" href="#azure" aria-label="Link to Section">🔗</a></h3>
<p>The Go CDK can recieve messages from an <a href="https://azure.microsoft.com/en-us/services/service-bus/">Azure Service Bus</a> subscription
over <a href="https://www.amqp.org/">AMQP 1.0</a>. The URL for subscribing is the topic name with the
<p>The Go CDK can recieve messages from an <a href="https://azure.microsoft.com/en-us/services/service-bus/">Azure Service Bus</a> subscription.
The URL for subscribing is the topic name with the
subscription name in the <code>subscription</code> query parameter.
<code>pubsub.OpenSubscription</code> will use the environment variable
<code>SERVICEBUS_CONNECTION_STRING</code> to obtain the Service Bus Connection String
Expand All @@ -304,7 +304,7 @@ <h3 id="azure"> Azure Service Bus<a class="anchor" href="#azure" aria-label="Lin
<h4 id="azure-ctor"> Azure Service Bus Constructor<a class="anchor" href="#azure-ctor" aria-label="Link to Section">🔗</a></h4>
<p>The <a href="https://godoc.org/gocloud.dev/pubsub/azuresb#OpenSubscription"><code>azuresb.OpenSubscription</code></a> constructor opens an Azure Service Bus
subscription. You must first connect to the topic and subscription using the
<a href="https://github.com/Azure/azure-service-bus-go">Azure Service Bus library</a> and then pass the subscription to
<a href="https://pkg.go.dev/github.com/Azure/azure-sdk-for-go/sdk/messaging/azservicebus">Azure Service Bus library</a> and then pass the subscription to
<code>azuresb.OpenSubscription</code>. There are also helper functions in the <code>azuresb</code>
package to make this easier.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="kn">import</span> <span class="p">(</span>
Expand All @@ -320,24 +320,18 @@ <h4 id="azure-ctor"> Azure Service Bus Constructor<a class="anchor" href="#azure
<span class="kd">const</span> <span class="nx">subscriptionName</span> <span class="p">=</span> <span class="s">&#34;test-subscription&#34;</span>

<span class="c1">// Connect to Azure Service Bus for the given subscription.
</span><span class="c1"></span><span class="nx">busNamespace</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewNamespaceFromConnectionString</span><span class="p">(</span><span class="nx">serviceBusConnString</span><span class="p">)</span>
</span><span class="c1"></span><span class="nx">sbClient</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewClientFromConnectionString</span><span class="p">(</span><span class="nx">serviceBusConnString</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
<span class="nx">busTopic</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewTopic</span><span class="p">(</span><span class="nx">busNamespace</span><span class="p">,</span> <span class="nx">topicName</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="nx">sbReceiver</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewReceiver</span><span class="p">(</span><span class="nx">sbClient</span><span class="p">,</span> <span class="nx">topicName</span><span class="p">,</span> <span class="nx">subscriptionName</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
<span class="k">defer</span> <span class="nx">busTopic</span><span class="p">.</span><span class="nf">Close</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>
<span class="nx">busSub</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">NewSubscription</span><span class="p">(</span><span class="nx">busTopic</span><span class="p">,</span> <span class="nx">subscriptionName</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
<span class="k">defer</span> <span class="nx">busSub</span><span class="p">.</span><span class="nf">Close</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>
<span class="k">defer</span> <span class="nx">sbReceiver</span><span class="p">.</span><span class="nf">Close</span><span class="p">(</span><span class="nx">ctx</span><span class="p">)</span>

<span class="c1">// Construct a *pubsub.Subscription.
</span><span class="c1"></span><span class="nx">subscription</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">OpenSubscription</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span>
<span class="nx">busNamespace</span><span class="p">,</span> <span class="nx">busTopic</span><span class="p">,</span> <span class="nx">busSub</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
</span><span class="c1"></span><span class="nx">subscription</span><span class="p">,</span> <span class="nx">err</span> <span class="o">:=</span> <span class="nx">azuresb</span><span class="p">.</span><span class="nf">OpenSubscription</span><span class="p">(</span><span class="nx">ctx</span><span class="p">,</span> <span class="nx">sbClient</span><span class="p">,</span> <span class="nx">sbReceiver</span><span class="p">,</span> <span class="kc">nil</span><span class="p">)</span>
<span class="k">if</span> <span class="nx">err</span> <span class="o">!=</span> <span class="kc">nil</span> <span class="p">{</span>
<span class="k">return</span> <span class="nx">err</span>
<span class="p">}</span>
Expand Down Expand Up @@ -366,11 +360,11 @@ <h3 id="rabbitmq"> RabbitMQ<a class="anchor" href="#rabbitmq" aria-label="Link t
</code></pre></div>
<h4 id="rabbitmq-ctor"> RabbitMQ Constructor<a class="anchor" href="#rabbitmq-ctor" aria-label="Link to Section">🔗</a></h4>
<p>The <a href="https://godoc.org/gocloud.dev/pubsub/rabbitpubsub#OpenSubscription"><code>rabbitpubsub.OpenSubscription</code></a> constructor opens a RabbitMQ queue.
You must first create an <a href="https://godoc.org/github.com/streadway/amqp#Connection"><code>*amqp.Connection</code></a> to your RabbitMQ instance.</p>
You must first create an <a href="https://pkg.go.dev/github.com/rabbitmq/amqp091-go#Connection"><code>*amqp.Connection</code></a> to your RabbitMQ instance.</p>
<div class="highlight"><pre tabindex="0" class="chroma"><code class="language-go" data-lang="go"><span class="kn">import</span> <span class="p">(</span>
<span class="s">&#34;context&#34;</span>

<span class="s">&#34;github.com/streadway/amqp&#34;</span>
<span class="nx">amqp</span> <span class="s">&#34;github.com/rabbitmq/amqp091-go&#34;</span>
<span class="s">&#34;gocloud.dev/pubsub/rabbitpubsub&#34;</span>
<span class="p">)</span>

Expand Down
Loading

0 comments on commit d0d857b

Please sign in to comment.