From 73419d594c804fe7a20f6523d5b547c1ab6b9642 Mon Sep 17 00:00:00 2001 From: Teodora Mihoc Date: Sun, 9 Feb 2025 22:54:18 +0100 Subject: [PATCH] docs: update logo and readme (#1571) This PR - updates the logo from the default circle of friends to the juju logo - updates the README to point to the new docs --- README.md | 35 +++--------------- .../_static/logos/juju-logo-no-text.png | Bin 0 -> 5974 bytes docs/custom_conf.py | 3 +- 3 files changed, 7 insertions(+), 31 deletions(-) create mode 100644 docs/.sphinx/_static/logos/juju-logo-no-text.png diff --git a/README.md b/README.md index a748b1f79..2f3c6243f 100644 --- a/README.md +++ b/README.md @@ -7,21 +7,13 @@ The `ops` library is a Python framework for developing and testing Kubernetes an > - `ops` is [available on PyPI](https://pypi.org/project/ops/). > - The latest version of `ops` requires Python 3.8 or above. -|||| -|-|-|- | -|| [Juju](https://juju.is/docs/juju) | Learn how to quickly deploy, integrate, and manage charms on any cloud with Juju.
_It's as simple as `juju deploy foo`, `juju integrate foo bar`, and so on -- on any cloud._ | -|||| -|| [Charmhub](https://charmhub.io/) | Sample our existing charms on Charmhub.
_A charm can be a cluster ([OpenStack](https://charmhub.io/openstack-base), [Kubernetes](https://charmhub.io/charmed-kubernetes)), a data platform ([PostgreSQL](https://charmhub.io/postgresql-k8s), [MongoDB](https://charmhub.io/mongodb), etc.), an observability stack ([Canonical Observability Stack](https://charmhub.io/cos-lite)), an MLOps solution ([Kubeflow](https://charmhub.io/kubeflow)), and so much more._ | -|||| -|👉| [Charm SDK](https://juju.is/docs/sdk) | Write your own charm!
_Juju is written in Go, but our SDK supports easy charm development in Python._ | - ## Give it a try Let's use `ops` to build a Kubernetes charm: ### Set up -> See [Charm SDK | Set up an Ubuntu `charm-dev` VM with Multipass](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass).
Choose the MicroK8s track. +> See [Juju | Set things up](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#set-things-up).
Choose the automatic track and MicroK8s. ### Write your charm @@ -150,27 +142,10 @@ Congratulations, you’ve just built your first Kubernetes charm using `ops`! ### Clean up -> See [Charm SDK | Clean up](https://juju.is/docs/sdk/dev-setup#heading--automatic-set-up-an-ubuntu-charm-dev-vm-with-multipass). +> See [Juju | Tear things down](https://canonical-juju.readthedocs-hosted.com/en/latest/user/howto/manage-your-deployment/manage-your-deployment-environment/#tear-things-down).
Choose the automatic track. ## Next steps -### Learn more -- Read our [user documentation](https://juju.is/docs/sdk/ops), which includes other guides showing `ops` in action -- Dig into the [`ops` API reference](https://ops.readthedocs.io/en/latest/) - -### Chat with us - -Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and: -- Join our chat: [Mattermost](https://chat.charmhub.io/charmhub/channels/ops) -- Join our forum: [Discourse](https://discourse.charmhub.io/) - -### File an issue - -- Report an `ops` bug using [GitHub issues](https://github.com/canonical/operator/issues) -- Raise a general https://juju.is/docs documentation issue on [GitHub | juju/docs](https://github.com/juju/docs) - -### Make your mark - -- Read our [documentation contributor guidelines](https://discourse.charmhub.io/t/documentation-guidelines-for-contributors/1245) and help improve a doc -- Read our [codebase contributor guidelines](https://github.com/canonical/operator/blob/main/HACKING.md) and help improve the codebase -- Write a charm and publish it on [Charmhub](https://charmhub.io/) +- Read the [docs](https://ops.readthedocs.io/en/latest/). +- Read our [Code of conduct](https://ubuntu.com/community/code-of-conduct) and join our [chat](https://matrix.to/#/#charmhub-ops:ubuntu.com) and [forum](https://discourse.charmhub.io/) or [open an issue](https://github.com/canonical/operator/issues). +- Read our [CONTRIBUTING guide](https://github.com/canonical/operator/blob/main/HACKING.md) and contribute! diff --git a/docs/.sphinx/_static/logos/juju-logo-no-text.png b/docs/.sphinx/_static/logos/juju-logo-no-text.png new file mode 100644 index 0000000000000000000000000000000000000000..989120205f4eaf54f1b3be7900638cbad6eb7bbf GIT binary patch literal 5974 zcmeHLc|4R|-zOC**$PEuiIlCokT8@XJ0XO)ty4GI8QY8s8GA#xWh+Y(8C&*2*6g<- z%gxN#*RfBQnPJ}JdEWQ^^Z7h~yr1{4XZ|_Y%ys5m=Q`(mzRNGl*zh46>t$931_m}A zZKw%o4;dI3-?E$rSI*a6dO>s2=YftH3;2YvIHADzmLM}rUlV)yRZnjZm*;NISA7FL zov+?EHonEcz?Y0Lx__QYn5BUljc8#(Q3Qt871Hm#sGzG|$gOh4`J!HO|K5xr=?o&J z&ikoUA2!zIzh;nl^4mp*Gi>JqUSkGBG!jVC72<721w8TvEJ{Bw>a&=CEQb8;%Jy?! z;o%#pq_n>4`}uKob2^Uo@dy|sL8>=oS(!6>nE&(6^GVeX=lCzWy;Ax&E)Q3{7>Ekn z>fQHvnzxMGYgAWI@^f#T2&J4`XVbMXN1B)TC^9hcsOdoOn+0U7;Z^l*7T-5-E%q`C zb-H}fIn`p~-ul;9$&QGwKk_}tMXDL9TKXSbb{XDq)b!4S*0gwwi9Y$BJerbnq2uSN z==3*ZeQYxNj1#viV?T7?d9~jx=d<9(sNvSK*Rbfga6tbuX+zC)jHG7_?5U1;WQUT@ zFvvUDdoaBGom2J0xk09Gj{h|OS%Uuu6o|DD7>2Vg>ojK4ira8k5`Q>pLfdrV+ERGr zrt6Iewk_7x871qPlCP+AJ9M{|;f;u2r3(DiVj_e-b~ad)1F_ZbuCseyC#PT|tY)Cd zWbExW?xv)4FX(=&CgSeRoX#>Sv9 zxM4Ms6#N1e_L!C5BqLqy=p~0Lo%tEo=V%r3!a=AXgpV`= z;V`CDQ8U`dDDSS~rCpahQaO=e{ z8@zcz4?e89`8WkH{uQ1b?Of18c=tw~+->RqhuQ}UOXH0ccV6oHP^n_BFbDQG@J8tR zXK?ealHxn;v2U=K{1TQf>Nu67YuN2#7G5c55Jyo<7oXS4bMA`s4SM@Xkqkb&LNVcX zNiHoM8{N9)@av?$&(=^3lw+|atK!=FN=`t3%0_m3?O}Tv>dgtTn06&27K zM17H@G3o{wH-6d9zz{dI%=!1Zhn4r zhPIhswpBT`+4#L(xjydn#)8i_bu>G}b-jMkP1noagb;@icZa~-thp@Ik}d06#{#T4 z5Mj3izZa2R%)w3n=`@ezmb$y_k$rE7Lom1Em~zrEp-^Akn%9WU+mJXlLp^IT(%rY{ zwAdcdHyhCZ33T1dF2EeJh@or6>vv4$6MO`JI=3aNBDgm0Q8q@OK7EG+$dScHPda?a z7*do2^PL!?7X=Coj3>e!vo9S^f}M~AXn9ZGS|1$pxe2pwA?mC=ox*tFzK z-dXe${+F%P(>zTM3pPkNvU{J<-G|X$?kh%@y$*OFJ2)hfDn$2QpVEXTjxx`0&)SK2 z-4J;|W|JoPeO0c|eG=y3wgbm!WvQteaUD@_~Z6bvi z{M#NfC~EcyQKrek9n|vv4wT$1yw$(1{zQs4l)dNtUqy*DW95H^Fy~l3Bd7(2O12A2r>~csqHl5!GDV)O z9dqG38_Wg9Ot(8T$I)am#xj2kmcty+(Z*%7_{3&dY~+W=5;$~!P!5sB_p6oF=2xv> z-H3>59^EYx2?{T{3v)SjWyn8^$W5I{ZH&7z@;*?2z|?ttk;fTEd9~#g<74z7^Qktu z`HcT!ffM}bVc6^;9|g@8xz{Y||EaSb>{d@4mDg5arvYLuF8bpW%V1H^+#)iuMVbI_I!_{up@ymj?iFz1<(Fz;=ve zr(^y6W1I`b&|OGRtjG`N8p8+V=2LC;<$l48iLJrML;m;3|FU_cI4z#C{&wu)nux#d zOeS847V3`FY#V>qjp0XISMkZ^Pv<7U{q=GRjJVQBNAEf-nm*>;L*Skwtl>AaPINy1 zvE;aX{&-oSMs^06%SVosxhq>4(twts+w-TI1MirT%X~W{Y?Xa^0JIGb?X*qlyfY;- z;N&M_)mBV2pdRCr&uasTsbdLT8{N@|YkC0bDd2#S4jx&oKq#M%IG+phVK*nBuIL&{ zq0LJ7F=>D;JwXqd5?R?z$#gDgYow~-yd9<9P0`2V6`t4L5>IUmmQ2ZHeWCoa;!Drc zY$o0zbk7733|p}2d9X;{2V1hCb!;q91H7gk+fj|h$;htqiQVeBP0pu&7ZLLNa_oyn z8vCfax+qA>Ix1xIad^V@qL`w+l+47DdZSg5{Tn^*N#JT8KL(poO8@AtmtQIj*t5p< zrb!ouwtUMGa0*RVtJt^mJ9q3imErJbMKMd(?u3LnCE9a`W&g4bNHUx~QsaPzkGNFW z5KyXEFm*DkqL%()Fz20nqlroKf(n6T#Th1dEa+EWN!~ zMaYsd<6c@o+dWeK-N)!yLb+*T%^yeIUV#VSNd5E;^z;>4{jygSK*~^PJYUnxKN}#| z!Fh3+zr>?g4R9I~cLSNfTmLYU=qQw;El7|EqQqwPSg`WXgs4gNv)g4oH(Fh=aH5W@ z1}g3QcpaS=+cnB>G#Y&#s-Cq(uV_$p5t)Ue=`wG)%JJ;PR!_;(xjWU?Hw-HMC}ig?_o9 zkXI=unjev-o}ksxQl}kPU}k{TFtPgcR;6ZShXQ$rFWI#I$J(;AvNP#^hSh7#c19mo zG<<$kt4cD(ot?Zj3D8+f+vf$4^IsvlO5tVtnBa5Uv!ObGT3)Rk8ngkGrFefFE;rT6 zQS`dws5_UV==bM>lC?ZDy>Sh;7kd~P!|ZvHSZ?aQ{N0Gx*5gAV{cJ6HszAN*gA9dX z&|bP)JT~-ETHOm$iI$_REZ6rXgTuFL`U(8l(pjbS@*P?hx{NE$6^N8!Lq)LK*x&Jg zIxO$1i=VH3b3WK{+5h-x{jd}XE^zqd&JR=~F4pk@8B8VFmp(aMiJdQXr8CAI+)ZdM zH^q5V(Pb0y_j~!s83vBL`bneA`M>@;6FW+fn> zl8c0B3rn>cYmN;P&uXr}j_=c*H68sXLwQ%u!lgKtDY@>aJ(}zGaZvG9Y6~x5DS#N_ zr%4`|1S0s6&Nk)u>!y{tJPq1mf&{9x?jr1QR8c6~oKGSIa$qi5tOq3DW0v_V&@bBk z;)<)3)AlnZooSHHMbQkvV!+WhBDIWx;ItCLML7{+EZe@V8x!zHlge2Zfd_th?nBsw zB`QiNc{K={*wvX8R;7C2EQX<)ajJ@R`6xJ3BQY!M zG$i#v5uIiL7s&D8xW9f8FJIw$PJpUJHBDc=Mw^*T(kA36$1d?h+czDAI+2F95&b#ffD7q^)M%*aw<33iE6Xgff69;lqBsw zy}b-+uSTJg7!ArEc!kXj10qp-wnXMl5W3q(VIJRVFWIkp<^}(k?jFqi9!4#SrdglM zfnXX>KQ~JxAQ#)2h#ioGnaMob(XXb+@=?qMg|;-BZiY|}!g^f{N>o>YnO3oVUH7r{ zT8}Do{;L1^!pQNc;F;&ej&$ucsRhk9M669BYbV zK4Pya+|b8ROoDFnFH7`7=cb;XiYjtRHIfBdg2N5?!3oI3j&!S-Fd<{^=~0bMk{ZI>uIRBsM+w%)AhTQ?X@9yC%9wH;?7exvboYi`s7M## zkDGJhAA=&Wf=$gdbuz0N(TaP6lma!%Zo~M}mm8`xtS=}wJ>X;Iz>2sdubEg(ah`V{ zXZ)W`=4lwp2xwitiR1eLvPLF*LhI1ci2b?-nXPyPKG2T4@}}zKqn2p|Q^f}4Vwox6 zFHSfeLVFJM9K75$V1lEHvbz_Ebgt$U5p5`N%$b*>h-2%pUhkN6+y%!;!jD%I(zA zm!{B_41$lsz{Q4TBKtFr!X?K2ge692l%VmOrB;W6%d@wQ;V6h0FtQ8~(OD|&!x3~P z1^)hV=U0KVl2a}bximX^_|aW(#&cFNjL0=5*=04BL5G?MFv_~p?k z@TCKH1^Bk6*o0LjYZF`Kwfy|-gjiYNUcosM3yus4TqyyGu__yX8zPeivU_RE=0_OJ6Xq2{>KW=Y8J>Y?ILjrS6M`rdw zEi)%5Ovr4>(2XLXySv->RmV}D;XGJB$r?@RSqoZvfC=#Y>$HT%I3cltaR*t9dI0bC zo2dLs8-s_oA;`$j+! zyX#HFQ1*2r{G%DX!KacidRMgg^`7f>f1_n4PFac&+Pv=KXxk%-Q&) z%w=YDO~OWrOm}_Rz=`_OsAsII6kYqLK-c0D`17g#AZBm7lPdn=c~3qr10b(%2%h&z z7M$)c54J0Z{}>DL{6~?*Q;heOHko{Ek9e(^H$`+kT%18{7o*E?#Q%WGI*8M@w_V4P z{<7O@bFil~R1p=Jp6=P(D&{ewnm2;bhw~Ng@tMk}K~4v10;)R)mCi?~eC52tP$znX zAa6F`+;Ig-Mi)R&1~&~w$28smOkzq8)tgx;D4Y+SOM8 literal 0 HcmV?d00001 diff --git a/docs/custom_conf.py b/docs/custom_conf.py index e5bc31509..4430eeec1 100644 --- a/docs/custom_conf.py +++ b/docs/custom_conf.py @@ -113,7 +113,8 @@ # Add your product tag (the orange part of your logo, will be used in the # header) to ".sphinx/_static" and change the path here (start with "_static") # (default is the circle of friends) - 'product_tag': '_static/tag.png', + # Assumes the current directory is .sphinx. + 'product_tag': '_static/logos/juju-logo-no-text.png', # Change to the discourse instance you want to be able to link to # using the :discourse: metadata at the top of a file # (use an empty value if you don't want to link)