From c2134f11229c87a24c0fa9601e2956894b125484 Mon Sep 17 00:00:00 2001 From: sasha-astiadi Date: Fri, 1 Sep 2023 15:20:01 +0200 Subject: [PATCH] edit readme --- README.md | 67 +++++++++++++++++++++++---------------- content/header/_index.md | 2 +- static/images/logo.png | Bin 0 -> 9945 bytes static/images/logo.svg | 9 ------ 4 files changed, 41 insertions(+), 37 deletions(-) create mode 100644 static/images/logo.png delete mode 100644 static/images/logo.svg diff --git a/README.md b/README.md index 07e2c68..60c167f 100644 --- a/README.md +++ b/README.md @@ -6,14 +6,48 @@ The official website of **your website*** -Production(master branch) [your website domain) +## Getting Started -Staging(developmentr branch) [your website domain) +### Fork the Repository +On the top right corner of the repository page, you will see a button labeled "Fork." Click on it. This action will create a copy of the template repository in your GitHub account. -Last updated: insert date +### Clone the Forked Repository -## Contribution +After forking, go to your GitHub profile, and you should see the forked repository listed there. Click on it. On the right side, you will find a green button labeled "Code." Click on it, and you can either download the repository as a ZIP file or use Git to clone it to your local machine. + +## Replace Template Images + +USE IMAGE TEMPLATE ON: [FIGMA](https://www.figma.com/file/ZOf117YaHS3Gg3IJOvSIZ4/photo-templates?type=design&node-id=0%3A1&mode=design&t=WeavsHLNVCNYNoJg-1) + +Access the provided image template by clicking on the link provided. The template is designed with a fixed format for images, and its layout includes predefined image frames with clear instructions for each section. Familiarize yourself with the template's structure and layout before proceeding. + +Replace the existing image frames in the figma template with your own images, ensuring that they match the specified dimensions and aspect ratios to maintain responsiveness. + +### Customizing Your Website + Export the images from figma files on the new repository. Detailed instructions are provided within the figma file. + + Customize the content as needed to align with your website's theme and purpose, following the instructions within the file. After making these changes, export the images as image files. Be sure to follow any additional guidelines provided in the template file for optimization. + +### Reviewing New Website Changes Locally + +#### Access the Terminal +Within your code editor, open the terminal or command line interface. Make sure you are in the root directory of your website project in the terminal. + +#### Run the Build Script: +Type **./build.sh** in the terminal and press Enter. This script is responsible for building or compiling your website code and assets. + +#### Run the Start Script: +After the build process is complete, type **./start.sh** in the terminal and press Enter. This script typically starts a local development server. + +Wait for the Localhost URL: The start script will initiate a local development server, and it will display a localhost URL, such as **http://localhost:xxxx**, where xxxx is a port number. Wait for this URL to be generated. + +### Open the URL in Your Browser +Once the localhost URL is generated, open your web browser and enter the provided URL (e.g., http://localhost:xxxx). This will display your website locally, allowing you to review the changes you made. + +### Publishing New Website + +To publish your website with [ThreeFold's Operations team](https://github.com/threefoldtech/tf_operations/issues), create a new issue in their GitHub repository here, specifying your preferred domains. They will guide you through the process of domain allocation and setting up your site. Once it's live, test it thoroughly, and feel free to reach out for further support or updates. Feel free to [create a new issue](your repo) to report an error on the website, or if you have any suggestions on website improvements. @@ -31,30 +65,9 @@ Create an issue on: repo ## Administrators [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) -## Contribution Procedure +## Website Maintenance ![readme](https://user-images.githubusercontent.com/43240801/236867088-56c95abd-510c-4202-b0c5-317cdfb75cb3.png) It is highly important to follow this procedure to contribute to the website content.
-__WARNING__: DO NOT commit straight into __master__ / __development__ branch. - -1. Create an Issue -Feel free to [create a new issue](repo) to report an error on the website, or if you have any suggestions on website improvements. - -2. Make your own branch from __'development'__ branch. -by creating a new branch from 'Master' you will be provided with the latest copy of the live website content. - -3. Add your edits into your own branch via code editor locally, and push your local changes online. WARNING: DO NOT add your edits straight into __master__ / __development__ branch. - -5. Create a PR to merge your own branch into '**development**', and assign one of [ThreeFold's Web Admins](https://github.com/orgs/threefoldfoundation/teams/team_web_admin) on your PR as reviewer, or assign @sasha-astiadi as reviewer. - -7. When PR is approved, you can see your changes on staging env on www2.threefold.io (development branch) - -8. Admin will then create a PR to merge 'development' into into '**master**' (production branch) - -10. When PR is approved, you can see your changes live on production (master branch). - - - - - +__WARNING__: DO NOT commit straight into __master__ / __development__ branch. \ No newline at end of file diff --git a/content/header/_index.md b/content/header/_index.md index ae920c6..fbfd578 100644 --- a/content/header/_index.md +++ b/content/header/_index.md @@ -4,7 +4,7 @@ description: "this is a header." insert_anchor_links: "left" template: "partials/header.html" extra: - logoPath: "/images/logo.svg" + logoPath: "/images/logo.png" imgPath: "" --- diff --git a/static/images/logo.png b/static/images/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..9fff0ff5f2d9d0986f8428ed9041c91a6cbdb26a GIT binary patch literal 9945 zcmd6t=UWq7w8l~47~oJsKvbFp0qG#pr3X-|^xlqoy#0$CS3sV>g2_@*i;}*%6%=^Tfw_ti|N+eZ7%$vk7q>hSOiXRe8F$@ zMcWVDJ+`!FDWAuhId}b3R0NW(+5mnie*3I0UF!TYCAswA0JqrwedC>D4`#aq*ATjR z@TFlow6SN-wfgef@@DbIGY+T(U`NpYKR>M$3F=G@=uAKRArw#R_a1NoRT%8to$r%89ueulUG_;{?Td75 zW`MEm2m!g9bCK%v?`+++MbG<|te4y$g{=)L5)`k)Pz;oZrV| zWcnD4Cmb+#rPW9X_7?Eiuq(U?vblJkW%vvq>lk}5E-%~ni#y?fuxPzV!#>EgOrW`W zWpr^@Ub3(AYT&;Af-dl4L(Uj1sMln4KT&Pu&eWp!O^OGPMn(C{c~)yq;xHPnFRF22 z{cOf9e$^^J%CT80H?oWRry((6J7=^-h4~(no9!l>-b-#iDbk9JS=A<8$}?=+Y+u>J zLS#diLCO8#JXn7DicqsnZ1MBLd!u1)eWVEC2jWY655Qi_TD?N;KCw6FIcB0@U{KeE z8dm;1$)4G7=Dr$>SYN-KkqRH%nZj;G)D^Rt>cTVnF^hnu`||sD8nVv^d5eNC#x-^t z`XXpgKltGc3R+pC@YV#whSb^_)2+;BgcWB|O3^n2vaIAv_|6X@)|DZdaubz_=1L^{xF854i(^M*DK@*OoqPa! zCU0(;SIBOG7G3RH?z%zQP|MFM?R7%zWWTk@UyPRN86F>|4^Iq*Y++e)u6^3$x2uKx zmwMQ$u$HS;-q$i69OtLB)CfB<9svzsl&i(+ZjeVX`a}+&Cq6A%to>Dp9ve{;_lLoU zG2-NEBh|#rZ%1&isjbjVcXep}5tg_#8}?A;;%rkwgt7Z-tWtfY#ZxMK!R&}?wP%8K zHyNF!P76gd4IT9%0SRgMLS8Vaj`X~ru^51d`M6T>bx=-XuGUcxnr}V%c!1MiR%(Q- z&CR>18~mtS9hM7@Etaj!JMDi1u$fUn)=#7_H+G)IME{JlIf2KUn{VxQ{ITunkcX@= zOTI6u*mzzX9V`VKLyX<=2O0Dn_4!$?-KQW_Wb8H(Blwt9-e7lzO1xXIfgEEt-x!1n6=+U zrhqS=aeC7qZX6dWp42UNwIXj-F0s`ybwZ~mxDyGuc!&MvULCS#L{`CjJnzA_!h$Qw zh(O;kf26EmooR=X!KwpPcGpc0^YDNm6N%UPb<_P z4*AD>p?&S!wk_A52B0efWkPg=N#*#-TcEcwk*u}jmhbb9g7-?Fr8|X?gXSe&GP~^K zOGBDXAIM+UF{ICj-2A0U>1tKwz}Vh}jL_U;G@^l@m*&ish5ILoWLO&T+xaWAm*_Wi zo_i?kT6aPXFLzq+1y^S@OxrsodCO6UJog0b@Zi@M?cSQs_Eb(7|D>`=%Y|T`R}h9 z!IlCjmpG>o+?j>82V;MtGSOq6ID=06hYPP6=G1(_E!?gzC4(^#7X35mknoY?sU28|(a~bMtC*g||>V82L$2G(N z`QKqIMvE)n<@+-jAW~SDry8cA4P8+WS7-6N<_Jq9A*d$-&{Q#KJ4Tmp&}N1|Ik+&hxTw zL5uD^=Y2-!+`ROS@=v@Y=;F)FMsAv?u#as9Po$hN!Bj$YNtvyzdUj{WS6*Vn$zqg` zap<4aIA~O_l$rN3#hclkD%{MbEf|a~?~3c9I}kU6A}>@JCrh;tXY~OW@4f081UmxC zmGCM;Wk#|oZOg2>YEZMKB`k%n?_sdyn?kQmP!YtcWVX z_cimmr^u<6Zm+G{VZ@wjMnF?C^vGp}7oOtud@v1g!Hms_!gx|fugBKChBLXB?z&Su zis65GM5iwR&?Li>`4sQ@ogtee97>R z)vFg^>kJv$h%PZ+ii?7-*T!H}WGez8d< zOyhbrNi9u8PC3urNc!M(Msz%t3sV6*_q<~@r)P{!0X(nZ0Uj6TIjQM>;#~e{@4rPa zV<3WNUjI2zNC&7Mn1&mPZ75>&)@lH9u+`#sJ{Dd5nuRWDnfIVyE4!Bj2tk+xMV+?a?w( zb^?!m6|6?6c8x;|gXUCrgZdk&9*7QzPu|Ex+OmS>s|Q>!(2JE%EX_xvxTmNj&j;I; z<(sL=ez=R9qZ&D{T;I&3-Ui#V>$2jdvqaw*UuDL$56V!#b^R~AzKxA3$3QrN_D@#+O0XaZoNhGS9Um=i(872Z+x{G_yDNUpVa z;m-nAE9EN7A8J^rLvG8+`9;A|abi+-cO%<8$kNm%WTW>vVxI(z%^*>HW@j|?<>$7uKkA{babjpc3j@!v?IR>Ikrv3ld0T(8{yU4m zh00F!X7?T2^x$D+V_Zi42Q{@%7nfzlHEy}ka_oFa~DC>h!*`&J2`s@3-DMg zmwR-xy#eBU7>8JRs%8~Bng5eoe{H^IPChB21jgdq>z|YRe9##nk^xdodeT z)8;7dOflz%aGL^LWRh9%s!X=D`G={R_p;o6y~8U*sOf1`1xM0SzaWK!5|f_gHRyzK z{Nr6lF)7#?5}Obf!usCTO;{5gylw9KE8qLRN%h4X0|^~M3pERZIa4@;famiVqsq5t zcTyb+{V$g(txb|QWw9y7=YrvS6dJ&*#`{=yd$LPN* zdwu?8J`R7XKwE6hToo|%tqK@-8V|ItjYgkAa*vcrD6E{-nLlpXW3A;yTg;p{wE`d^ z4G>h4@kG%>m+^shu)9_+$NG+krU3S0jy#PlKHOykq+PQ3&Z#0J7X)Ks6i0=t#z!3e zNc|_+lKQG7pZB3ZfC9)(tXM4B!&zC8A@xYK4K-mYdM$LjiC1Z&b?_78cXR#xU9E%6 z73rH*9o}wGsRk!AJT90A?<>U2^CPLbn zraPsraa3+3Vf<)?-M^BgGG-Jh^^Q@Bw{2`V)=+I<)~wNS26QHuVGd0Jd<#6`1%bd% zQ|~p)?L&J1sB*7f>=#PX-wE;%IQbWr^L4LoseMv=s(snbXSB)5A{o_rN0)|u=K=6| zfB$&&(}zi9(B%{3#K#AT16j(7_t+U{{h}3U8UebL69d*(0-g{@YFgMbeA3Xc{1N<- zn%vzD`{EMISA!0A=KgxLhng;wwuP(FlrqYK2Bdvc_X4A$Rkqjr%RhJSp}xh#!(7__ z=`lbhYZx}z@mHg3>%DQIIqlhy{+F-P_hdiaaAWekM_c~T8h=0Hq;HCQvxmo38~v3uIT=R!8kZ z5AQ1;HiS#}sQYOw$V^vWzkP9OMh{(eVQiK{SHxVdQ|P8_V6yS+-n5=Wk)5qq&BKbr zuV~mcRY_%^OE2uBSBYE7RJpZfpmpLwVX9GB{d+q%(xS#S!`MY1eSvE80-o;2+C&}A zY0&B=&G>blB4q!)VfvmF-p+Yu=l+iOPVJkoojY&Lr4DJkcaXV}=m^i&rE+oZFJRwO zx2B9=Eqs6^TsEC}GuBk6X<5py`eRj0GqPO?C3m*2aLg{c;}hY|f4m1`jEfmO`6TpC z&_#dH5Bt@y*CEdaA8)=1qOom+jP&eve-nqHz2E+Gz_t3}y9wC%-ql3-kiet9-f6q{ zAi?U{cjEkkc^@L_eC!0}1%)t?xwQDg`c(IRT=nGOKRciG)dykWrhpjY+C9A&Xrf!~ ziwU%EJ8dxh10N8uZ(CupUx53o?CLB3omUCKw+>i7a*)-(3a4!JUJg1SQ1AHYHZv2( z{^q_AajVu$1<|ncrw}!{K%V6f=R9lON9Ob3*b3*-Z%Q(WgwM1AprZ+rfU9x&%4x_1 zLzBDwcekN{&b96)d{o^SaYLX$EZ`ZQexSXlMJiiy57_#1Bxqe!gJ0!`v9)D{y+?>W z+`~mN)t-B1jPx%TKZ79_V*U)uu|`XuSH;JUs1YZ|qnH(9hO8_iSH=XG;=aE;nZ2v9QOn>_Ai9vdShzBcf$V%;A?S(-Fb9D0r#m zKG?f%v*mtDTmsho*^r*jW7h6IIz^hJ51fmUJtfZ>qcC1-m2!+BXtMUruR{GS#wnNKQiS#sVu)kJM#2%^LM8d;)>BZZHZ z0JieP_;`=*t^ez_3ys%2v9Lb-M6vFsSHLi{cDPsp%Xj?qxrx5{gva3nnn-(Y5f|;6 zQr9KDD90P~kyHpJ%E`jILs7`=OfQ|7iP?e2HUD1hgW5MQCRA20#xK*xvX>j5O^`{d zPo9}8`(II0pr5u2AZnC};|!H-i>UdP;A+kh0QQu{MlV6uc+s-f(xjH3_x!I19m|3i zYs-1(3PCe_s%tJP_AT-giX!ZYIIeKkb+UJ`;}WGNzN#lnexK5@nb=AW?`v`4JRgnf zb_l zAv&BnwDd*D%l4%m7sJ){9~pBFJ6oe_)4EmED(qOual%b=^ck|$=N6-#y7Xe`FV2S0 z4gWsLoto$c(?jjob;!`e9rg+V;zAIG6y@B67~0m2oFE6@$FvE+moJK=7AJIfdKA0J z8@iuHW=rZ{eN=Aj-A8i#M(v$%hFVRyJ}VF7{&>+xz=(_D(Z;xb=1`C7AKNxRTyL$$ zpS2tG*R2tTfOy)eXd?7`kmnUHNMZbU{lF4eX3<=BQrIQV7zgt1c3&u4s6$>U{CHF0 zzI{BteLi4i#B^VO2XmMbJ*Tpb$uCvOg4sBe*OS+tOX3&4DB+Lftvl7YMk8vBh{1Tr zuAZVl2wCw*i}gjy8OSbE%%P0uRu*U=>^6Dsd4%I)W16PfO|YRZYJ)UBjm>SUae2wBX;_TDCfSh`Bq8%05-5sZ9PV#?Jr6;=3*7vOu@b z5%*s-w;-MILXjDvD5KH)7c63g?#&Ndh*?BXj@3G|S2$E5=Jr#i8z;n|L)Vy6UrUWa z_oc@?|3a{bdr(^#0aqT6ac|@=1unpJ2=I1?(bj3~;sjLyW)ndqmHfmoJwXmKcA6+# z1?`jp^y5t?S{@^x4P31z^#_b4srTy0Hjw%W@pY=;@9|+SUqU=OS`N28LSeH<2pF}L zpHZ9dN}PH1WolRp7_YBg`n(kvL3>Y`6t2&X$$JJH|3hQ^Q?*Uy6LAuE`SLPFEz_&+ znosQN8WIx&Fs-gvz}>OD{_{NND~0|~O_1*Bb<8Cus8fnH3zkEd(l+fmX~?;6Y-P$r zx=A{D5bt*q+V_dZc50OZZE!K84a_ff2g86;?@Y%Qe7avwkaLNI4Z(ivIkM?k9ID48W_qa<6jO+jm_+ZBQPvQtGfs`q2ns zVnybg&-dj70s;VAoHCO;>Oq75`i#1qt`a%$!iEtvWU(Xq-&9tX)7StedS-tM(*wwr zmPZ+O#xqSy@`?A(Jw^N%ud$bg`JShs5Z|5l#80Led63aoo5G+dsC}0YQ%A3?Gxc)Nz`D4t`Nj=P@s-?(#LEq!I zG|R{)Q+}w*R-R8!V1YdUVhkr+xB4%JrpH0*8HLhWHhlFiK>r@bbXU=gqlrer*Ble1 z=Jc3k>~MhU>^5(Clr(UW-qyy{{BUQter5p~O8C=mo#z)3i$E_1l-=(0qkcXoY^Fz+ zt%195u;M#kaCRvuCP3F6j?5JzOH9mY!q}c4G__Zj6?n8(LW{sBg@4xt!4jofi*>(! zc6GhiWF_F^&R)|RG-PiP3#xl@9{dNd2j)k#v~sSv3`a^ydFYZ4SrgYUeHIVPMXss54i)}AZO%=x4I+wh8xTq7L6x9?io>+|4G7t<0!Ta*yPHi5{ zan?5{mG5mP)Smc!_N$%Em`iuoz&K7pq^pM)v+uzA9vISme|OMCl+U~^?}y%Xkbg6j z!ReH9OL9G!Erg`IlXmGJ)4VK}kP8tfOOW&yDTK;{nLl8}(FUol$y9@Pwf zBC*+`;}R?kh62;1HZ9YK#JLtOWxn%2f7+Isk~F^0)T!Go$g;A}Q2B=K(nRG@e|)*B zV+9{tEgtBYWhmf*x)&mc3^E>xq-6yX4Tvvol-lQ+$*=n7_qy zvXIOX*;R|=l>o7p05?MFNm&yzPDdOmu#wb^n4$wF(l zX$5g?-Fuf~HgfsGDhG~rH#YzN3)nD!_Hq(3qWoXw*WMc!^G3Uk0Z=<}5);!K)nqR& zOLx|y;|_{z9i?-Vuzvq4)<$;qql?ZV&a$0#+b0MWzf>s1va%6cCFctH%u(=a7q#ue zyw9vB&CEOCdvMulO$I}s+pxfoG1;FOyT8yXE@~m4mRmgTU4A^JExgTSr1sKHRbFO# z%O||TBZt*S`Kp zhACNSw4&_ALhY(M!ctkbt)1uS^Sk-|wPHs_uAl8Qa zzK{_%9`_{cF!*fRdJ*5ASCYZbx^BJp>V{{~lrnp?eHO^=+*8G!Rb@GkefaWO9r8Tr zFRtw7hUl3|u6_REuAtCbj2?NYd&x{8Dn%|Wx7QII8zWeTqAF$MaJU>irBxy&KG`;O7pzE%I1KAf0Q#3huA{^&qhUuS{ z;rClk&y5&u^|xBYlAG})oGgzlg!U4tinOA1>vjUFCl5W&7d}vNhKC9_C$@MY`&yr( zuY5*hnb4oG=X1khp|fczwnEUIUlAVS;;$c_6i0PdC`OT9^ts7}G#Mln|@xm#bGLL=XGNw0*e+qf?q8(ioZ# zxvjdT>W;Yf4O!nFo66yqr|__vSL7(BFYj2u_a&qx+8`@SUxkfx;AlZ=llkZkw`)!K zHhH8zhh38!%KceLhkKh$A-y6ElM*R<$ZFy%EwTYy)Me(MZ}uf1BYF2sce(N@I!>!P zAP-l=bboZNxYHLBa=zw^p4msm7Zsr!D1|D>$g-v_rFwXLBA zB^LIFXxI$BMgou7Nsz_7Ra3XlG^OpZFWnU451kL08{}%vb$gwo%o7>WF--)jJqnD= z0*5w*O!UjHkHIv-TE;*5s_NZ7$9cW^1#7KBxyT8oPNcsP@10+?%0TPuR61pqsEzb| zsY&s_77AMnvtA<#wZ0yQB)lkG{hbb*@|Nmx^38Z`zBjNbBi<{GV!pyY0qrumX<^%E z|AEI#VD_0mRrEN9zO?kSzi@2cSn1{*a4)4>-jXd^HF$7m)^U2cxoZ9Qwv|MmdsE!O z-LU-z4_OB-+?uUpMHph}TK{j4k#SbJi34@S^Sj-y4S?p1cy*!^synSW(I`D2oEVS> z693#@`Zz_lRgscevFU4LdgDdKv7tx7ya;yMHn6e=XxmRoa&g?X+o=x_btG^c7b^Y~ z;1FzmYMCq&$&TP0i==<)YYEdjskinsg@-{SimPM|4~Bz`Ob^wVbt|)BMB`MFq|`fy zu90q{j8#wU&nql=f{*jUiIP)%3gZcVGGuBb>y?br$V zd0Qu1qqW#|Ozih3oq5MJV)13zt&Yp|&pFp@YnZ(M_Mn?_3dV={(#fE z?QM<(W_Gt{E@rC}DqBHwEdS<%+lODJf%>@S-^%Yg+qYetezvRbzlF)s{F%-GY z{@Nbiz0D*8-*qq>TwPmWR+{m-sCm@bc&x`p*ZZj{Gb6XTN=C2fbt@-M>?M0WCoU)j zHe8DM&*KP=VEPHtu)&+zlQ-g%g~DZo~Wc4Rl@iV5>7C4{Ctol=}=EY2N=E-~`H63!3jym=LP zO8+C`PE89Cl~w!OC){0_^uSN?JbQ!4MzsO9rcW}HxM0#>L;cDVUitQx^LT>KOPB6T z%3GaW!|{frnNo*l_=T9&`BqwC#CsbUnI##Dvcz1IzNK~#yv)welvqs_yirs*usV%H zmGgUy;w(tfo)0yCgnB?G$UH&ua;VT$K#=4M@gDEgoUwJK`n5{>(X_3Ch{uQ;Q`%Rs zRiT!Gc%SyO<;svti<(X0Ox1em-0Jzp^fblRH8#PnC6e&%8W@zr7JB&WcCxMbwa;shmBts5!}>KNSz>svaZoO{DOXU!a#0`AmVQAH4tT& z^j~J4tY&2=@_S@ac*}n#cDzjAS&w|hd%ODdKUCWJ;-&(@R`@>>VY@kWU+)sL6ehBO zNL}9By2G{y(>}%rf2VYr*lEYdd!4T(`}ef0Jx?DTo+fCIc7BB9^mI9UBf2wrLgxclh+8zTIXv1G6QI29YfutD@h z$2Uw4bIu@IMU=J@pODVlnR|afHo{9wesldE<5pDS=v__iLj^yl!h$MjQBZ397L#q2> tO;yU}C9whN|9!XA|Dl`f{qoJN>r64vYyI3pVka8OOBHQMm6A>P{{U2wtS$fm literal 0 HcmV?d00001 diff --git a/static/images/logo.svg b/static/images/logo.svg deleted file mode 100644 index f58e210..0000000 --- a/static/images/logo.svg +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - -