Skip to content

Commit 4f62607

Browse files
committed
πŸ¦„ Upload docs
1 parent c3745b3 commit 4f62607

13 files changed

Lines changed: 25 additions & 285 deletions

File tree

docs/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css renamed to docs/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

β€Ždocs/docs/building-a-dockerized-restful-api-application-in-go/index.htmlβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<title>Building a Dockerized RESTful API application in Go Β· Learning Cloud Native Go</title>
1414
<link rel="canonical" href="https://learning-cloud-native-go.github.io/docs/building-a-dockerized-restful-api-application-in-go/">
15-
<link rel="stylesheet" href="/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css" integrity="">
15+
<link rel="stylesheet" href="/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css" integrity="">
1616

1717
<link rel="manifest" href="/manifest.json">
1818
<link rel="icon" href="/favicon/favicon.ico">
@@ -144,8 +144,7 @@ <h1>Building a Dockerized RESTful API application in Go</h1>
144144
<p></p>
145145
</header>
146146
<div id="article-body">
147-
<blockquote class="info">
148-
<p><strong>πŸ‘¨β€πŸ«</strong> <strong>In this series&hellip;</strong></p>
147+
<blockquote class="info"><p><strong>πŸ‘¨β€πŸ«</strong> <strong>In this series&hellip;</strong></p>
149148
<p>In this series, we are going to build a Dockerized Go RESTful API for a bookshelf with these steps:</p>
150149
<ul>
151150
<li>Create a basic server using Go&rsquo;s <code>net/http</code> package and Dockerize it.</li>

β€Ždocs/docs/configurations/index.htmlβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<title>Configurations Β· Learning Cloud Native Go</title>
1414
<link rel="canonical" href="https://learning-cloud-native-go.github.io/docs/configurations/">
15-
<link rel="stylesheet" href="/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css" integrity="">
15+
<link rel="stylesheet" href="/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css" integrity="">
1616

1717
<link rel="manifest" href="/manifest.json">
1818
<link rel="icon" href="/favicon/favicon.ico">
@@ -144,8 +144,7 @@ <h1>Configurations</h1>
144144
<p></p>
145145
</header>
146146
<div id="article-body">
147-
<blockquote class="info">
148-
<p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
147+
<blockquote class="info"><p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
149148
<ul>
150149
<li>Configurations can be stored in a variety of formats, such as <code>.xml</code>, <code>.json</code>, <code>.env</code>, <code>.yaml</code>, and <code>.toml</code> files, as well as systems like <a href="https://etcd.io/"><code>etcd</code></a>, <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-parameter-store.html">AWS Parameter Store</a>, and <a href="https://cloud.google.com/deployment-manager/runtime-configurator/">GCP Runtime Configurator</a>. In this project, we will save the configurations in an <code>.env</code> file and use <code>docker-compose</code> to load them into the development environment.</li>
151150
<li>Go standard library provides the <a href="https://golang.org/pkg/os/#Getenv"><code>os.Getenv()</code></a> function to read each environment variable separately. But there are Go libraries such as <a href="https://github.com/spf13/viper"><code>spf13/viper</code></a>, <a href="https://github.com/kelseyhightower/envconfig"><code>kelseyhightower/envconfig</code></a>, <a href="https://github.com/caarlos0/env"><code>caarlos0/env</code></a>, and <a href="https://github.com/joeshaw/envdecode"><code>joeshaw/envdecode</code></a> to read environment variables in bulk and populate them as a struct. We choose <a href="https://github.com/joeshaw/envdecode"><code>joeshaw/envdecode</code></a> for this project because it includes validations, zero-dependency, and ease of use.</li>

β€Ždocs/docs/database-and-migrations/index.htmlβ€Ž

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
<meta name="theme-color" content="#101010" media="(prefers-color-scheme: dark)">
1111

1212

13-
<title>Database and Migrations Β· Learning Cloud Native Go</title>
13+
<title>Database and migrations Β· Learning Cloud Native Go</title>
1414
<link rel="canonical" href="https://learning-cloud-native-go.github.io/docs/database-and-migrations/">
15-
<link rel="stylesheet" href="/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css" integrity="">
15+
<link rel="stylesheet" href="/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css" integrity="">
1616

1717
<link rel="manifest" href="/manifest.json">
1818
<link rel="icon" href="/favicon/favicon.ico">
@@ -140,12 +140,11 @@
140140
<button class="btn">On this page <i>➑️</i></button>
141141
</nav>
142142
<header>
143-
<h1>Database and Migrations</h1>
143+
<h1>Database and migrations</h1>
144144
<p></p>
145145
</header>
146146
<div id="article-body">
147-
<blockquote class="info">
148-
<p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
147+
<blockquote class="info"><p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
149148
<ul>
150149
<li>We&rsquo;ll run a Postgres database via <code>docker-compose</code>.</li>
151150
<li>There are a few popular database migration tools in the Go ecosystem, like <a href="https://github.com/golang-migrate/migrate"><code>golang-migrate/migrate</code></a>, <a href="https://github.com/pressly/goose"><code>pressly/goose</code></a>, <a href="http://gorm.io/docs/migration.html">GORM migrations</a>, etc. We selected <a href="https://github.com/pressly/goose"><code>pressly/goose</code></a> due to its simplicity, lesser resource usage, and customizability. But, instead of using its prebuilt binaries, we&rsquo;ll build a custom binary with static drivers, settings, and more simplified commands.</li>

β€Ždocs/docs/error-handling/index.htmlβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<title>Error handling Β· Learning Cloud Native Go</title>
1414
<link rel="canonical" href="https://learning-cloud-native-go.github.io/docs/error-handling/">
15-
<link rel="stylesheet" href="/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css" integrity="">
15+
<link rel="stylesheet" href="/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css" integrity="">
1616

1717
<link rel="manifest" href="/manifest.json">
1818
<link rel="icon" href="/favicon/favicon.ico">
@@ -144,8 +144,7 @@ <h1>Error handling</h1>
144144
<p></p>
145145
</header>
146146
<div id="article-body">
147-
<blockquote class="info">
148-
<p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
147+
<blockquote class="info"><p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
149148
<ul>
150149
<li>Go <code>error</code> values usually provide a more detailed context about what actually went wrong. However, returning the actual error messages to end user mostly cause confusion and make the system vulnerable to security threats. So, when an error occurs, we will send a custom but meaningful error message to the end-user.</li>
151150
<li>We choose the <a href="https://github.com/go-playground/validator/"><code>go-playground/validator</code></a> for form validations, as it supports struct level validations, extensive validation rules, customizable error handling, etc.</li>

β€Ždocs/docs/hello-world-server/index.htmlβ€Ž

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212

1313
<title>Hello World server Β· Learning Cloud Native Go</title>
1414
<link rel="canonical" href="https://learning-cloud-native-go.github.io/docs/hello-world-server/">
15-
<link rel="stylesheet" href="/assets/css/docs.min.59cb3187a30104d93101fbb253d04be28dba1a4d109e35e511c23913278024e9.css" integrity="">
15+
<link rel="stylesheet" href="/assets/css/docs.min.67fc7b3b41d707b198af1dd244ec62e1a1dd4665e40cb6f1d97e9257e597ff1d.css" integrity="">
1616

1717
<link rel="manifest" href="/manifest.json">
1818
<link rel="icon" href="/favicon/favicon.ico">
@@ -144,8 +144,7 @@ <h1>Hello World server</h1>
144144
<p></p>
145145
</header>
146146
<div id="article-body">
147-
<blockquote class="info">
148-
<p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
147+
<blockquote class="info"><p><strong>πŸ‘¨β€πŸ«</strong> <strong>Before we start&hellip;</strong></p>
149148
<ul>
150149
<li>Go comes with the <a href="https://pkg.go.dev/net/http"><code>net/http</code></a> package, which provides HTTP client and server implementations. So,</li>
151150
<li>We&rsquo;ll start with the examples of the standard library documentation.</li>

0 commit comments

Comments
Β (0)