Skip to content

Commit bdfb9ca

Browse files
MpdreamzMpdreamz
authored
Refactor: make Elastic.Markdown a module of Elastic.Documentation.Site (#1344)
* Move common site frontend to Elastic.Documentation.Site * update navigation to be more generic, still lots of refactoring todo * move web files over to Elastic.Documentation.Site * fix navigation bug * Doubly nested layouts! * Move markdown content partials back * move BuildContext to Elastic.Documentation.Configuration * Fix assembler build resolving of static files and navigation * Add support for viewing API docs in serve * start on api navigation * remove INavigationGroup and normalize to IGroupNavigationItem * rener API navigation * finalize * update package-lock.json location in worklfows * change wd * fix build error * run npm lint * add api configuration to docset.yml * temporarily use inline bootstrap * remove tailwind config comment * ignore tailwind config in eslint * fix leaving code exploration in * Move classes out of Class1.cs :)
1 parent e7bc59b commit bdfb9ca

File tree

170 files changed

+120771
-485
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+120771
-485
lines changed

‎.github/actions/bootstrap/action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,6 @@ runs:
3535
- uses: actions/setup-node@v4
3636
with:
3737
cache: npm
38-
cache-dependency-path: src/Elastic.Markdown/package-lock.json
38+
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
3939
node-version-file: .nvmrc
4040

‎.github/workflows/ci.yml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,14 @@ jobs:
3939
runs-on: ubuntu-latest
4040
defaults:
4141
run:
42-
working-directory: src/Elastic.Markdown
42+
working-directory: src/Elastic.Documentation.Site
4343
steps:
4444
- uses: actions/checkout@v4
4545

4646
- uses: actions/setup-node@v4
4747
with:
4848
cache: npm
49-
cache-dependency-path: src/Elastic.Markdown/package-lock.json
49+
cache-dependency-path: src/Elastic.Documentation.Site/package-lock.json
5050
node-version-file: .nvmrc
5151

5252
- name: Install dependencies

‎Directory.Packages.props‎

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
<PackageVersion Include="AWSSDK.S3" Version="4.0.0.1" />
1919
<PackageVersion Include="FakeItEasy" Version="8.3.0" />
2020
<PackageVersion Include="Elastic.Ingest.Elasticsearch" Version="0.11.3" />
21+
<PackageVersion Include="Microsoft.OpenApi" Version="2.0.0-preview9" />
22+
<PackageVersion Include="System.Text.Json" Version="9.0.5" />
2123
</ItemGroup>
2224
<!-- Build -->
2325
<ItemGroup>
@@ -40,7 +42,7 @@
4042
<PackageVersion Include="Markdig" Version="0.41.1" />
4143
<PackageVersion Include="NetEscapades.EnumGenerators" Version="1.0.0-beta12" PrivateAssets="all" ExcludeAssets="runtime" />
4244
<PackageVersion Include="Proc" Version="0.9.1" />
43-
<PackageVersion Include="RazorSlices" Version="0.9.1" />
45+
<PackageVersion Include="RazorSlices" Version="0.9.0" />
4446
<PackageVersion Include="Samboy063.Tomlet" Version="6.0.0" />
4547
<PackageVersion Include="Slugify.Core" Version="4.0.1" />
4648
<PackageVersion Include="SoftCircuits.IniFileParser" Version="2.7.0" />
@@ -55,14 +57,17 @@
5557
<ItemGroup>
5658
<PackageVersion Include="AngleSharp.Diffing" Version="1.0.0" />
5759
<PackageVersion Include="DiffPlex" Version="1.7.2" />
58-
<PackageVersion Include="FluentAssertions" Version="6.12.1" />
60+
<PackageVersion Include="FluentAssertions" Version="7.2.0" />
5961
<PackageVersion Include="FsUnit.xUnit" Version="7.0.1" />
6062
<PackageVersion Include="GitHubActionsTestLogger" Version="2.4.1" />
6163
<PackageVersion Include="JetBrains.Annotations" Version="2024.3.0" />
62-
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.13.0" />
64+
<PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.14.1" />
6365
<PackageVersion Include="System.IO.Abstractions.TestingHelpers" Version="22.0.14" />
6466
<PackageVersion Include="Unquote" Version="7.0.1" />
65-
<PackageVersion Include="xunit.runner.visualstudio" Version="3.0.2" />
66-
<PackageVersion Include="xunit.v3" Version="1.1.0" />
67+
<PackageVersion Include="xunit.runner.visualstudio" Version="3.1.0">
68+
<PrivateAssets>all</PrivateAssets>
69+
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
70+
</PackageVersion>
71+
<PackageVersion Include="xunit.v3" Version="2.0.2" />
6772
</ItemGroup>
6873
</Project>

‎docs-builder.sln‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,12 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assembler-config-validate",
101101
EndProject
102102
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.LinkIndex", "src\Elastic.Documentation.LinkIndex\Elastic.Documentation.LinkIndex.csproj", "{FD1AC230-798B-4AB9-8CE6-A06264885DBC}"
103103
EndProject
104+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.ApiExplorer", "src\Elastic.ApiExplorer\Elastic.ApiExplorer.csproj", "{C883AC18-7C6A-482E-A9D7-C44DF8633425}"
105+
EndProject
106+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.ApiExplorer.Tests", "tests\Elastic.ApiExplorer.Tests\Elastic.ApiExplorer.Tests.csproj", "{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}"
107+
EndProject
108+
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.Site", "src\Elastic.Documentation.Site\Elastic.Documentation.Site.csproj", "{89B83007-71E6-4B57-BA78-2544BFA476DB}"
109+
EndProject
104110
Global
105111
GlobalSection(SolutionConfigurationPlatforms) = preSolution
106112
Debug|Any CPU = Debug|Any CPU
@@ -166,6 +172,18 @@ Global
166172
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Debug|Any CPU.Build.0 = Debug|Any CPU
167173
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Release|Any CPU.ActiveCfg = Release|Any CPU
168174
{FD1AC230-798B-4AB9-8CE6-A06264885DBC}.Release|Any CPU.Build.0 = Release|Any CPU
175+
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
176+
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Debug|Any CPU.Build.0 = Debug|Any CPU
177+
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Release|Any CPU.ActiveCfg = Release|Any CPU
178+
{C883AC18-7C6A-482E-A9D7-C44DF8633425}.Release|Any CPU.Build.0 = Release|Any CPU
179+
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
180+
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Debug|Any CPU.Build.0 = Debug|Any CPU
181+
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Release|Any CPU.ActiveCfg = Release|Any CPU
182+
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D}.Release|Any CPU.Build.0 = Release|Any CPU
183+
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
184+
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Debug|Any CPU.Build.0 = Debug|Any CPU
185+
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Release|Any CPU.ActiveCfg = Release|Any CPU
186+
{89B83007-71E6-4B57-BA78-2544BFA476DB}.Release|Any CPU.Build.0 = Release|Any CPU
169187
EndGlobalSection
170188
GlobalSection(NestedProjects) = preSolution
171189
{4D198E25-C211-41DC-9E84-B15E89BD7048} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
@@ -191,5 +209,8 @@ Global
191209
{FB1C1954-D8E2-4745-BA62-04DD82FB4792} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
192210
{E20FEEF9-1D1A-4CDA-A546-7FDC573BE399} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
193211
{FD1AC230-798B-4AB9-8CE6-A06264885DBC} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
212+
{C883AC18-7C6A-482E-A9D7-C44DF8633425} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
213+
{0331559E-4ED1-4A56-9C35-3EAD4D7E696D} = {67B576EE-02FA-4F9B-94BC-3630BC09ECE5}
214+
{89B83007-71E6-4B57-BA78-2544BFA476DB} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
194215
EndGlobalSection
195216
EndGlobal

‎docs/_docset.yml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ subs:
1616

1717
features:
1818
primary-nav: false
19+
20+
api: elasticsearch-openapi.json
1921

2022
toc:
2123
- file: index.md

0 commit comments

Comments
 (0)