Skip to content

Add 'archive' layout #892

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Apr 1, 2025
Merged

Add 'archive' layout #892

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9cb561d
Add 'archive' layout
reakaleek Apr 1, 2025
bff92b0
Fix link
reakaleek Apr 1, 2025
a1080b9
Hidden landing page and archive
reakaleek Apr 1, 2025
6a73a03
Add link to archive in landing page
reakaleek Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/_docset.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,8 @@ toc:
- folder: nested
- file: cross-links.md
- file: custom-highlighters.md
- hidden: archive.md
- hidden: landing-page.md
- folder: mover
children:
- file: first-page.md
Expand Down
6 changes: 6 additions & 0 deletions docs/testing/archive.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/testing/landing-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
layout: "landing-page"
---

# Landing Page
5 changes: 0 additions & 5 deletions src/Elastic.Markdown/Assets/styles.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,11 +187,6 @@
min-height: var(--offset-top);
}

html,
body {
height: 100%;
}

body {
display: grid;
grid-template-rows: auto auto 1fr auto;
Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.Markdown/Assets/theme.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
@theme {
--breakpoint-sm: 40rem;
--breakpoint-sm: 640px;
--breakpoint-md: 768px;
--breakpoint-lg: 1280px;
--breakpoint-xl: 1920px;
Expand Down
3 changes: 2 additions & 1 deletion src/Elastic.Markdown/Myst/FrontMatter/FrontMatterParser.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
331 changes: 331 additions & 0 deletions src/Elastic.Markdown/Slices/Layout/_Archive.cshtml
View file
Open in desktop

Large diffs are not rendered by default.

46 changes: 31 additions & 15 deletions src/Elastic.Markdown/Slices/Layout/_LandingPage.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,23 +178,23 @@
<p class="grow mt-3">Browse the client libraries for Elasticsearch.</p>
<ul>
<li class="mt-3">
<a href="/docs/reference/elasticsearch/clients/java" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/elasticsearch/clients/java")" class="font-sans font-bold hover:underline hover:text-black">
Java
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/elasticsearch/clients/dotnet" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/elasticsearch/clients/dotnet")" class="font-sans font-bold hover:underline hover:text-black">
.NET
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/elasticsearch/clients/python" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/elasticsearch/clients/python")" class="font-sans font-bold hover:underline hover:text-black">
Python
</a>
</li>
</ul>
<div class="mt-6">
<a href="/docs/reference/elasticsearch-clients/" class="link">
<a href="@Model.Link("/reference/elasticsearch-clients/")" class="link">
Explore all
<svg class="link-arrow"
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
Expand All @@ -208,23 +208,23 @@
<p class="grow mt-3">Browse the query language documentation.</p>
<ul>
<li class="mt-3">
<a href="docs/reference/query-languages/querydsl" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/query-languages/querydsl")" class="font-sans font-bold hover:underline hover:text-black">
Query DSL
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/query-languages/esql" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("reference/query-languages/esql")" class="font-sans font-bold hover:underline hover:text-black">
ES/QL
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/query-languages/kql" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/query-languages/kql")" class="font-sans font-bold hover:underline hover:text-black">
KQL
</a>
</li>
</ul>
<div class="mt-6">
<a href="/docs/reference/query-languages/" class="link">
<a href="@Model.Link("/reference/query-languages/")" class="link">
Explore all
<svg class="link-arrow"
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
Expand All @@ -238,23 +238,23 @@
<p class="grow mt-3">Browse the agents for Elastic APM.</p>
<ul>
<li class="mt-3">
<a href="/docs/reference/apm/agents/rum-js" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/apm/agents/rum-js")" class="font-sans font-bold hover:underline hover:text-black">
RUM JavaScript
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/apm/agents/java" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/apm/agents/java")" class="font-sans font-bold hover:underline hover:text-black">
Java
</a>
</li>
<li class="mt-3">
<a href="/docs/reference/apm/agents/dotnet" class="font-sans font-bold hover:underline hover:text-black">
<a href="@Model.Link("/reference/apm/agents/dotnet")" class="font-sans font-bold hover:underline hover:text-black">
.NET
</a>
</li>
</ul>
<div class="mt-6">
<a href="/docs/reference/apm-agents/" class="link">
<a href="@Model.Link("/reference/apm-agents/")" class="link">
Explore all
<svg class="link-arrow"
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
Expand Down Expand Up @@ -285,7 +285,7 @@
</a>
</h2>
</div>
<div class="grid md:grid-cols-2 lg:grid-cols-3 gap-6 mt-6">
<div class="grid md:grid-cols-2 lg:grid-cols-4 gap-6 mt-6">
<div class="flex flex-col rounded-xl bg-black text-white p-6">
<h3 class="font-sans font-bold text-2xl">Releases</h3>
<p class="grow mt-4">Explore the latest features and changes in Elastic.</p>
Expand Down Expand Up @@ -322,10 +322,10 @@
<h3 class="font-sans font-bold text-2xl">Contribute and extend</h3>
<p class="grow mt-4">Learn how to contribute to Elastic products and extend Elastic capabilities.</p>
<div class="mt-6 grid grid-cols-1 gap-6 text-center">
<a href="/docs/extend/kibana" class="grow select-none cursor-pointer text-white text-nowrap bg-blue-elastic hover:bg-blue-elastic-110 focus:ring-4 focus:ring-blue-elastic-50 font-semibold font-sans rounded-sm px-6 py-2 focus:outline-none h-10 flex items-center justify-center">
<a href="@Model.Link("extend/kibana")" class="grow select-none cursor-pointer text-white text-nowrap bg-blue-elastic hover:bg-blue-elastic-110 focus:ring-4 focus:ring-blue-elastic-50 font-semibold font-sans rounded-sm px-6 py-2 focus:outline-none h-10 flex items-center justify-center">
Start contributing
</a>
<a href="/docs/extend/" target="_blank" rel="noopener noreferrer" class="link text-white">
<a href="@Model.Link("extend")" target="_blank" rel="noopener noreferrer" class="link text-white">
Extend Elastic
<svg class="link-arrow"
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
Expand All @@ -334,6 +334,22 @@
</a>
</div>
</div>
<div class="flex flex-col rounded-xl bg-black text-white p-6">
<h3 class="font-sans font-bold text-2xl">Archive</h3>
<p class="grow mt-4">Browse the archived documentation for older Elastic product releases.</p>
<div class="mt-6 grid grid-cols-1 gap-6 text-center">
<a href="@Model.Link("/archive")" class="grow select-none cursor-pointer text-white text-nowrap bg-blue-elastic hover:bg-blue-elastic-110 focus:ring-4 focus:ring-blue-elastic-50 font-semibold font-sans rounded-sm px-6 py-2 focus:outline-none h-10 flex items-center justify-center">
View archived docs
</a>
<a href="https://www.elastic.co/support/eol" target="_blank" rel="noopener noreferrer" class="link text-white">
View version policy
<svg class="link-arrow"
xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor">
<path stroke-linecap="round" stroke-linejoin="round" d="M17.25 8.25 21 12m0 0-3.75 3.75M21 12H3"/>
</svg>
</a>
</div>
</div>
</div>
</div>
</section>
Expand Down
3 changes: 3 additions & 0 deletions src/Elastic.Markdown/Slices/_Layout.cshtml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Binary file added src/Elastic.Markdown/_static/delorean-bg.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/Elastic.Markdown/_static/delorean.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading