From e749ed0d04efb5a879dfbb56d2e2fa5878060748 Mon Sep 17 00:00:00 2001 From: Janette Day Date: Mon, 30 Oct 2023 16:13:33 -0500 Subject: [PATCH] Add custom footer to docs (#36) --- .gitignore | 4 ++++ commands/doxygen/dkan-docs | 14 -------------- docs/_config.yml | 5 +++++ docs/_includes/custom-head.html | 2 ++ docs/_includes/footer.html | 12 ++++++++++++ docs/_includes/head.html | 14 ++++++++++++++ docs/_includes/social-icons/github.svg | 1 + docs/demo.md | 14 ++++---------- docs/favicon.ico | Bin 0 -> 15406 bytes docs/favicon.png | Bin 0 -> 5591 bytes docs/getting-started.md | 6 +----- docs/index.md | 8 +++++--- install.yaml | 1 - misc/settings.dkan-snippet.php.txt | 2 +- misc/settings.dkan.php | 2 +- 15 files changed, 50 insertions(+), 35 deletions(-) delete mode 100644 commands/doxygen/dkan-docs create mode 100644 docs/_includes/custom-head.html create mode 100644 docs/_includes/footer.html create mode 100644 docs/_includes/head.html create mode 100644 docs/_includes/social-icons/github.svg create mode 100644 docs/favicon.ico create mode 100644 docs/favicon.png diff --git a/.gitignore b/.gitignore index 6ca3c4e..5193c03 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,9 @@ .idea .vscode +docs/_site +docs/Gemfile +docs/Gemfile.lock + tests/bats tests/test_helper diff --git a/commands/doxygen/dkan-docs b/commands/doxygen/dkan-docs deleted file mode 100644 index 0a95997..0000000 --- a/commands/doxygen/dkan-docs +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash -#ddev-generated -## Description: Generate documentation for the DKAN module. -## -## Usage: dkan-docs [arguments] -## Flags: [] -## Example: "ddev dkan-docs" - -DOCS_PATH="modules/contrib/dkan" - -cd docroot/$DOCS_PATH -doxygen "$@" - -echo " * Documentation is now available at: $DDEV_PRIMARY_URL/$DOCS_PATH/docs/index.html" diff --git a/docs/_config.yml b/docs/_config.yml index 6c2e2bf..61f2ed0 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -4,6 +4,11 @@ header_pages: titles_from_headings: enabled: true strip_title: true +github_username: GetDKAN/ddev-dkan minima: social_links: - { platform: github, user_url: "https://github.com/getdkan/ddev-dkan" } +plugins: + - jekyll-seo-tag +sass: + quiet_deps: true diff --git a/docs/_includes/custom-head.html b/docs/_includes/custom-head.html new file mode 100644 index 0000000..6911eca --- /dev/null +++ b/docs/_includes/custom-head.html @@ -0,0 +1,2 @@ + + diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html new file mode 100644 index 0000000..377f45f --- /dev/null +++ b/docs/_includes/footer.html @@ -0,0 +1,12 @@ + diff --git a/docs/_includes/head.html b/docs/_includes/head.html new file mode 100644 index 0000000..d788985 --- /dev/null +++ b/docs/_includes/head.html @@ -0,0 +1,14 @@ + + + + + {%- seo -%} + + {%- feed_meta -%} + {%- if jekyll.environment == 'production' and site.google_analytics -%} + {%- include google-analytics.html -%} + {%- endif -%} + + {%- include custom-head.html -%} + + diff --git a/docs/_includes/social-icons/github.svg b/docs/_includes/social-icons/github.svg new file mode 100644 index 0000000..9301f84 --- /dev/null +++ b/docs/_includes/social-icons/github.svg @@ -0,0 +1 @@ + diff --git a/docs/demo.md b/docs/demo.md index 5029a5d..59da0a5 100644 --- a/docs/demo.md +++ b/docs/demo.md @@ -1,16 +1,10 @@ -# Run The DKAN Demo Site +# Build a DKAN demo site -Note: As of DDEV 1.19.5, these instructions require managing the settings.php -file. After DDEV 1.19.6 is released, this will (hopefully) not be required. +The following commands will create a Drupal site with DKAN enabled and a sample react frontend for you to test out. mkdir my-project && cd my-project ddev config --auto - ddev get getdkan/dkan-ddev-addon + ddev get https://github.com/GetDKAN/ddev-dkan/archive/refs/heads/main.tar.gz ddev restart - ddev composer create getdkan/recommended-project:@dev -y - # At this point, we must add a configuration to settings.php - # This should change after DDev 1.19.6 is released. - cat .ddev/misc/settings.dkan-snippet.php.txt >> docroot/sites/default/settings.php - cp .ddev/misc/settings.dkan.php docroot/sites/default/settings.dkan.php - ddev dkan-demo + ddev launch diff --git a/docs/favicon.ico b/docs/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8014e87f9ade5a102c5a9fe3999f1343abb5e64b GIT binary patch literal 15406 zcmeHN3viUx6<*YiR-sZKE!qbt)Ay4o-2Lz4 zobP`3+_QJjxdy`s!_9`#qYWs>8Q!?XV3=w!7{-lL-Y0z9V2DKBlqp^94;u_g_Zkcn z&<8^>La9gL^^@|^9mG$1@B}h%o$B++*gRQlOW!m}`>v0_gKWEJQCwc1#b;Jh zdCD%z**Aw=7dKGJ#XzddyFfMeQ{;?YNTu-`DHA-GCTbrQ-9esN{k_m7uK4zewquU=LxBk~!QD zb*m{idLHV2OpecAr_zLtl=JEDW&Gupx0CwVK7JN*KEn75TAkXKwCq-~GoEkS`mr*W z?Ja(hL3>QWlPM?qRVt2KuhnVoi%0Z3UhCUUrdFqq_sXAFr!a_0_A}$~Jc)<>ldq5J zC)CpDf4^n}efgcf+DyR{d&w{bJxrOQzvxx3>Qzf!zs`SOwl$D8-Tw6b*V9f0;(ts* z4^mn3HvAT+q70*gWB;V`bKgx@JlM0S668~k{{ifP7s}fCG|mkXlojzLv3_&dbYOI0p)v^G#p?nyaobb30dv!hKp zS2)g5GujzTb@nmhHv9fp@VmZ-Iy*h+Z>ZJl8$DNP!?~xSC|T2A=R5~|4su-x6d9$7q3Ab_+8ZjUvBZdT(sUWe zy86>!cw$K}{T0Stx|8l$h6@>c`7sZk;mOi=^H1C&Q6b8=H|K-jP~)U{|R-pH4*ny$C$%s z0J9tCy+E?ZydwPP9eR_D{`cXm_Ogsu?TFVv<)6=VtgF5-fpR~aOGT$Ykaw<2U2_-C zg@?o@WW6zGZs)O;>7N33I~AW@34MQ(@x126XID`6p65ir$c%o8YI2T?e*6AcHNI5+ zT-syiQ(Jwh@Z3~xkvU(l-y%ATAiE~}sC+jD+(%ckJ_ptov0Xlc))yvW4s-B(KZTkr zv#C6FCwOWUeyhv}WbJy|pN3=go#65T$R3F^`3B+O+WZy$T3=vRzZ?C>Q0m%yqLLTd$&@R`Jnvg>8rommayceUi=S5e@4huDmb}Z{&U!N zzW|$ht@r;AFSv(GzdE16mb(7oS^vTEuJ+gY*ZF6E)ARA>e^r|q&hkdGKVNZy|Cf4> zlORNESb%3RaT3k8R(*>yLaxPN)pNygmKh;a$kaz1ICIO-aUJ;n<-y zYBplE+o&ot2J!X9$caBo_Rr=^?AjLfTk)%w?N5;7!0Tk)HB0lemarMfm%oO5_a7uj z&-3E^JI7c{;sOw_ia`u?mE`JeAOBAJa;{wZA%5>boI3lH7x3;!>iL;-{q_S3C};0W znoO0ip64FUxmTp_keDaOyZQ0B+o%z_gSL8?#4XF@E`cB7?Mo#7$#(@r9%9tR=hw;D zdfZR2A|Jr>;ka^JLz&1DnTYYXROeA+X{N}NID6QyM4qR;MdJNgJD%3?=j@wH?$$bq zzjAC`#m;4S{Hd!)%UuDE8#Cr=+fgb!y#n_mc2av|MVEe$+<9P57#GKs>+<78Cf|o> zYpg^+4_&bwBwimU@*^AzXWUI?W|^N0cPd)0IHVufH&?TY=t z1{#pVV2qse;Q6S!ZBfr5hMlAI?-&0<>Bn>K3%@n;H^RHSr5<-TCSLddF>A+D;K>R( zz45nH=Oc!H0&N}CTIZ6y4&%&19?H$}b>s^2j=ZB`mpQ=JDvXg5)9;`Ef#J{HKTnxw zO#yNfcVCB}_ftLRjlAF&n?}96r4~5f)o|wQog?@-ZI z@_fdC`?0@AQ4038Gxo34-h4&)FNs@2DXZ?J!c$8{Uvq^Gdk$*@zry#TEIS@o#-R`2 zh2r(8ahwJp6O?+$G>7?V`=!xk#CqRD1z#=_dF}84)~K22J5ufr@g1qF%n$az>buo7 z?CF18@jka;%zsJTYTzG*J-tNq)!0vh+ezZz#GhbaTEeG8 zzjD{h-CB>id9Yt?RCYOxD$=5;wWd(GV1J|FzYG5JUm}lX@LnxV+)S0GJ(0?{*dJ{H=OgWb)1phDCYoEkRNm4o*3_;CisbF*b4h_*;~j@a{i9}b9e0C@H39I zfbWr$?~UPpT3PZ|%0K!x)_W?}+a&tE@vrj0{Tv4uVBLS9ag)0CZv3V`Peo@}V()}t z-QJV+F$Fz@dw27&7bZ(z$QaaGJo90 zdBDcfw0`k>m4oq0{Yc@N?V8_{m*3_yr>FKe1&!~;`GE0jdWQ?YIuE7nA3tm%@Q3hC zLx>-C!_Hg`5C6lDpYJ&i@2c_JI}jN?`y~GR8DgDeAKiX>+QeYqb^FonXE65Cv#)MHH@5xY NdXWCn85lAH{{fGMI2!-} literal 0 HcmV?d00001 diff --git a/docs/favicon.png b/docs/favicon.png new file mode 100644 index 0000000000000000000000000000000000000000..0923e61f6c6885cb7fa1dae396dd1ce48483a5f8 GIT binary patch literal 5591 zcmd^@RZtrYvxfO7v{;K2r$riyJE2$u6u02+1cC>*U}>R9aCbt1;$A#OJ|whAao6H* z#r^NO`>)UCITyP-^X}E|yfZudAT`t!o)gd#U}0fBS5lPK`dfegPvBwy&2Pj+`>?Pm zP)f2NbbPb-bKsujKXR_VqqnwOcm*b0tQopjimup=FKd`yHIn|uq|-6sFR~_XPGv7PsMFFB+M{j# zY?R5?Z?Clr4oi2hJ$1b%o7%Yx+RtC$s!9OGaCfRp8f(_o)RM%7j)#dNa7q5@!H&R! z{3DB1i}mKC0T!tg*GD`?N+}!?LPqTWbM0?P9x1N%Gt=w2NY%-ccSo~4452T@*tB`g zaJdnti`05I zf#n~Pz`$^L)g*I3o|~SC^$)c}XTeL;Fm(eRo0;?9$tG>VTkvRpxs^9B{e3drh7133 ziI0Ngb$_WWk3_YJo2zO2Qj5k=rqOa4UAGU!x>bLe(_o_+Gq==z>7>UpNH_pPa zw#6n#%v;mTy|aLt7HUTkbZBEVa{^!GGF#-5iuzyMY}I%l8j(1Tr>zsw9eiu=Y#%>j zHjfPXkQ^*e@KnxMm5ulx(psPZP}sPxSymFDkW`RVz5y(XXYH9jf6+d^y14w??o?he z;E1`CQGxJ}r%))Gou)#UvzU}X{z}jGSZC|EByEn@$sdjQ0x3>&O=onSqA{veZ-7ly z=2qGyjn%zq;L@yAZgk^jw)XkM3RWB>DDX zt{Uze`1AYDkeI3tGuo>fTi5+d9cXDW8i%n$dn-Hj- zXQSol?04gYG&k2+U<*t6EUDP&<}3mOFO-azJy-Yy z9L`a^=OUNm9-M5iuL4egS#O@16_@YiQ)TM{-8XG6qjusRHV6f|I*hbwPhG<-Qy(s* zVc{py&U5LrAv%5VpzX^7`y1IP$NM2a1r6zr zN=S*zl(male1Wb2QYW`4y#Ce;wl)52PT?U?CS?cXb+G~ze@|w zbS%f&^OpzsRMXd{ABHyol}p=_Ts$N9&VdVu*Bdqf~81T3= z)+*^-W4lMj5l9}pMlE~4-kvYH=u$moq0K8#7Em>JmKM(8NszhLY*$1ZyJoYshcb%K z`AtJ27g#2Bd9%fdGE6Q{)Wp}z-GaxiwF9TUS5+p<_rtasifz9cr&76hTSON;)>SNA z?b<3&e47z>DHogp(Qyh+=FYroE1TD&oSpbaL{SHIJLJse7Az$j0~zs&f?+6I|BJ)c zT38md7KKV!Nt&eTpN-5{If<10d5qp7VD2V5Z-ldQi(BiZ=YoF4d^=iJXj8bGx*7#h zK4#7>f7jMh>#l}+heTUNa|+C)Njf6#8i_LVgM!R0d(&H`-w#(;4W;KYh{J}$N;hl6 zEuvKh_oug@Z8iDZ<%AwdSEhWu0|&ha<&hJA*3T7{Dg+8v8RB%N$al$HN_vC&ho<_L z{OTPHkrF9gijXzW0Z!s%LQ~-+<*GR0t7N9#+IfK>PZ!PlPfBQJqEJL*neQH`W!%Xj z?^K7New!j=*N#|%Ao|3ru1-&tpXL5Lk&=rpEHfu%VWl+kysLk8{+m##$<$uDfz83h zpbic=TemO_VQ$FfF8owvX&BRYThrcucehIxBJkV_fABQR!99Nm&nllvv8$JWLEwxl z6H?0eFsM_vn7z*Swr?*#A&*L*ikmGmC(D6+TmJI{ETF>A7rk+LIS*B=nZe7Oqx3PT zHxsNVJL2tAsreT<0kY}#$Z^fw%p|*Gssa>@`cQ7LWmuDg-O(!#4g+EH6>imB-9(EH zJctr|#%%&wYT8-P{`VolDS`~FA+PkOQfY!3zZooW$d1oD_{*v#mO?Iqf+CeD0169i z`I8LCxc-4MaYeK=DTVqRP*qPSly7ZIG6s^K#|xuB_G#{ZHC(>oi41M9OJ423?rrWb zs;n=Q*r!dtiRp`gY6+-M&Gb}C;|YldSDS82x=seR_>9o37O3AVXMQV#P8#ms?)MJs z*iz3}hu!s^6lTy!wl--jl-)f1+p%wd^F?7_OhR(H&v_7{rzt2$nC*Wn!34v@$BM86pjQcfS-M*5EF(e3_Bm^ zA{Y&FM1w(UkU$sBSWpN>3mXv3VCU*Q=g}}NY1GcB-T(){%r4vIFNx#oj~4hgVq24Y zAMpQ#mZny6M#j5lkV=1eA^Gk5%DzzT&WF0-hps_Y((=euR8!7M{sAXx&}9c#WI$$V0{hpv<+o8@KFALx=kj>39XvrEUu1SgI}pu*|K>hG z?di3%Y@nbHwCqCJS|v)o&9`=m^btzwL$M?0{IQeo@%Io~uq{X_G~oR1-`H^w^I>@s zY^e@edDHMcIL$9W8miG}U#I*hUMbVSki*8W(dgI&cz<_t7=NaaK5*aZ^4KQ#RY(mx z+O5j$WMM48tz2v|FWlTw)s_3MO1kYQ_`FGMi|)B|>BgDI6;jwZ^W}&U8BurZbf%r9 zi0W&{bG$$fTe~`CcNeyUrq-sxFQf+2(s-|7p093w541TD=zWoK8mkyligh9~B}_Dl z*vN0AvoXvNj#$)oO4(p!j-!NMqyCU0{fa!&!eP4Q;cQ8tTrOuX<(SQsq<$8 z|C2a1^@z1v4ZS<&BE`4qKLzZJQsuYDz4c4pHLz?2G+7Aen&rbLU;5L6nDEuDy$Q=n z%%o@i`$&~6X-~@lBO5P@YHuuKJrrpg(N7X|`XwpxAvEOmU{;aEg&77_w~agu4Q+0p zR%Ve8YVWj{@C%)s{Zr1fItAZ5XO%>&k8Gdt9=-qy1*378*70QnEb%F#Es~f1b;F0) zlM``L?F*qnr7t93KSZ#S(1*)MtuC#Xs@P!LN>pqP4m1fLS*`E-8N&w%Y$-dry8E>bASrV~TQ( zw53K$Mzceqn%hraopDxc+lFxRA#H}vi(o|jtm9*Ba{kG%5hTXuZYk6SKaSfM_M7# zzshv1q9}-97ULbS!PX;TY^_jur|Js(a)QWH-0vI>uijGC1IfydjnAFsnIkp`-IhpL z&%~jH0jAMhRvP&20eprUd~XakR~S{#CURPkz^0roE5^#;+Cr22$U)?+rZgTtq(vqm zOWQT5v8RheYwyMB^ZqjlGRWs3uh!dyMg8w>khN8^q}46XD54VjJyJ%2m;tFdoL@Uzq9e!UWD|;U^qD=@>I--&$7pj(W zMG6~g)ISG}Z2N8K5L40zdc10C>~HOICUNVgiSQ(-(6x$=`sI|O>-v_TN9cNIHc0>; z&(hV&k_KQD2{MNW4-YB*!JK%wH)zA~pXVnr4z8JJZkUZ2WVCE$H_R&}6L z?7@^j+=~p-()yv3A$;rFHf>WKt7rjS!?>PJ`j ziZ-E>+mk{=n)?ONHJx)^?AGVo+~Lck@2e#2lD$`T>O@B15V$l=72ieO=W$lJz8Is}Cy<({9z*IYY)(t&Ay-N@# zUtvOHSkyB(#5=;xD-11p3I3eO!zTw5U9hx>eT^K-0uVUB zcfR&8Z7Kz6LKW@SB4-HK=NUc)p)`^J+XU_ew1y4e$OOwZ`wRSCS=VXAdsbjS&=1ES zP1h0B1PIuNi@(3`%yE*LNeDj8@~S1P0OwP)<#i2Z4#ow(yLq<{mFda~S`?aui13v@ z!~H6s2)Pz*g`4kwz-9oC|BAH^ZkJn)y}8f!eRX+wdjD(}^YoA9 z3RZ0sUACm?7>`i9C`&h-2V04nHIb`_syCY)3Fzwkz*n^Jp%3h&3=tBS88B-JsOe1E zH8YcS@vrvyF>Bo@^;ecwm~4di@K*8;A}$XaRi<&Qg5w$ps$$&JZ%#u$<+hLa@u_k& zQG&;9(NA*&znik$(>99ANSgrynOVxtLihH;$_(zQW{d zf2Kwo=H$5?IR>3OA!LE6dThbB22sVeh_fa3&l+`rt1XXvWb(?jkNC466+D2?v^P(x z&FM)bFDjo-7j*ywW`xpB7C}r8X$_|8FJdl468LmFq`F(Gmq_a{`>x^M+2E2x0DNui z-x*_arn5^iTPZ&~-U5TW<_RnLmAKykZdB7=j?a3DM+}muXRQ10@xB~vPfcAp8(kvl zXdL@Wy;RLFAW7ZLm*yYHn|l~FyK@b=d+?jik@Jg^Ck4e@rjz_YY*nVd)0fs<2etn! z^*#bY<@HWRL+HEtNL2%E5snJj#?0upmHYFdPDWH}rOn1kl8q_vdf&TY{fl?GPM3eu z|Ab$Y736bi3zi*@-t|AawX)g}1e=+Et(xv=?qN&|On%Pcr;Bi{0W%ji@(vQeh=R1a zo$Nwf7`1=t*x0+US%3H08y#YPb2FYAE1rpR)y#7Shq^hpw@>6JkF(jN?n|Y+xZ^k) zgTkxPbgw@pK!=3c(vr6;=jgib=N9vX_p(}LYV>oPF)oHYNSx?c7^S}Cs@ zH*HUF6RC(c6UEp~_NTA(s=uYv>Zgcko!@U^Trkuo*Ucz3(sE$q