From 4df94933e2c15466bc4e005fe6cb014bb2c3d912 Mon Sep 17 00:00:00 2001 From: PLR <51248199+plredmond@users.noreply.github.com> Date: Thu, 4 Jan 2024 12:47:27 -0800 Subject: [PATCH] readme: add information about hosting and what to do in the event that the mirror stops updating; also clarify some language and make other tweaks --- .build-status-example.png | Bin 0 -> 4095 bytes README.md | 41 ++++++++++++++++++++++---------------- 2 files changed, 24 insertions(+), 17 deletions(-) create mode 100644 .build-status-example.png diff --git a/.build-status-example.png b/.build-status-example.png new file mode 100644 index 0000000000000000000000000000000000000000..95df2727874d9a94f2d5403fe23e21dc2496236c GIT binary patch literal 4095 zcmZ{nbx_pb*T+9dcStNCDIp=PBHge^uB3o8NK1p#t$>ttmw>QzNG(V$xWt!oVPOI3 zTuQore4ly#c>Z{Pb7#)I^FDLVxpQXjo%8ynqoqnp#6Sc904Z2a2?79Eg!g9^f(Q3j z$MaO?eq*&(gJ=T42QB~zi2#7hdnsfS0KA0&VA}!!Br*Vi?tM<1uGGB)&+3(`5^(qL zD(EarxmPHxEwy|A0Ji`Du-!S%atUPY06^{xR+88AL+$1In?AH(=+3w2O1Wa4 zCnQi3=;bLeWj4~)-O-oY=H1)=J%>W=!5y2B?PgBsY82YhW#{zZyU7lzvi#0dNJ|)d z7y;EP5yhagLUQKt@GaK%4i;{EfAQE^zTDvOarTBkZ0va0&F+DXF)b@a%vHAz4J*YU zDb9n|P&w8Y6a=ey4?^eVSQ8lua6GU>{d$)EdWCa!4!x_N0TY>tDM_KbF~08jV04w! z@*zR1#xUoPLDIfSP4e~lY;R4G3L`GcI{w%`IjIw`vw&i-+wx(IkFXAuEs@bzD2v}C z6Z9!m&UHREx8w&7-89{UR(HY8N7(-s{O@;=bNwIZ@>b|^IguS`z^V?l`#hP$Aqx*! z5+7ajzzqmB;_ngSc)IMn74_3XEK~Ct?#rwlSu>Z3MhU1)&}~rA%_C?=S%;gR^Jfj- z6oi@1F>8>js}6OklWX;lME}EXmGGg0GWU4;sV0!HRw-}!ygu(VGN=;b%9tXf%9OtR z2ct!S?kxxI+Zzz_RhkrqO45n~;G=fvF>)T>CwcR3;8!#_NqeiG__ zF2oMou+`9Dk(?PvMJcjutha>YHN?GAR8%C= zj1($2ro6-c;ILo;8nAh8Hh7H#7iM@UAyhFs4_exx++N|qp~YGS6IRsJXx9d_POBKB za(pHTg*7;6X*O71NA?fdOmGW$DrY~l_t4H0ggQA`pI5^uhbmT*Z~ALDB(3&nRDChx zlN3U>vsIh$m2reB^+fhdr{JpL_SyrBeQM+@rctXp1DZ!pF5j)Nyq1gb9+tjHu4aGG z0utim3iBWocx=K1fr(o#0d*M`fP+{zBZGGvo=c!|UB6XeeV>J9|Dr1@=vVopOVa_q z*tZ!XIz=x#_F^Bt*-+d?82e+Ybfs6OGn4%Ee@7va%oRoLYj$geC;OOo`8(R^vqZL= zH^O9J*T0==VwzNTIbS&Ym}nmIkURidwYs5`^lEq%{OI2kUZn>r%HYn)0Uns1K|lpa zJeMq*2JR4J3CMMatfLs8w?kF?XA!VbwOtk&uc0%2o0AuUDv|KGyHy5K09ZYw8M34V zyFKC#J>Kx194ONaaGP5=D|GX;Z^W_CGKva04DYtUo{H4n z|0h%5*(@m!Yxaij9A}3cQ&pLAvn<<_Z+i99r*Io4@sx4SPjpXMp8LCIDSW&f*8e!R z^MwnnvboO1AvFB-`Axi`3hq+Eo13@f6=reZZC$5{v@?|M=|t9Njv>4e&KP2lsZEo7 zZnLo(klIxf{Z;67yadF24uYI1KhgV;olR1bY7ZKu$YrMqZ_9n{aE3`Q8hK4L!6! z-x{^Um^aii&o$Y8_^2Mjd+s&OlYGF0h|c}4>r)sJpC$ayj#k3Yc`Ma#DQ{rmxB+U< zXl!kBdA>U~zh9NFtJo^;l@oSLh{#bOSh})jvu~9~gvs>7RZZJ0jtjIZSh1 zMS!1Wi$pf0Cy=iLK*nWpwrq8bnXqcw2{NGnYvMpdI&b!zIOeC~Kmz?PA{vkq?~qJU z*$P+KUd(B_KwL)1j%j+qL)Lzsu`q?Dq-%YmlCH4&yU-y&**IRni4`I~Hs$EjP@m_K zr1ZoqY4G~${G7M5n7wCt*$P{qw@wc=QG^dzgYdtIN-?k3($5Lz_!8TnEa+FlDt(wv zFj1x09B8A3W2$twyR(gK-@vPN9m2Wml|1Ws)Z_LqTLru;#lf)l-I3s+Ht{Iy)>_YC z@J9lE#NXhjSF1^ie9>Ob|JX5XJ32)E+OO_XObUiLT9uPLfTUcU-0~?6|BZ}ImtjHh zpc**KvbJaHF@0dq<*G=;qLJ9p&A>u$zkzA);d+TswbgDVpPlmYe%!OH`7xhVf|PHt zws$C<@#%1T223@pl*R5c?vRIZz<~J%H(&VlPaA)C()%Y6S6yzjPX|p?1U6ADo(xm3 zH@Z5v*S6%J&Mw-RIbfSbB878ggg9ImDXp&LzAK;k6V)#}e-I}cK=|2cA9@Ob=+knD{V*Y@l6bT%X z5|KLQlQ)nY!>&7ICM|6`ezc#DQyzCuKKO6|tGg2trAo!G?{D^6Uw6%B>(|pUctvk< zk1DiNt=`MU*#F9dm}u zRa~-<7?ij=h7WvJP)zN%sh2vhG#jkHRxs(?4MbkB`AAO$}vA z5hr<)uTDGup5Ra`6#keR`!6bs2<~3juCQ2MYLsS&)eEHI1>|)*iio<9sf`b$(aI#i zX%3tmo!Ca*>q!(9A04r>;;<8b@%5EP)SKQ})I=Ta%*l-ATsyR#F`dntu>5GzWb3$j zeMKB4PawXXxi6?jwaBcvdV^DYKLW9)pAl!$tG#cHo0UhuZYNnQFd~D`OlkP5oKkvq z@Ez@~V16vj{5pLIgbYc|OEia?t*(KJo5#19YIZ@5?t-$MhxyeHsG?NP_g@BTO1{C0 zef1ZMkP<@h4k%En_>uauw=+O$c7m%@cLwZtWRBThK4?6odx7bw%D8?Le4&_uCD)F9 z^~wVP_z^M+!XMlgmONV3^@C$pNQj>#mtg(Vl%bYflp}_(P^#eIEB>BYetgtJGg42W z*jP@ka9XK_VUWUGDt!*E#KwFL_cmF~+a(_H&v%osx5VmpCjovJxZLL+WHhXqn`!6H zN-4_*0U6&!;WgrHl%Ver+zRnTm;OM!QnFw!?{_gJBUbJf^RDK(@Q#j7IYoUmIvfi1 zySid=?Oe5(m1MYY7!Jk!?Y1DvzCm~`$<^H%Rw=cw|j?6ElhLQPhK|lM8lGU?H-5;gIa6TgYVwvG9R~sU@i8+iZp*jpnf2&R{ zN*aAzcf%0r9}(%l5+}2hOMjd;oF{b`OSE218Q+xm_GWoFJ$*Q*?oyBMFN1X8*RqZB zieB_g8`|w@VDL>_%lb%W%W~%ku8(d@C6W5HdmvL}8IcLbG}1=XFqRjTzXXKN_r@1j zLR(X79V?;J?r5nGjlfUS4(Wq|tjjMrxW$zfWo?*F9V)8XveM0|Rzy??=mgpt<^rvL z?&G{!UNL3GoLAk&E~S#5@13K5*(=1pztoC~Zo#eso7^gBToMa!CFsO0cq;PKRuriW znx%>}+hbnc%t5T^2v~F!)LmnPgNFFk?E;u@LH5_d~VJ zJHx8y+5ros-@LLC{zhxJgZwQ$<+8c~&D#ce7tGPIAR$2^NODMtWAqJ$LuXEK?vds% zqvI1v9uWfc#KP@v?q4;X4&OP<$_b_-_C-J||J#|Hqe8Ku>lm4)+3aR!gkY<&q4{eM znPbE-k?wUZj^QBbm)Mn5J51Mm#WJ_@!MVT^Qz|;Ti3XDazwL-8TDqgKJG~c8V$^Fk z=0eNlyB#I{R-P050HEH}^A#0_xP(#u@!d{_`EToJIaqt9tPjI_afSH7PgkX#{i+Hr z7VCavJ%lVrCunjUpRR2Mjoc9Oy{4_vFeYK<>GXnyT4reQzIr5S-f$ru3iP@|cza%g zc5H;JV+6e@8^oXR3EBgD>~z)?Won-VyLWx;k2bwB^?uJPyKiQ}N`*RC(rY=5m0!7f z=iMUeiPF)RGa)Z`$cI}y$NOX(yPCPp3xuRr_7Up~4d(9WQ@$;lfoB-sPhY3))eU@i z{M>8$(rI5MY~)EcOKQ8}D;U~#S<KVNgus=n2-{6`5)x2DUV_)qf!m-6K0C(N#H-CoUo#s#}l{F*M5 zF@9t06?1SZBRnSm7`tiK9Qq7s)!r;I9*ZKz0?EE2yd(ry(1I)yvkl^&T( zU!S1W*dcOX)S=%$=sQi%i!3gswJSd2N~ELbSupG){Ka$@S6&L?kr$&dhdlclUSt$e zzkng)m-hOa;j}})KsAwhX<1wheGYA|#9m7qGEt)4aRzba+>6XLku?DF_^VK#v*TJ& zsw7xI)!y|5PAT!5K5w`?igY1kWbC=ZzjjNv$ubOYxe!#<&t-o#x*W*uCp4`Jm zo`mISjD0>n|B{6qJI#B7IPN85C~Y*_P6Pz>PKd1(Jjp@m_kU9&$=>~g`NFUzV`RT~ zv1bxISmRdw#OY=&XPzh_=AY3qLZkM=KkKs((|NqTy0~4a{UZKuOK;=I`+fA+yqko$ zDR*S$^^Z3QUPNaa8 z!LN;U!*|1E2H*8s&!Z!_NtDO>*n`Skfxl)%G4MRqQ|ZT`C~zrNgV1uqqi*0mXOgqF and mirrored with some delay at . If you ever notice discrepancies between these, please make an issue. + +In January 2024 the mirror of the website switched from UCSC ITS hosting on AFS to a new AWS host administered by UCSC. We discussed how to mirror and struck an agreement in ticket [INC1792531](https://slughub.ucsc.edu/its?id=ticket&table=incident&sys_id=c418fd681b13f510e8c5eb93604bcb70) that UCSC would run a cron-job on their server to mirror the site. If there's ever a discrepancy betwen those two URLs, we need to ask someone at UCSC to take a look at the cron-job. + ## Making changes to the public site Change the public website in three steps! 1. Change the markdown files and commit your changes to the `main` branch. +1. Push your changes back to the repository. No pull request is necessary. If you prefer to use a pull request, please notify someone in the casl-group mailing list. * Any changes made to the `main` branch will be reflected in the public site after CI/CD runs. -1. Push your changes back to the repository. -1. Check the build status of your commit results in a :heavy_check_mark: build status and not a :x: build status! + * The `public` branch of this repo may be viewed at . +1. Check that your commit results in a :heavy_check_mark: build status and not a :x: build status! ![](.build-status-example.png) * You can find the build status for your commit - on the [commit log](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/commits/main) + at the top of the [repo page](https://github.com/lsd-ucsc/lsd-ucsc.github.io) + or on the [commit log](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/commits/main) or find details of the run on the [workflows](https://github.com/lsd-ucsc/lsd-ucsc.github.io-source/actions) page. - * If you're unsure of whether your changes will build, then push to a new branch and make a pull request! + * If you're unsure of whether your changes will build, then push to a new branch and make a pull request (please notify someone in the casl-group mailing list to check your pull request). +1. Your changes will appear at when the build status is a :heavy_check_mark: and will be mirrored at after approximately one hour. You don't need to install hugo because the public site has CI/CD set up. To see how to [build the site locally](#building-the-site-locally), click or scroll to the bottom. +## Content Mangement + +Most of the content is stored under `/content/home`. + +- **about.md**: Content for the About widget on the home page. +- **news.md**: Latest news about the group. To add a new news item, use the + format from the other items. Since the `[[news]]` list is ordered, make sure + that the item is added to the top. +- **faculty.md**, **students.md**, **alumni.md**...: Content for various groups + of members. + ### Adding news items Edit the [news file][news] using one of the formats. @@ -47,18 +65,7 @@ where `` is of the form `2020fa`. Next, edit the file generated in `content/lsd-seminar/.md` and update the link in `config.toml` for `lsd-seminar` to point to the latest webpage. -### Content Mangement - -Most of the content is stored under `/content/home`. - -- **about.md**: Content for the About widget on the home page. -- **news.md**: Latest news about the group. To add a new news item, use the - format from the other items. Since the `[[news]]` list is ordered, make sure - that the item is added to the top. -- **faculty.md**, **students.md**, **alumni.md**...: Content for various groups - of members. - -### Styling +## Styling The styling templates are stored under `layouts/`. Hugo uses a priority-based override method for determining which template to use. By default, it uses @@ -79,7 +86,7 @@ The website is generated by the [Hugo][hugo] website generator and uses the ``` git clone --recurse-submodules git@github.com:lsd-ucsc/lsd-ucsc.github.io-source.git ``` -2. Install [Go][go] (ver >= 0.49.2) and [Hugo][hugo] (ver >= 1.11 && ver <= 49.2). **Note**: The website will not build with newer versions of Hugo. +2. Install [Go][go] (`ver >= 0.49.2`) and [Hugo][hugo] (`ver >= 1.11 && ver <= 49.2`). **Note**: The website will not build with newer versions of Hugo. 3. Run `hugo server -w` to generate and serve the website locally.