From 15fad2f9aab0ba03fefe2b67c02251c5264a6258 Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Wed, 21 May 2025 12:32:08 +0000 Subject: [PATCH 1/4] add docs layout --- internal/website/docs/layout.html | 33 +++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 internal/website/docs/layout.html diff --git a/internal/website/docs/layout.html b/internal/website/docs/layout.html new file mode 100644 index 0000000000..a00a8fe052 --- /dev/null +++ b/internal/website/docs/layout.html @@ -0,0 +1,33 @@ + + + + + + Go Micro Documentation + + + +
+ + Go Micro Logo + Go Micro + + +
+
+ +
+ + From 4e11e93c0b0706b2d74a1fd33292cfb27484f32d Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Wed, 21 May 2025 12:39:43 +0000 Subject: [PATCH 2/4] update all to use _layouts --- internal/website/docs/README.md | 4 +++ internal/website/docs/_layouts/default.html | 33 +++++++++++++++++++++ internal/website/docs/architecture.md | 4 +++ internal/website/docs/broker.md | 4 +++ internal/website/docs/client-server.md | 4 +++ internal/website/docs/getting-started.md | 10 +++++-- internal/website/docs/registry.md | 4 +++ internal/website/docs/store.md | 4 +++ internal/website/docs/transport.md | 4 +++ 9 files changed, 68 insertions(+), 3 deletions(-) create mode 100644 internal/website/docs/_layouts/default.html diff --git a/internal/website/docs/README.md b/internal/website/docs/README.md index dd62237f24..5ff809633d 100644 --- a/internal/website/docs/README.md +++ b/internal/website/docs/README.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Docs Documentation for the Go Micro framework diff --git a/internal/website/docs/_layouts/default.html b/internal/website/docs/_layouts/default.html new file mode 100644 index 0000000000..b7e9d6bdd3 --- /dev/null +++ b/internal/website/docs/_layouts/default.html @@ -0,0 +1,33 @@ + + + + + + {% if page.title %}{{ page.title }} | {% endif %}Go Micro Documentation + + + +
+ + Go Micro Logo + Go Micro + + +
+
+ {{ content }} +
+ + diff --git a/internal/website/docs/architecture.md b/internal/website/docs/architecture.md index 0dcd7a9b5c..5bd8aa7032 100644 --- a/internal/website/docs/architecture.md +++ b/internal/website/docs/architecture.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + ## Example Usage diff --git a/internal/website/docs/broker.md b/internal/website/docs/broker.md index 2de38ac42e..4e200c5af4 100644 --- a/internal/website/docs/broker.md +++ b/internal/website/docs/broker.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Broker The broker provides pub/sub messaging for Go Micro services. diff --git a/internal/website/docs/client-server.md b/internal/website/docs/client-server.md index 142554d35f..9da07cc848 100644 --- a/internal/website/docs/client-server.md +++ b/internal/website/docs/client-server.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Client/Server Go Micro uses a client/server model for RPC communication between services. diff --git a/internal/website/docs/getting-started.md b/internal/website/docs/getting-started.md index 1a9592c462..cc4260a305 100644 --- a/internal/website/docs/getting-started.md +++ b/internal/website/docs/getting-started.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Getting Started To make use of Go Micro @@ -117,15 +121,15 @@ package greeter; option go_package = "/proto;helloworld"; service Say { - rpc Hello(Request) returns (Response) {} + rpc Hello(Request) returns (Response) {} } message Request { - string name = 1; + string name = 1; } message Response { - string message = 1; + string message = 1; } ``` diff --git a/internal/website/docs/registry.md b/internal/website/docs/registry.md index 23bc7eda84..9dda5c7cf6 100644 --- a/internal/website/docs/registry.md +++ b/internal/website/docs/registry.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Registry The registry is responsible for service discovery in Go Micro. It allows services to register themselves and discover other services. diff --git a/internal/website/docs/store.md b/internal/website/docs/store.md index aa0767387e..af5ee876e9 100644 --- a/internal/website/docs/store.md +++ b/internal/website/docs/store.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Store The store provides a pluggable interface for data storage in Go Micro. diff --git a/internal/website/docs/transport.md b/internal/website/docs/transport.md index 3018ba9106..5352c9e6bb 100644 --- a/internal/website/docs/transport.md +++ b/internal/website/docs/transport.md @@ -1,3 +1,7 @@ +--- +layout: default +--- + # Transport The transport layer is responsible for communication between services. From d831fd8cb58b59d20e9267256069599d27eae21a Mon Sep 17 00:00:00 2001 From: asim Date: Wed, 21 May 2025 13:47:17 +0100 Subject: [PATCH 3/4] update the styling --- .../website/{docs => }/_layouts/default.html | 5 +- internal/website/docs/architecture.md | 46 +++++++++--------- internal/website/docs/{README.md => index.md} | 0 internal/website/docs/layout.html | 33 ------------- internal/website/images/logo.png | Bin 0 -> 8705 bytes 5 files changed, 26 insertions(+), 58 deletions(-) rename internal/website/{docs => }/_layouts/default.html (88%) rename internal/website/docs/{README.md => index.md} (100%) delete mode 100644 internal/website/docs/layout.html create mode 100644 internal/website/images/logo.png diff --git a/internal/website/docs/_layouts/default.html b/internal/website/_layouts/default.html similarity index 88% rename from internal/website/docs/_layouts/default.html rename to internal/website/_layouts/default.html index b7e9d6bdd3..fb8decebed 100644 --- a/internal/website/docs/_layouts/default.html +++ b/internal/website/_layouts/default.html @@ -12,16 +12,17 @@ nav a { margin-left: 24px; color: #333; text-decoration: none; font-weight: 500; } nav a:hover { color: #007d9c; } 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); } + pre { background: whitesmoke; padding: 10px; border-radius: 5px; }
- Go Micro Logo + Go Micro Logo Go Micro diff --git a/internal/website/docs/architecture.md b/internal/website/docs/architecture.md index 5bd8aa7032..da11cce534 100644 --- a/internal/website/docs/architecture.md +++ b/internal/website/docs/architecture.md @@ -2,29 +2,6 @@ layout: default --- - -## Example Usage - -Here's a minimal Go Micro service demonstrating the architecture: - -```go -package main - -import ( - "go-micro.dev/v5" - "log" -) - -func main() { - service := micro.NewService( - micro.Name("example"), - ) - service.Init() - if err := service.Run(); err != nil { - log.Fatal(err) - } -} -``` ## Architecture An overview of the Go Micro architecture @@ -67,3 +44,26 @@ in the plugins repo. State and persistence becomes a core requirement beyond pro ## Design We will share more on architecture soon + +## Example Usage + +Here's a minimal Go Micro service demonstrating the architecture: + +```go +package main + +import ( + "go-micro.dev/v5" + "log" +) + +func main() { + service := micro.NewService( + micro.Name("example"), + ) + service.Init() + if err := service.Run(); err != nil { + log.Fatal(err) + } +} +``` diff --git a/internal/website/docs/README.md b/internal/website/docs/index.md similarity index 100% rename from internal/website/docs/README.md rename to internal/website/docs/index.md diff --git a/internal/website/docs/layout.html b/internal/website/docs/layout.html deleted file mode 100644 index a00a8fe052..0000000000 --- a/internal/website/docs/layout.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - - Go Micro Documentation - - - -
- - Go Micro Logo - Go Micro - - -
-
- -
- - diff --git a/internal/website/images/logo.png b/internal/website/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..2fa15d008ee5f74087733b9da05d1aaa177aa5e5 GIT binary patch literal 8705 zcmeHNXH=6}w+==?Y0iv_B3%V6v=C~L2+{}B30)MBs-g%AQbGV}L8^2F z1W`&rIs`;Ip$H@}gmzz?x%27V^5fpS?)rXwS?gU%_St)%UCw#VK0A4+r=!lwbcP88 z06>;{=EjXw|!DWh4S&=Y|IP zc*1O9DoSd$UU!up<(yG4DPdEA`) z)xH6qCNk;G2TbpW3~>y+ysDqDW5%F^HU; zoS3+Tn1qA~z#)S2bwgYEh`6E70h)eRrDBJ&@pN)WJ0acp4pduNBQagj-!5xr%2qzm)B%cT$O1tWE4cne#i_4=(->y;nk`J)Nxo zioih{zf&*=VG}(_rj_kM48(tm!5>mEC0o=Fh97ux+s@-}6d(!*1MXIyC_8;$cRK~4 zTXrZU#?!{`$JGC+P}$SY3T|ObDK-CAWVGFmBwzso| z+FFU&NLx#YNQ%orL}a0MvLbR;RuDOHIcX^yNx8pt{UP!nG^tqwilii@B&4O}Ad(On zIVstH%>RAxKZxifF*c3|Zowt~(*6(HKiL0^H2)l~e|Pogu>Kz<+Wm*^^wVYq27vrR zf66aFgDGLqjz~|q63Pj|r-X8~LR=C1f&4eu{`U(Jz=@w$;dhYv5lntuE&wy^`&vPI z>LZb^aAhkuFRLqJe<%NUM*f95-{T9w&JXKW>@V1Y-#6*q0fD&C8Y)WqKFN!HkY9tv zK@AN(m3!1LhcD`@FvgD7-*c_(->m_IelOd?fI#k@L^{5Pe?9+-!9U3wumpoZ`}>O| zho`2~0j;a!Dew~Lh&TR@Sk(E*Xpn%VEL)#fgO@*xtf;JeG;@o_Xc3Al7Gc`p!M8!j zDdXA@t99c#Na!sHGX1t&_^8TFvAp7*4N_7H9JPLpo&D~xuf5lD`yy#&wqSYGPrYY( zWh{GV|1b;$5>-qCgT5U4XZTo$9R~#~C*1cp=2&%6`jDM7fP2(>D_2iH!}9XY3(m5J zy`5RWOrUC_F}67VI)*8s*mp}E_=E^Xy_mGqq5qE2jkHh+)=DB9vl=aZzW7chA=qv{1%<0B zt=4dmWIRc^dz&X!beOj5W9)tG#zJ9e{Kw(@@_NS%DBUSL6gsIBYj?3-HHmQ9dZVao zeSTRyZ6~QyD#k&ZjcGk6>mc>s<~Ig}oxAT@+HLkd?<8l{c?1xyns?9A>BlNEI?v@N zJaRMXGwS0D!u!_G->%UcOWVnKq&sfZ_Zn()?M`KQYfBGyKTBz;>qM?69E5*!fi358 z-mDC{&alHnvi4>G~LaDS2+Ac3pSW;G*Xd~%WG>i2VR$hAFEh(ur`ldmaWq& zfX@c9q8V$dZ0Y`Za8($)a0AtySPKUPO3%V{Z02`N z@KEd<@dl+-li}RNft^ZUlS|p*YPW`;v^!led@68pp-fWdOCP8FIhYiC{>Oln5%&J~ zX4);SBTvke+np`4_y__bEHtz!$1(6q%0T|e_9WIr!tfpGkhl^swOm~rK?d{U!HjKs zPS@h;KE!rhEh(>QrNB7N;&#i4hJ7{x>QD-9_=&&oX~IJW%KPahthUSid$hS0ZLpEO z7Wr9kXp^adMR_?`xp47en~OLm`QmWZ*Z1!(Hr2c^|9qxrh=E^NLuQ3zKt7fC_Y(2v znXC`#eIg4PNvZ{j9- zIJL;1<<+!!y!*2F5xUQKG>_d)7=yI>C-N%#0%CNvR`uP1>uuL=?pOKcGk8;kPL)20 ziLLJBYsV|&Es(*}W<7~0ImGQA?6leAALGaUqSGSIP@Ir@Au)jCb2v9>nx9C= zn8;w={tmXFZd1im@Psj@2C=~(I1lRl;=l~ZrHSRO`g?wKpG(8vV~nwH>dMp(7Xv+g z09Y?>Eh|$eXfP5uaZav;G3FK1Ol9@1eJZ4u@ejTEGNuB7=~hye&O6m=T>0Nq-HfJm@Bjqx- zvjcf~RL$_4TB~X;&+e=SiPry7C*?Eyt+@#NT&v6$HDs#;>!=+EtTFBFS3RmG_0XKT znF`?m&o{nNeQ{#WQn2L#JA*W^W$Y8}VC6tGU%Jcl(%es$ZxXwT(LX}%A`!Juc8tlaLz znCez^pvmCdZDSEzgh|Cx9GPZ^50zb@&XF(6fA`1zJiZQXZmwng+Xgu!wg}7ml6bwR zVnaKE)g>5}KZlcly#|tXG#Vs?>n7!~H3bZRmRgYsh&+`Q+Zi#?6YnzX;t|6%;;J=` zrrq9tCY3M9nC8z?31%C4{Bizk40r*V)<=z0#@#?u1?c5$KSe*L6--&=yr}qeGNY22e`+mersXP z4`Xg}-Njl-gl(&LV)Me>o2M0cpSqmdq#Et}SI1agL@u>Z(Ggi1}r%f#uDmTiB?Zj>$a zB=(ZP@y2I1=F1RPDZ^a7YmY3<=;DBt5AJnu7uS6Bcogex-I2XiKr zaomYDK@R@X(%h+UUV;DGv$vK{zNRoJG^t1?K<8MF|J)R3w3B1=Or0& z%fbYy;)-_yol{keF?ds?JZK-pVeyCnCV4$~wa|{8H2rC6Sjc zC_(FUG*+(s=u!rDmpR1k_)9prHW@w-azCxStQgAof$j$5NPjTHSIR34X!$)SOwS6wAPOX02M>TnVuQLnh+r-RnidefG?R=CKFHiOrlHF$T`6%8DVEt&mQit zc_MN+@xvvvDfQ#Qa?X`tR%`W3+1wXrKGNxj@q2?nrol4kc1NHXeDX;5QzN`=yEf8C zShY5x(LAnL)nxVBO+P5T!tt)0t0v-bCnfy;Sxy9ix@bUDj>jI{@a6$4O^z+&KpLN zz6z081two%AmiNa?4|N41F`z%TbHCWjDS)XA)F&%m1-OiUie&e_)N#CGU&5`+s8Q& zHu{G}mC|g~zFmjOu@f(Lr|Cp8p#7T(c&pTz!!<1m%@uf0+Pvkh@j;pN5ZwLk(O|>p zo6VG}jUt^`h7&I`I%xoMjYs3D@gW){8Cj!l?=_=@y~*anC#}2wvUvIIA+@rh*={>j zM%CLqjqK(_YEo0TRZRf2Re-(dk2@yV`&`;0d4T)d!cKXSIqA3Fj}aE1ngTl@IbP4p z5KGsmsb6gk0C+`jHe@oOW{z3+qv zQD2F~eid+4pl`KK4E>391Bb8+H!mz~?0Nureq%nPV64a@)o3_33U*daX;YItX%yf( zQuIo+ko zUxCtkY>=b762Z?sej?|i|CszMUgEB@2F~Vr_%3aySh_a-+*#z-e)Ofm9^G)k1H@js zG&w=rf(9Whe_t(`N;U67UzJMn;Qj%y^B7SC+_JZ3&d-w?oPRbib!Ouv?1M ze=-#`RhAi5{em*QQB+8R!={^Vj}|mi^`d&>Uu{CMT30Dy{}mG_S@<-ZDqKQ7&Mc+@1+?=DepZuh}?8w z#%4usFPD@Tgt#i%1TC)etlnK<^0AOs)hogaWerMwdjK?%MQpj+PL>HIeZE_lCS7kR zB)xS~D*1`yx-aFmKmm3$Dzs$)ybz)oez|7*eL7B5ZTn?sgxkUru_n!kh|rips|T5G zvfQZ4|3zE3A&;C;K3@!62G(op&Y6Bzv>4&)eJS4&9+sN;VJ@o?4p!b?6grE+b zk5t-5(UUv*7lZa_fdx?xao7$4{?vYHMvSv?&T{Z3z99%-Vxo+Vndl5pH&q%~I^Czs zrgO=!S?XmCPi?kPZjgD8^NB^|a-`#Xx2p)(ZsHO2+u?l{fieJNl(Q)pT)(MpzUxp{ z4}dOqu~R}il$m^lYs;$9?uC)PUJ)C-?2?=-wRNwNrm5p{uxSW@gPUwR3uBiEgF(_B z6yOSEHecff6pMtA*96~=40fCg0EJcVO>~H>ngVZuYm5a+K3zyqqH5(1N;9l#yqNOl zfe5W(h9BnwrZ#ZFOjnXr3^t!0dDztHm_+MXVXjt-(To>m>svOe?3?Z81a^AsSlv}~ ziFVE*;PUHG@j#2mL95F7Gx28A&UM`zwv^Z0_CdVJh3Feb3cut4=VD1?S9nKmj0m$X zceDI$UmR>%+dPiF??SJ3s6A4UpvxI%h{I|b#&?SqFowlro89@xm$o}J>!i2Yw3R_I zk&3PP-^h>>grQ*6#~Y_2FbS241-G)++pfw!(yP%UlcxGGSQK&YZ7P>AGPeQkJi*dL z22&N&Yz$6!oQkXbuy9>)ebJAF?601EGpv-05c%Rx^|lB28NQ(Rp*DU%aLRSWM`fnS zA~umb=*h&ml-{w!FniW`MVZ(1@MNgpCn*xUl$qczyTR!tED5bT}%sbFVE6-03QywzalWo%}^?7Yi zS@gsX!^A_ATC}`oW-C|Wexast+N?e;Gy!af3328JD#`ZD+MM&M0nn=vPr@|J=Dnpj z=sxJbapuuO97t+UMXB+BzKIh->zw((9z9lfnIt;sCVmy}R#fy`&Z$G(i4%e>Gtq`B zJF#f1JbXTaoc6At~y1(cj`m)d&xkFVZsp?5r!q=9-G zQL(dvjh$FExqTRR=2Qqrq#d>CrYrezGzLk)gp)Rk7 z1gvUOP*5HJcFwG)FH;Iy(=#L%*0E4hkI>QA((0YQx|l3o;+3zeaV$2`j5mkzz(gJn zZO&62TN}ALlVjgv=Da7JaA)PL;_%4AMg6qqst}+)wU}QLAKt5gzq*;qoV)a{_6XWC zjI;eDCCAF)&G8q9u$J0!V+JjcD3u7SNuH^)Z%Y9lxXDiEqw~vsBxCnz&w{+Ofuss- zVJvjfZ2#P;-p26in~A60LrgYx<_N5Q8DdAbD5S}1N)jG{^*oC^6)zVvbAW#jY7&P1 zc|?xT0Dv5LaaXYb9w)e_8c>NGoj_X60L3P}rs%z6=0r_-(W{*(U#z7p9%xpmdD3HO zwXj;bob{2Wmfem``!yPWNGtKC6mQXdsoe(wP zI1)t-G-Qen`RHxunr5L@L+Pu|E661EJ?P>h(tOHuX9KWjam=Z5X&nsD=7ZIMZjmSj zaF-B>t*@)TYF<`BwL95+o$!GBb+UOyx`oB^%e}@j+wT77UUBnOPPU?1E~w7AJ^w>F z_qzRW@{(Zrw^N6+k&7>hV@%_Nz|k=tmrdPD!Lg2f5ilz~XfhdZ_re4G#_xNW3^lRY zGt*}3j;3r(!AV6fH;lsj`9V6xz$IWRNK{-ax%;=?BoY1;;t677nqf*H;Tn%tU>x4H z+o0Ie<%)&Ag&-m2bu!R?#JWlryj4=KQ2SaUoHEYdV^qM;&HKF(YEMuHBurO{-lH$u z$Pe0*1La@!pTjv#AN6Q=|K7Q6cqIQ%)yn-pZ71&^JLrus^@XqiKV>)Y1(E&y1s)UW zEEVTK;(Tb(>0e+VmLuFChWl(F@HNI@x^!?u@V|!t6_)>p Date: Wed, 21 May 2025 22:42:24 +0100 Subject: [PATCH 4/4] always use service name as table name --- service/service.go | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/service/service.go b/service/service.go index 09e04985ad..13d8973b0e 100644 --- a/service/service.go +++ b/service/service.go @@ -60,14 +60,11 @@ func (s *service) Init(opts ...Option) { s.opts.Logger.Log(log.FatalLevel, err) } - // If the store has no Table set, fallback to the - // services name - if len(s.opts.Store.Options().Table) == 0 { - name := s.opts.Cmd.App().Name - err := s.opts.Store.Init(store.Table(name)) - if err != nil { - s.opts.Logger.Log(log.FatalLevel, err) - } + // we might not want to do this + name := s.opts.Cmd.App().Name + err := s.opts.Store.Init(store.Table(name)) + if err != nil { + s.opts.Logger.Log(log.FatalLevel, err) } }) }