From 9cb561d86a54e5bc97925b7d79ab4d1c385a7b04 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 1 Apr 2025 14:36:05 +0200 Subject: [PATCH 1/4] Add 'archive' layout --- docs/_docset.yml | 1 + docs/testing/archive.md | 6 + src/Elastic.Markdown/Assets/styles.css | 5 - src/Elastic.Markdown/Assets/theme.css | 2 +- .../Myst/FrontMatter/FrontMatterParser.cs | 3 +- .../Slices/Layout/_Archive.cshtml | 331 ++++++++++++++++++ src/Elastic.Markdown/Slices/_Layout.cshtml | 3 + src/Elastic.Markdown/_static/delorean-bg.png | Bin 0 -> 1409 bytes src/Elastic.Markdown/_static/delorean.png | Bin 0 -> 4854 bytes 9 files changed, 344 insertions(+), 7 deletions(-) create mode 100644 docs/testing/archive.md create mode 100644 src/Elastic.Markdown/Slices/Layout/_Archive.cshtml create mode 100644 src/Elastic.Markdown/_static/delorean-bg.png create mode 100644 src/Elastic.Markdown/_static/delorean.png diff --git a/docs/_docset.yml b/docs/_docset.yml index 5f0cdbef8..3056136f3 100644 --- a/docs/_docset.yml +++ b/docs/_docset.yml @@ -107,6 +107,7 @@ toc: - folder: nested - file: cross-links.md - file: custom-highlighters.md + - file: archive.md - folder: mover children: - file: first-page.md diff --git a/docs/testing/archive.md b/docs/testing/archive.md new file mode 100644 index 000000000..de432b95a --- /dev/null +++ b/docs/testing/archive.md @@ -0,0 +1,6 @@ +--- +layout: archive +description: Browse the archived documentation for older Elastic product releases. Archived documentation is unmaintained and may be out-of-date. +--- + +# Archive diff --git a/src/Elastic.Markdown/Assets/styles.css b/src/Elastic.Markdown/Assets/styles.css index 3f8e97cdb..12b7a0c48 100644 --- a/src/Elastic.Markdown/Assets/styles.css +++ b/src/Elastic.Markdown/Assets/styles.css @@ -187,11 +187,6 @@ min-height: var(--offset-top); } -html, -body { - height: 100%; -} - body { display: grid; grid-template-rows: auto auto 1fr auto; diff --git a/src/Elastic.Markdown/Assets/theme.css b/src/Elastic.Markdown/Assets/theme.css index 969f072c1..f41837d23 100644 --- a/src/Elastic.Markdown/Assets/theme.css +++ b/src/Elastic.Markdown/Assets/theme.css @@ -1,5 +1,5 @@ @theme { - --breakpoint-sm: 40rem; + --breakpoint-sm: 640px; --breakpoint-md: 768px; --breakpoint-lg: 1280px; --breakpoint-xl: 1920px; diff --git a/src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs b/src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs index 65457a013..669f35a5b 100644 --- a/src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs +++ b/src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs @@ -10,7 +10,8 @@ namespace Elastic.Markdown.Myst.FrontMatter; public enum LayoutName { [EnumMember(Value = "landing-page")] LandingPage, - [EnumMember(Value = "not-found")] NotFound + [EnumMember(Value = "not-found")] NotFound, + [EnumMember(Value = "archive")] Archive } [YamlSerializable] diff --git a/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml b/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml new file mode 100644 index 000000000..f8214ab71 --- /dev/null +++ b/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml @@ -0,0 +1,331 @@ +@inherits RazorSlice + +
+
+

Documentation archive

+

+ Browse the archived documentation for older Elastic product releases.
Archived documentation is + unmaintained and may be out-of-date. +

+
+
+
+ +
+
+
+
+ +
+

Observability

+ +
+
+

Security

+ +
+ + + + + + +
+ +
+ +
diff --git a/src/Elastic.Markdown/Slices/_Layout.cshtml b/src/Elastic.Markdown/Slices/_Layout.cshtml index f1f2d9e73..0222f2fa7 100644 --- a/src/Elastic.Markdown/Slices/_Layout.cshtml +++ b/src/Elastic.Markdown/Slices/_Layout.cshtml @@ -47,6 +47,9 @@ case LayoutName.LandingPage: await RenderPartialAsync(_LandingPage.Create(Model)); break; + case LayoutName.Archive: + await RenderPartialAsync(_Archive.Create(Model)); + break; default: await DefaultLayout(); break; diff --git a/src/Elastic.Markdown/_static/delorean-bg.png b/src/Elastic.Markdown/_static/delorean-bg.png new file mode 100644 index 0000000000000000000000000000000000000000..2a3567aff3f26151a21964a8fbb0e2c8a7f6e860 GIT binary patch literal 1409 zcmeAS@N?(olHy`uVBq!ia0y~yU|j%YPv>9*l8>MNsRB}*1s;*b3=G`DAk4@xYmNj^ zkg+((-HBn{IhmJ04okYDuOkD)#(wTUiL5{)#5`RbLn;{G-rDHP>?q=TG17(cT%nh2 z--=m59h!`a6Ll6bsMK!>Zz%P%Il1S+L6z_bcW2ACFN zG6B<^j8Y)Fp@o4LL_0V&fE>!8pyhaX@5rTcBx#_K(M)83dSua~Sod*gNbn=;$zn-98q;X>KR z;*7WNnqL1`_Ws|~tk_e3lJ#7DSjO2oniB?jDKP(-s`GQxci|eKbmZyk=d#Wzp$P!A C2g~{Z literal 0 HcmV?d00001 diff --git a/src/Elastic.Markdown/_static/delorean.png b/src/Elastic.Markdown/_static/delorean.png new file mode 100644 index 0000000000000000000000000000000000000000..17a6f9f17aef5c49fa27987f7e1b2b6cd6180e5c GIT binary patch literal 4854 zcmZ8lcQ71U7vHsE)eRAykmx14tP+Iiy#>)rq68~ZmL$3mz4um0&-wk%IgxrgsuZM*qyPYbLS0SC00028U9VxpMAzf{ z4;Y^7iR7i)Q%?YZjQXz*1Z3sVUkibr2C9mH8VvLL_2!17g0=zxP#;frVM_=A+=^CL zQZVubZs+>Hyp8im2lBJ{bg0>h+*48O4z{kdxOF%-Bl+NG-79n`HGw+!y4OYs_l|tI zqt@(1X3U&viO#IA=pE5z`PmQDLy_5%;~exdlyg+Sy5R!UhqNhdj}vs*tX#>NlZ2DL zIX8T4@c#2~gr&X3r{&LD$*!Zy*u`<)_qp$L`1QQqODl3d_TjSuBGD=Y3z(rFv`;AA9)-0C4LD0s)Qxx%;p1rzUd(mNGJ-lp|J0*tp+*ls=Yy>#**#+|6hMGID#D z4w<$@06_hMOi7$aYx&Ml3MSN6n-lPeRI3L7m<<9E0G!zENgXh8Rh-eZQq{lz1Rio$ zl-For-yZKEWY3RF!Sv$O3*miq#!_$M8?un+~bh)?Z__@q&3DBaCQ zd@!WBNvfs+ezf81@9(eiZEH=^p{pL}69;?;3Jq=UmVFdw>TE0NI5Gbqbg8+U`Hv`< zxQJ7D$X$0}!t?%)z}Gx-c(Fevai_z_EWgpJAMeLT=FdyS0}AeO79UXT!p9p9%W3mc z!W1!(Xc0d0@x^zT_|_yfNirUrV+HZf% z+dk6#MD7Y!q~16O#dGJr`3YSiP6|eI)IiE+r(i~^Jf z)ESusVln7#dS96u2+w=Blw?pvTy6;i^%!I=$Ia2^n|+ZpXYttg3T8G2Ux5%_`hT42 z#DsbljQq^BdT45;okKzN{V{>j$*VWD2Md#eB&g4JOI4ZTW+FA2Dkc?(k}ai|iv1ZR zo#`Cy9(z$2Z@g)qkP_}@gpVvRbzS!4^2$ujYi(cQW5gXgBxLEyoID@t;uizI@E_tZ zh3zI)JiaoUJLZ;k4K~`E6HPPaD9#nyXkGjUx44=5jJzu0`EWFKq?L1G|NP#T@fW!T z?0xJLvKqwatHYAE_1w@DK^3U*GZ&S|A+Tp0p_){SrVciwME@Yk-)L~-^2l6%fmhJC ze05SeaAQpk%Y1>LW#iY7GlmF!#KS9c1GEQg%K733=8!He&jMfd(wuocH?xlTn)%pL zK0zYF`$s^|hg@~AGK{sNF>ve_V|2A;zBy;L*tawDB144pLov7Y`;AIc>6YFN9PPMP z|4x#6ox(ptdcKuaOifz>+PCo9&)ZXzxickVq3Y8IIdo=DgXKPk$MyEPzc*QAO1Ask zeX2PMVgXNYQ_*P=544GcnWIJrO5f$)RAr`PI`ZWLgV*hY3sd}^r_ftu7CTyvC87!r z%J-h{LRW<1BlUz)d2Oy8pLDk-5b*RAkxzrkNR4xn`xKJ0zeWs00rB%g`{ugw| zcM{URM$D@NIa_P#%W%$FviA=dd8D?5-0N|g>m&A2cqug9aC$$7;<31P!X571_D2qH z%_^Uj7ZmezRT~=0gc60>>r7}BNuR5()O=uJQaY~|l2c2M8=TXR%#V3M%|jX-c=hXt zESsR3vC{7z;C<_6Ez-;7=3y8_P20w;V?Uf6JTdb-;u&keR(ldC>#6N%u>#6;_VQA_ z8B|o+3*GyP&PzzM%$%@(5Y}|2>$r2(=oanw>e0rzIP6S%^0n6^G5NRd2dXP6qFnnW zRfs3v@bRkLYTj(Z4Yv`z7Ngh~+VZb5X&+oKPZ)Va5z6dNI;EQ7F6X-r1j;}|;eSx> zZ$9}X%w*iEuAJe;j*0vOY>6v*Qi_c=g{t&*eZpG#ZHu{y>Idl*G{C-0_DL4e3ke3MM*1A)rNeg zEr!$)(Lk4oYo5}?qBuY;tg;&SM=i&Y?Z=%Pt(bK>Yn_d#d$9aW>oT;3z{Dn+cBm*m z@bEI}hSL($U;O(ohf=W(B`gIEsKJ$E^)kB;O}HxtilzqNHEuO4aUPK<$cEC8yr8j@ zCu%TKn{V-w(r!%>>|@P0=I^{i9wvGmhT9C|+L_YH&#Tw+&p*rbX4q`aO*hcDd~z{U z?E2Dvn57*q6}L_mVy2pL^rCWEdfK8x>u3<=^)}xk0}9O{#~k(gz0GB0t$i@_$yv?_nL+$5w}WZ`r$CDE)rTmk`7_>5Pd}8sKXa+-6Ghh0{pWv@6sLIWiQF z$(~E2r=}j_G%8G@O z+cA3bu3ulHfJax2dh6guBMrM1T2w|3Ud06Ic+;9 zy@^~cP^|4Kn(v>hPTp~;uJ%H9^W{hp-ZF3Oxoo=o9EVLUsbZ!)Nl47*Vh^DS5(P2p zF?1JRwe?;B_o)9SUr~fjYU60$Hwmd4?=bl6J);aihjVu`j!{$>jH}w@7G&~<-cCu6 zSv0kIv)do${7;@sj9_3w==_8fe&b`?dk2eT+T73{O4KVH^7-+@K#^D)Y1i*NM^JNh zaOLjPRlyHufaoEa6b%0h=z{sB-CYUNah&UP{9sSByk0xyW?zVxocfQ=!?nesb0LrJ z1-f#Z0%hBVfG}nqXpiaol%UKfAeO)HG=5ye!T+5`PxoTb3eOA>)no(-3+ejpGb@BxWsWY2hkj?JL8qjGmTo?c zeRp{z^pP8T6MyI(|P#%2lOlRJghk0mWw>L|e_ z4y~SgALuir7?(p%dZ+H*u%?jMtE0zNiA`}5#xK;nQu*U6ksvca+>fz+YR8(kSPMSs zokD*k2q_`h;(}j>TBp|w>AH6DFL&ZkVk)?F{Y=gFY=Kc_t;E3*&-=9Ho;?Q@P&@q< zbDtbgM0{jCPFow@+=rdIY%4#943iYR@F(xXsnP;sZ5eT7WvqfPD!p@F)e7Ttw^i-U~JA0$aUu3B3*<8)Er?BwiouvZWpaz}> zjHy+p+}ATTM_vM|XocoJX{anW6LUu?9DY>%7)YO8HXW}aXZZxVu5xXl{E`fl@-f=i zj+ESbXomOQ#W2Mx5w~I?%13 z2)m`^de`$2jOu*)f`FTCl>UC5(&Q$dy0-Z7B zPdl7cw@ntl%^gmmzZ*gG8R%a^;s$4ISXK5Qx7zx`&LCucK*Dhtz3)3L%{zH&{Q4(~ zJ2~qs@kPSp35JGsDT{AAu~VRxu(UPUwD*Lk9#RpWwvRti=O`ussF3_i)cS2%--u+{ zR=XG*g9Th?{OiT$JPHe_>e{)btye+XSnq|-bM9EuZ&O>;}fIen1K zw|}98Iz>5F<0-i3@uDu8u^PRFZ9*t72*Ca(glM>fb_K%chaaYlnylX$qe@2DxJDoO z(LS(B7f6HlV*iXdc0lQtsY6Mn0N%f8%UMAXH8%`e;mM181%sRJ%^HWVyqU1l&SiUG z|36V)h_QuRL7}T71KAZ z5kvCcGOv|81yR&5;^m*P=Ia`ZYuUQS=10is5*7(jj^2aGwgvlzvujQ2Ffs$UNJCKF zA-3@!Jn{-Iey+XcRxC`wRlMtzy77=UvFTWrzZYy&2kQMdNgtG>6JW*U$>UI(@3ORr zAJyy25VnuX5J~68Xo4H@sk8((;yq_ezFQXm$sqqO%M|K@NMCY4Db54{R@HK%y7Pe) W+7g?7UwJhF*G*knN2x~9CggvDye4x1 literal 0 HcmV?d00001 From bff92b04e115ab2115c41ab1b4f75741de8aca18 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 1 Apr 2025 14:38:50 +0200 Subject: [PATCH 2/4] Fix link --- src/Elastic.Markdown/Slices/Layout/_Archive.cshtml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml b/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml index f8214ab71..2978d25b2 100644 --- a/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml +++ b/src/Elastic.Markdown/Slices/Layout/_Archive.cshtml @@ -320,7 +320,7 @@
- + Go to current documentation From a1080b9e786800d7f96f6aec48d6b2a235fda002 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 1 Apr 2025 14:43:15 +0200 Subject: [PATCH 3/4] Hidden landing page and archive --- docs/_docset.yml | 3 ++- docs/testing/landing-page.md | 5 +++++ 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 docs/testing/landing-page.md diff --git a/docs/_docset.yml b/docs/_docset.yml index 3056136f3..46fee7df3 100644 --- a/docs/_docset.yml +++ b/docs/_docset.yml @@ -107,7 +107,8 @@ toc: - folder: nested - file: cross-links.md - file: custom-highlighters.md - - file: archive.md + - hidden: archive.md + - hidden: landing-page.md - folder: mover children: - file: first-page.md diff --git a/docs/testing/landing-page.md b/docs/testing/landing-page.md new file mode 100644 index 000000000..de3202894 --- /dev/null +++ b/docs/testing/landing-page.md @@ -0,0 +1,5 @@ +--- +layout: "landing-page" +--- + +# Landing Page From 6a73a0300707aaaaa9947852e9a115607298c427 Mon Sep 17 00:00:00 2001 From: Jan Calanog Date: Tue, 1 Apr 2025 17:03:09 +0200 Subject: [PATCH 4/4] Add link to archive in landing page --- .../Slices/Layout/_LandingPage.cshtml | 46 +++++++++++++------ 1 file changed, 31 insertions(+), 15 deletions(-) diff --git a/src/Elastic.Markdown/Slices/Layout/_LandingPage.cshtml b/src/Elastic.Markdown/Slices/Layout/_LandingPage.cshtml index 42436a719..ad3b5cc34 100644 --- a/src/Elastic.Markdown/Slices/Layout/_LandingPage.cshtml +++ b/src/Elastic.Markdown/Slices/Layout/_LandingPage.cshtml @@ -178,23 +178,23 @@

Browse the client libraries for Elasticsearch.

- + Explore all @@ -208,23 +208,23 @@

Browse the query language documentation.

- + Explore all @@ -238,23 +238,23 @@

Browse the agents for Elastic APM.

-
+

Releases

Explore the latest features and changes in Elastic.

@@ -322,10 +322,10 @@

Contribute and extend

Learn how to contribute to Elastic products and extend Elastic capabilities.

+
+

Archive

+

Browse the archived documentation for older Elastic product releases.

+ +