From ef64e7883c7a621a36d950e50de9c8542be14042 Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Wed, 16 Apr 2025 11:22:53 -0700 Subject: [PATCH] Add CodeRabbit logo to documentation and recommend usage as profile picture --- docs/platforms/azure-devops.md | 2 +- docs/platforms/github-enterprise-server.md | 2 ++ docs/platforms/self-hosted-gitlab.md | 2 ++ docs/self-hosted/azure-devops.md | 2 ++ docs/self-hosted/bitbucket.md | 2 ++ docs/self-hosted/github.md | 2 ++ docs/self-hosted/gitlab.md | 2 ++ static/img/integrations/logo.png | Bin 0 -> 2891 bytes 8 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 static/img/integrations/logo.png diff --git a/docs/platforms/azure-devops.md b/docs/platforms/azure-devops.md index 8e5608c1..12b70765 100644 --- a/docs/platforms/azure-devops.md +++ b/docs/platforms/azure-devops.md @@ -70,7 +70,7 @@ you will need to add the Personal Access Token. management. - **Use the CodeRabbit logo as the profile picture** - This further ensures easy recognition. You can download our logo from - [here](/img/integrations/logo.svg "download"). + [here](/img/integrations/logo.png "download"). ### Key Points to Remember diff --git a/docs/platforms/github-enterprise-server.md b/docs/platforms/github-enterprise-server.md index 35f459bb..2e8a6876 100644 --- a/docs/platforms/github-enterprise-server.md +++ b/docs/platforms/github-enterprise-server.md @@ -130,6 +130,8 @@ Keep the following details handy: ![GitHub App Client ID & Secret](/img/integrations/github-app-client-id-secret.png) +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + ### **Step 4: CodeRabbit UI Onboarding** Submit the details that were accumulated in previous steps: diff --git a/docs/platforms/self-hosted-gitlab.md b/docs/platforms/self-hosted-gitlab.md index 4ef7623c..53fae56f 100644 --- a/docs/platforms/self-hosted-gitlab.md +++ b/docs/platforms/self-hosted-gitlab.md @@ -71,6 +71,8 @@ After the user is created, you can retrieve the **User ID** from that user's profile and generate an [**access token**](#generating-personal-access-token). The access token is used to post reviews on merge requests. +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + #### **Creating OAuth2 application** For self-managed GitLab, we recommend creating an instance-wide application diff --git a/docs/self-hosted/azure-devops.md b/docs/self-hosted/azure-devops.md index 68b2321b..966413d0 100644 --- a/docs/self-hosted/azure-devops.md +++ b/docs/self-hosted/azure-devops.md @@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit - **Username**: Set the username to "CodeRabbit" for easier identification (optional). - **Profile Image**: Use the CodeRabbitAI logo for the user image (optional). +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + ## Add User to Projects Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with rights to post reviews & open PRs. diff --git a/docs/self-hosted/bitbucket.md b/docs/self-hosted/bitbucket.md index 2512cda4..f07abb5e 100644 --- a/docs/self-hosted/bitbucket.md +++ b/docs/self-hosted/bitbucket.md @@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit - **Username**: Set the username to "CodeRabbit" for easier identification (optional). - **Profile Image**: Use the CodeRabbitAI logo for the user image (optional). +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + ## Add User to Projects Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with permissions to: diff --git a/docs/self-hosted/github.md b/docs/self-hosted/github.md index cbb14c41..15f4e980 100644 --- a/docs/self-hosted/github.md +++ b/docs/self-hosted/github.md @@ -42,6 +42,8 @@ Set the following events: - Push - Release +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + ## Gather information from the GitHub App - App ID diff --git a/docs/self-hosted/gitlab.md b/docs/self-hosted/gitlab.md index e1203036..7337b231 100644 --- a/docs/self-hosted/gitlab.md +++ b/docs/self-hosted/gitlab.md @@ -16,6 +16,8 @@ The self-hosted option is only available for CodeRabbit Enterprise customers wit - **Username**: Set the username to "CodeRabbit" for easier identification (optional). - **Profile Image**: Use the CodeRabbitAI logo for the user image (optional). +We recommend using the CodeRabbit [logo](/img/integrations/logo.png) as the profile picture to ensures easy recognition. + ## Add User to Projects Add the CodeRabbit user to each project where you want CodeRabbit to post reviews, with at least `Developer` access. diff --git a/static/img/integrations/logo.png b/static/img/integrations/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..18eb49118e461353b28dbad1b2b27e75009deb6d GIT binary patch literal 2891 zcmai#2UJs88pjg|9Rf%REi@MhFf@f&C`t*0k`O~v5E4`nP^1{Dpb)Bn3I>#JLQfC{ zMTiuUHaHFlQg#qwD54TpoQxvUGjGTa>&|RB=jP>ifA{~rckg#zPOjpxc4EQ`!XOYx z%pPrn2fh=2{|NE|*X5aAkI+`Xa5e^?=WC6Adc-0V?i81 z+U&3+h+_xhSnsR?5(oh7up?0*j?+#OkU$ua=$!z-Knbw=tpREQ2_(6a8`zaV7^vk2 z0Li`2pQIgxV+-M+AsjBCcA1xh=H=M&a%^|TE(5^jZw)sFT)6-&0ae@pV9-1qJ06ZL z&p+Y6@m~Xg0m6UH@5)`^J_4BT!k_NOP44c5JN-8QZQ;LG!5q7tVfzOFQ}iGFALYLV zb{fKM%WgM-&T!4|o#FBy$K*bD_td-F_!I1I^;`dctG*5I^8c>laJIwG!~*a4ClVg( z0s`~!LiqRv1cih}M8%-u5|VqQq-A7ba`Fm_N^oTrRW)Q1j**P~Uxp}v47Zeqjl-{Az$|@?W zs%z+s+Pii4?$rM0d7NypR9uI`@R@B5zp@chUAffs{AFNa4)$Nv7) z_^XN6lT$xW&&XF);Bh{wj(Aw;(^nHPdVDz ze7@W8(`vMkV55_Q+^iQW(S?WNu3JWt1RX?E-Zm{~95AGM1$}z|?Kbz5VNDHhp|4&JhrXM6(e-}c9?U8sov^yz0F8~ zbykxyfiyouZhf})x|OLdtnZHRS7IKv3>KMj>z|vLa7Adi^h+}HF)Bgjv)<3jS|W0A zOa~)6jzKkeP1W4T=^`DJ!S{m^W)9PrL2f^sy{y%#pF;M3%2HXbyQt%ey1<$78BdNl z)~|dpu0(y&&MJ?UvL04Xr()g|Fdi^;mt57fIxm={6sv$E9%CrPFIqPrdBHU7I)nP9 z4DRHzdL72|LykEO;A%E{zZ^f_zeegk!@Rn&8-nu{Tlc16y<_}WfAKIUG1Dzh*G%^suNu5T!awrXXKzPeQQt(a zX)ZkxA)0Ruw_eiO{6aJj&HyQu-f$L)&9|kKl^-{b zCt8o*e>06C3|q@Ak7F~#i_4*pdSgD{Oyw)T5fhDH4?(H~R(5MFsG1DV87pWne)#k& zJ2$uWv#efh>d{G(=UDkQtNA%?++NHHcWp{PnHlH#h)Pj+P$oC^w26F|!W;~U5HMe^ zGZNrY)=y8X2^p#qm|CWvL1Z=ELQXAI7@+oK$&T3;K^yT!o5oqq$&mvA)TUlTpVf$o zu{Xvh?FnGE85~Q?@{BAZw&lP{<2Sz6(2)G!Q!J<>t;bOj;X3?Bm1TTT`eVVJAoLQg zYkxk*Ex4Q5miD@486J0y@rl?LVlsjK6n$-n5{$+&F{obQy%A!3Mprqujf*=cVa<8loTr4f8OdLOE zd%O~FSt_^}`1QAhbUQGrN5bS-+n$V8fAYYOBpq_%sdIGSLmzCTMrLo|1YZ;m1)*uAFQTV2hT(14h0p0Q>;nRqVAR(Ou0mKK=mzN zoI`c@8t%9>yIu%v7;l52hlb@tuNct=SADS7s>5`;=so}8z&Z#~OII>mI4GyO3nNq# zDQ3BPd(&uBbxNdGesmc+sS!EMTA%FG?z21+xFm5rn0jmFB|F=$QqfF&OWiTkSHlGN zBR+Z`p(4|JNbgDEU{{dBqhjGi*hnkAkuTPK%mJG^_HZ=xfV@u~b+~Bgtc|w)AtiT3 zx|;aUDW%jdwFSustFjw$&>~(}4|!1;Aw5!%P-6WM>ULn57*ge!+X$lOc`nOXgsdrJ zJX8fmuDOmB@rwx${g(;aH{udu%$ zt-Z$84!4PzTV;-G@ga@QvIf%B*lI0>(2LYG()Ibw`b;{tdT$Opum?3Um7b!kh%QaE zUhrwDy_%RX{;<(>4-}4k=)6y959{5$p`iS>_R_X2#P`^j4=!*4Q~Rn+=Tzbl)iP;Y bdviJb_-vrsCur~Lsh~(b@HYGD5 literal 0 HcmV?d00001