Skip to content

Refactor: make Elastic.Markdown a module of Elastic.Documentation.Site #1344

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 23 commits into from
Jun 5, 2025
Merged

Refactor: make Elastic.Markdown a module of Elastic.Documentation.Site #1344

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
ccd2a39
Move common site frontend to Elastic.Documentation.Site
Mpdreamz Jun 4, 2025
e9534e7
update navigation to be more generic, still lots of refactoring todo
Mpdreamz Jun 4, 2025
3cff00f
move web files over to Elastic.Documentation.Site
Mpdreamz Jun 4, 2025
266b2c1
fix navigation bug
Mpdreamz Jun 4, 2025
3052b68
Doubly nested layouts!
Mpdreamz Jun 4, 2025
5af5eda
Move markdown content partials back
Mpdreamz Jun 4, 2025
451a45c
move BuildContext to Elastic.Documentation.Configuration
Mpdreamz Jun 4, 2025
bf35dd1
Fix assembler build resolving of static files and navigation
Mpdreamz Jun 5, 2025
1b5713c
Add support for viewing API docs in serve
Mpdreamz Jun 5, 2025
5f45080
start on api navigation
Mpdreamz Jun 5, 2025
2b46a1a
remove INavigationGroup and normalize to IGroupNavigationItem
Mpdreamz Jun 5, 2025
1fc0473
rener API navigation
Mpdreamz Jun 5, 2025
b4481c8
finalize
Mpdreamz Jun 5, 2025
52f1c96
update package-lock.json location in worklfows
Mpdreamz Jun 5, 2025
51df321
change wd
Mpdreamz Jun 5, 2025
5e175f0
fix build error
Mpdreamz Jun 5, 2025
38a8b44
run npm lint
Mpdreamz Jun 5, 2025
5d26583
add api configuration to docset.yml
Mpdreamz Jun 5, 2025
a719d1a
temporarily use inline bootstrap
Mpdreamz Jun 5, 2025
190ce94
remove tailwind config comment
Mpdreamz Jun 5, 2025
16f5199
ignore tailwind config in eslint
Mpdreamz Jun 5, 2025
4cc7c58
fix leaving code exploration in
Mpdreamz Jun 5, 2025
6fd3122
Move classes out of Class1.cs :)
Mpdreamz Jun 5, 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: 1 addition & 1 deletion .github/actions/bootstrap/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ runs:
- uses: actions/setup-node@v4
with:
cache: npm
cache-dependency-path: src/Elastic.Markdown/package-lock.json
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
node-version-file: .nvmrc

4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,14 +39,14 @@ jobs:
runs-on: ubuntu-latest
defaults:
run:
working-directory: src/Elastic.Markdown
working-directory: src/Elastic.Documentation.Site
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
cache: npm
cache-dependency-path: src/Elastic.Markdown/package-lock.json
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
node-version-file: .nvmrc

- name: Install dependencies
Expand Down
15 changes: 10 additions & 5 deletions Directory.Packages.props
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@
<PackageVersion Include="AWSSDK.S3" Version="4.0.0.1" />
<PackageVersion Include="FakeItEasy" Version="8.3.0" />
<PackageVersion Include="Elastic.Ingest.Elasticsearch" Version="0.11.3" />
<PackageVersion Include="Microsoft.OpenApi" Version="2.0.0-preview9" />
<PackageVersion Include="System.Text.Json" Version="9.0.5" />
</ItemGroup>
<!-- Build -->
<ItemGroup>
Expand All @@ -40,7 +42,7 @@
<PackageVersion Include="Markdig" Version="0.41.1" />
<PackageVersion Include="NetEscapades.EnumGenerators" Version="1.0.0-beta12" PrivateAssets="all" ExcludeAssets="runtime" />
<PackageVersion Include="Proc" Version="0.9.1" />
<PackageVersion Include="RazorSlices" Version="0.9.1" />
<PackageVersion Include="RazorSlices" Version="0.9.0" />
<PackageVersion Include="Samboy063.Tomlet" Version="6.0.0" />
<PackageVersion Include="Slugify.Core" Version="4.0.1" />
<PackageVersion Include="SoftCircuits.IniFileParser" Version="2.7.0" />
Expand All @@ -55,14 +57,17 @@
<ItemGroup>
<PackageVersion Include="AngleSharp.Diffing" Version="1.0.0" />
<PackageVersion Include="DiffPlex" Version="1.7.2" />
<PackageVersion Include="FluentAssertions" Version="6.12.1" />
<PackageVersion Include="FluentAssertions" Version="7.2.0" />
<PackageVersion Include="FsUnit.xUnit" Version="7.0.1" />
<PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
<PackageVersion Include="JetBrains.Annotations" Version="2024.3.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
<PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="22.0.14" />
<PackageVersion Include="Unquote" Version="7.0.1" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
<PackageVersion Include="xunit.v3" Version="1.1.0" />
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.0">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageVersion>
<PackageVersion Include="xunit.v3" Version="2.0.2" />
</ItemGroup>
</Project>
21 changes: 21 additions & 0 deletions docs-builder.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assembler-config-validate",
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.LinkIndex", "src\Elastic.Documentation.LinkIndex\Elastic.Documentation.LinkIndex.csproj", "{FD1AC230-798B-4AB9-8CE6-A06264885DBC}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.ApiExplorer", "src\Elastic.ApiExplorer\Elastic.ApiExplorer.csproj", "{C883AC18-7C6A-482E-A9D7-C44DF8633425}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.ApiExplorer.Tests", "tests\Elastic.ApiExplorer.Tests\Elastic.ApiExplorer.Tests.csproj", "{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.Site", "src\Elastic.Documentation.Site\Elastic.Documentation.Site.csproj", "{89B83007-71E6-4B57-BA78-2544BFA476DB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -166,6 +172,18 @@ Global
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Debug|Any CPU.Build.0 = Debug|Any CPU
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Release|Any CPU.ActiveCfg = Release|Any CPU
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Release|Any CPU.Build.0 = Release|Any CPU
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Release|Any CPU.Build.0 = Release|Any CPU
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Release|Any CPU.Build.0 = Release|Any CPU
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{4D198E25-C211-41DC-9E84-B15E89BD7048} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
Expand All @@ -191,5 +209,8 @@ Global
{FB1C1954-D8E2-4745-BA62-04DD82FB4792} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{E20FEEF9-1D1A-4CDA-A546-7FDC573BE399} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{FD1AC230-798B-4AB9-8CE6-A06264885DBC} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{C883AC18-7C6A-482E-A9D7-C44DF8633425} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D} = {67B576EE-02FA-4F9B-94BC-3630BC09ECE5}
{89B83007-71E6-4B57-BA78-2544BFA476DB} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
EndGlobalSection
EndGlobal
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 @@ -16,6 +16,8 @@ subs:

features:
primary-nav: false

api: elasticsearch-openapi.json

toc:
- file: index.md
Expand Down
Loading
Loading