Skip to content

Commit c920ae2

Browse files
bketelsenbketelsen
committed
Merge remote-tracking branch 'origin/master' into events
2 parents c79cf96 + 788dcd0 commit c920ae2

File tree

18 files changed

+656
-12
lines changed

18 files changed

+656
-12
lines changed

‎.github/workflows/docs.yml renamed to ‎.github/workflows/website.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ jobs:
3333
- name: Build with Jekyll
3434
uses: actions/jekyll-build-pages@v1
3535
with:
36-
source: ./internal/docs
36+
source: ./internal/website
3737
destination: ./_site
3838
- name: Upload artifact
3939
uses: actions/upload-pages-artifact@v3

‎internal/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Internal related things

‎internal/website/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
_site

‎internal/website/Gemfile

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# frozen_string_literal: true
2+
3+
source "https://rubygems.org"
4+
5+
# gem "rails"
6+
gem 'github-pages', group: :jekyll_plugins

‎internal/website/Gemfile.lock

Lines changed: 282 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,282 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
activesupport (7.2.2.1)
5+
base64
6+
benchmark (>= 0.3)
7+
bigdecimal
8+
concurrent-ruby (~> 1.0, >= 1.3.1)
9+
connection_pool (>= 2.2.5)
10+
drb
11+
i18n (>= 1.6, < 2)
12+
logger (>= 1.4.2)
13+
minitest (>= 5.1)
14+
securerandom (>= 0.3)
15+
tzinfo (~> 2.0, >= 2.0.5)
16+
addressable (2.8.7)
17+
public_suffix (>= 2.0.2, < 7.0)
18+
base64 (0.2.0)
19+
benchmark (0.4.0)
20+
bigdecimal (3.1.9)
21+
coffee-script (2.4.1)
22+
coffee-script-source
23+
execjs
24+
coffee-script-source (1.12.2)
25+
colorator (1.1.0)
26+
commonmarker (0.23.11)
27+
concurrent-ruby (1.3.5)
28+
connection_pool (2.5.3)
29+
csv (3.3.4)
30+
dnsruby (1.72.4)
31+
base64 (~> 0.2.0)
32+
logger (~> 1.6.5)
33+
simpleidn (~> 0.2.1)
34+
drb (2.2.3)
35+
em-websocket (0.5.3)
36+
eventmachine (>= 0.12.9)
37+
http_parser.rb (~> 0)
38+
ethon (0.16.0)
39+
ffi (>= 1.15.0)
40+
eventmachine (1.2.7)
41+
execjs (2.10.0)
42+
faraday (2.13.1)
43+
faraday-net_http (>= 2.0, < 3.5)
44+
json
45+
logger
46+
faraday-net_http (3.4.0)
47+
net-http (>= 0.5.0)
48+
ffi (1.17.2)
49+
forwardable-extended (2.6.0)
50+
gemoji (4.1.0)
51+
github-pages (232)
52+
github-pages-health-check (= 1.18.2)
53+
jekyll (= 3.10.0)
54+
jekyll-avatar (= 0.8.0)
55+
jekyll-coffeescript (= 1.2.2)
56+
jekyll-commonmark-ghpages (= 0.5.1)
57+
jekyll-default-layout (= 0.1.5)
58+
jekyll-feed (= 0.17.0)
59+
jekyll-gist (= 1.5.0)
60+
jekyll-github-metadata (= 2.16.1)
61+
jekyll-include-cache (= 0.2.1)
62+
jekyll-mentions (= 1.6.0)
63+
jekyll-optional-front-matter (= 0.3.2)
64+
jekyll-paginate (= 1.1.0)
65+
jekyll-readme-index (= 0.3.0)
66+
jekyll-redirect-from (= 0.16.0)
67+
jekyll-relative-links (= 0.6.1)
68+
jekyll-remote-theme (= 0.4.3)
69+
jekyll-sass-converter (= 1.5.2)
70+
jekyll-seo-tag (= 2.8.0)
71+
jekyll-sitemap (= 1.4.0)
72+
jekyll-swiss (= 1.0.0)
73+
jekyll-theme-architect (= 0.2.0)
74+
jekyll-theme-cayman (= 0.2.0)
75+
jekyll-theme-dinky (= 0.2.0)
76+
jekyll-theme-hacker (= 0.2.0)
77+
jekyll-theme-leap-day (= 0.2.0)
78+
jekyll-theme-merlot (= 0.2.0)
79+
jekyll-theme-midnight (= 0.2.0)
80+
jekyll-theme-minimal (= 0.2.0)
81+
jekyll-theme-modernist (= 0.2.0)
82+
jekyll-theme-primer (= 0.6.0)
83+
jekyll-theme-slate (= 0.2.0)
84+
jekyll-theme-tactile (= 0.2.0)
85+
jekyll-theme-time-machine (= 0.2.0)
86+
jekyll-titles-from-headings (= 0.5.3)
87+
jemoji (= 0.13.0)
88+
kramdown (= 2.4.0)
89+
kramdown-parser-gfm (= 1.1.0)
90+
liquid (= 4.0.4)
91+
mercenary (~> 0.3)
92+
minima (= 2.5.1)
93+
nokogiri (>= 1.16.2, < 2.0)
94+
rouge (= 3.30.0)
95+
terminal-table (~> 1.4)
96+
webrick (~> 1.8)
97+
github-pages-health-check (1.18.2)
98+
addressable (~> 2.3)
99+
dnsruby (~> 1.60)
100+
octokit (>= 4, < 8)
101+
public_suffix (>= 3.0, < 6.0)
102+
typhoeus (~> 1.3)
103+
html-pipeline (2.14.3)
104+
activesupport (>= 2)
105+
nokogiri (>= 1.4)
106+
http_parser.rb (0.8.0)
107+
i18n (1.14.7)
108+
concurrent-ruby (~> 1.0)
109+
jekyll (3.10.0)
110+
addressable (~> 2.4)
111+
colorator (~> 1.0)
112+
csv (~> 3.0)
113+
em-websocket (~> 0.5)
114+
i18n (>= 0.7, < 2)
115+
jekyll-sass-converter (~> 1.0)
116+
jekyll-watch (~> 2.0)
117+
kramdown (>= 1.17, < 3)
118+
liquid (~> 4.0)
119+
mercenary (~> 0.3.3)
120+
pathutil (~> 0.9)
121+
rouge (>= 1.7, < 4)
122+
safe_yaml (~> 1.0)
123+
webrick (>= 1.0)
124+
jekyll-avatar (0.8.0)
125+
jekyll (>= 3.0, < 5.0)
126+
jekyll-coffeescript (1.2.2)
127+
coffee-script (~> 2.2)
128+
coffee-script-source (~> 1.12)
129+
jekyll-commonmark (1.4.0)
130+
commonmarker (~> 0.22)
131+
jekyll-commonmark-ghpages (0.5.1)
132+
commonmarker (>= 0.23.7, < 1.1.0)
133+
jekyll (>= 3.9, < 4.0)
134+
jekyll-commonmark (~> 1.4.0)
135+
rouge (>= 2.0, < 5.0)
136+
jekyll-default-layout (0.1.5)
137+
jekyll (>= 3.0, < 5.0)
138+
jekyll-feed (0.17.0)
139+
jekyll (>= 3.7, < 5.0)
140+
jekyll-gist (1.5.0)
141+
octokit (~> 4.2)
142+
jekyll-github-metadata (2.16.1)
143+
jekyll (>= 3.4, < 5.0)
144+
octokit (>= 4, < 7, != 4.4.0)
145+
jekyll-include-cache (0.2.1)
146+
jekyll (>= 3.7, < 5.0)
147+
jekyll-mentions (1.6.0)
148+
html-pipeline (~> 2.3)
149+
jekyll (>= 3.7, < 5.0)
150+
jekyll-optional-front-matter (0.3.2)
151+
jekyll (>= 3.0, < 5.0)
152+
jekyll-paginate (1.1.0)
153+
jekyll-readme-index (0.3.0)
154+
jekyll (>= 3.0, < 5.0)
155+
jekyll-redirect-from (0.16.0)
156+
jekyll (>= 3.3, < 5.0)
157+
jekyll-relative-links (0.6.1)
158+
jekyll (>= 3.3, < 5.0)
159+
jekyll-remote-theme (0.4.3)
160+
addressable (~> 2.0)
161+
jekyll (>= 3.5, < 5.0)
162+
jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0)
163+
rubyzip (>= 1.3.0, < 3.0)
164+
jekyll-sass-converter (1.5.2)
165+
sass (~> 3.4)
166+
jekyll-seo-tag (2.8.0)
167+
jekyll (>= 3.8, < 5.0)
168+
jekyll-sitemap (1.4.0)
169+
jekyll (>= 3.7, < 5.0)
170+
jekyll-swiss (1.0.0)
171+
jekyll-theme-architect (0.2.0)
172+
jekyll (> 3.5, < 5.0)
173+
jekyll-seo-tag (~> 2.0)
174+
jekyll-theme-cayman (0.2.0)
175+
jekyll (> 3.5, < 5.0)
176+
jekyll-seo-tag (~> 2.0)
177+
jekyll-theme-dinky (0.2.0)
178+
jekyll (> 3.5, < 5.0)
179+
jekyll-seo-tag (~> 2.0)
180+
jekyll-theme-hacker (0.2.0)
181+
jekyll (> 3.5, < 5.0)
182+
jekyll-seo-tag (~> 2.0)
183+
jekyll-theme-leap-day (0.2.0)
184+
jekyll (> 3.5, < 5.0)
185+
jekyll-seo-tag (~> 2.0)
186+
jekyll-theme-merlot (0.2.0)
187+
jekyll (> 3.5, < 5.0)
188+
jekyll-seo-tag (~> 2.0)
189+
jekyll-theme-midnight (0.2.0)
190+
jekyll (> 3.5, < 5.0)
191+
jekyll-seo-tag (~> 2.0)
192+
jekyll-theme-minimal (0.2.0)
193+
jekyll (> 3.5, < 5.0)
194+
jekyll-seo-tag (~> 2.0)
195+
jekyll-theme-modernist (0.2.0)
196+
jekyll (> 3.5, < 5.0)
197+
jekyll-seo-tag (~> 2.0)
198+
jekyll-theme-primer (0.6.0)
199+
jekyll (> 3.5, < 5.0)
200+
jekyll-github-metadata (~> 2.9)
201+
jekyll-seo-tag (~> 2.0)
202+
jekyll-theme-slate (0.2.0)
203+
jekyll (> 3.5, < 5.0)
204+
jekyll-seo-tag (~> 2.0)
205+
jekyll-theme-tactile (0.2.0)
206+
jekyll (> 3.5, < 5.0)
207+
jekyll-seo-tag (~> 2.0)
208+
jekyll-theme-time-machine (0.2.0)
209+
jekyll (> 3.5, < 5.0)
210+
jekyll-seo-tag (~> 2.0)
211+
jekyll-titles-from-headings (0.5.3)
212+
jekyll (>= 3.3, < 5.0)
213+
jekyll-watch (2.2.1)
214+
listen (~> 3.0)
215+
jemoji (0.13.0)
216+
gemoji (>= 3, < 5)
217+
html-pipeline (~> 2.2)
218+
jekyll (>= 3.0, < 5.0)
219+
json (2.12.0)
220+
kramdown (2.4.0)
221+
rexml
222+
kramdown-parser-gfm (1.1.0)
223+
kramdown (~> 2.0)
224+
liquid (4.0.4)
225+
listen (3.9.0)
226+
rb-fsevent (~> 0.10, >= 0.10.3)
227+
rb-inotify (~> 0.9, >= 0.9.10)
228+
logger (1.6.6)
229+
mercenary (0.3.6)
230+
mini_portile2 (2.8.9)
231+
minima (2.5.1)
232+
jekyll (>= 3.5, < 5.0)
233+
jekyll-feed (~> 0.9)
234+
jekyll-seo-tag (~> 2.1)
235+
minitest (5.25.5)
236+
net-http (0.6.0)
237+
uri
238+
nokogiri (1.18.8)
239+
mini_portile2 (~> 2.8.2)
240+
racc (~> 1.4)
241+
octokit (4.25.1)
242+
faraday (>= 1, < 3)
243+
sawyer (~> 0.9)
244+
pathutil (0.16.2)
245+
forwardable-extended (~> 2.6)
246+
public_suffix (5.1.1)
247+
racc (1.8.1)
248+
rb-fsevent (0.11.2)
249+
rb-inotify (0.11.1)
250+
ffi (~> 1.0)
251+
rexml (3.4.1)
252+
rouge (3.30.0)
253+
rubyzip (2.4.1)
254+
safe_yaml (1.0.5)
255+
sass (3.7.4)
256+
sass-listen (~> 4.0.0)
257+
sass-listen (4.0.0)
258+
rb-fsevent (~> 0.9, >= 0.9.4)
259+
rb-inotify (~> 0.9, >= 0.9.7)
260+
sawyer (0.9.2)
261+
addressable (>= 2.3.5)
262+
faraday (>= 0.17.3, < 3)
263+
securerandom (0.4.1)
264+
simpleidn (0.2.3)
265+
terminal-table (1.8.0)
266+
unicode-display_width (~> 1.1, >= 1.1.1)
267+
typhoeus (1.4.1)
268+
ethon (>= 0.9.0)
269+
tzinfo (2.0.6)
270+
concurrent-ruby (~> 1.0)
271+
unicode-display_width (1.8.0)
272+
uri (1.0.3)
273+
webrick (1.9.1)
274+
275+
PLATFORMS
276+
x86_64-linux
277+
278+
DEPENDENCIES
279+
github-pages
280+
281+
BUNDLED WITH
282+
2.3.18

‎internal/website/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Website
2+
3+
The Go Micro website including docs

‎internal/docs/_config.yml renamed to ‎internal/website/_config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
title: Docs
22
description: "A Go microservices framework"
3-
baseurl: "/docs" # the subpath of your site, e.g. /blog
3+
baseurl: "" # the subpath of your site, e.g. /blog
44
url: "" # the base hostname & protocol for your site, e.g. http://example.com
55

66
theme: jekyll-theme-primer

‎internal/website/_layouts/default.html

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<!DOCTYPE html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
6+
<title>{% if page.title %}{{ page.title }} | {% endif %}Go Micro Documentation</title>
7+
<style>
8+
body { font-family: sans-serif; margin: 0; padding: 0; background: #f9f9f9; }
9+
header { display: flex; align-items: center; justify-content: space-between; padding: 1rem 2rem; background: #fff; border-bottom: 1px solid #eee; }
10+
.logo-link { display: flex; align-items: center; text-decoration: none; }
11+
.logo-link img { height: 40px; margin-right: 10px; }
12+
nav a { margin-left: 24px; color: #333; text-decoration: none; font-weight: 500; }
13+
nav a:hover { color: #007d9c; }
14+
main { max-width: 800px; margin: 2rem auto; background: #fff; padding: 2rem; border-radius: 8px; box-shadow: 0 2px 8px rgba(0,0,0,0.03); }
15+
pre { background: whitesmoke; padding: 10px; border-radius: 5px; }
16+
</style>
17+
</head>
18+
<body>
19+
<header>
20+
<a class="logo-link" href="/">
21+
<img src="/images/logo.png" alt="Go Micro Logo">
22+
<span style="font-size: 1.3rem; font-weight: bold; color: #222;">Go Micro</span>
23+
</a>
24+
<nav>
25+
<a href="/docs/">Docs</a>
26+
<a href="https://github.com/micro/go-micro" target="_blank" rel="noopener">GitHub</a>
27+
<a href="/">Home</a>
28+
</nav>
29+
</header>
30+
<main>
31+
{{ content }}
32+
</main>
33+
</body>
34+
</html>

‎internal/docs/architecture.md renamed to ‎internal/website/docs/architecture.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
layout: default
3+
---
4+
15
## Architecture
26

37
An overview of the Go Micro architecture
@@ -40,3 +44,26 @@ in the plugins repo. State and persistence becomes a core requirement beyond pro
4044
## Design
4145

4246
We will share more on architecture soon
47+
48+
## Example Usage
49+
50+
Here's a minimal Go Micro service demonstrating the architecture:
51+
52+
```go
53+
package main
54+
55+
import (
56+
"go-micro.dev/v5"
57+
"log"
58+
)
59+
60+
func main() {
61+
service := micro.NewService(
62+
micro.Name("example"),
63+
)
64+
service.Init()
65+
if err := service.Run(); err != nil {
66+
log.Fatal(err)
67+
}
68+
}
69+
```

0 commit comments

Comments
 (0)