Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 4 additions & 6 deletions .github/copilot-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
**ALWAYS reference these instructions first and fallback to search or bash commands only when you encounter unexpected information that does not match the info here.**

Elastic's distributed documentation tooling system built on .NET 9, consisting of:
- **docs-builder**: CLI tool for building single documentation sets
- **docs-assembler**: CLI tool for assembling multiple doc sets
- **docs-builder**: CLI tool for building single documentation sets or assembling or assembling multiple documentation sets
- Written in C# and F# with extensive Markdown processing capabilities

## Working Effectively
Expand Down Expand Up @@ -77,10 +76,10 @@ dotnet run --project src/tooling/docs-builder -- serve
dotnet run --project src/tooling/docs-builder -- --help

# Get help for docs-assembler
dotnet run --project src/tooling/docs-assembler -- --help
dotnet run --project src/tooling/docs-builder -- assemble --help

# Validate assembler configuration - takes 15 seconds
dotnet run --project src/tooling/docs-assembler -c release -- navigation validate
dotnet run --project src/tooling/docs-builder -c release -- assembler navigation validate
```

### Local Development Orchestration
Expand Down Expand Up @@ -126,7 +125,6 @@ src/
├── Elastic.Markdown/ # Core Markdown processing engine
├── tooling/
│ ├── docs-builder/ # Main CLI application
│ └── docs-assembler/ # Assembly tool
├── Elastic.Documentation.Site/ # Web rendering components (TypeScript/CSS)
└── Elastic.Documentation.Configuration/ # Configuration handling

Expand All @@ -142,7 +140,7 @@ config/ # YAML configuration files

### Adding New Features
- **Markdown Extensions**: Add to `src/Elastic.Markdown/Myst/`
- **CLI Commands**: Extend `src/tooling/docs-builder/Cli/` or `docs-assembler/Cli/`
- **CLI Commands**: Extend `src/tooling/docs-builder/Commands/`
- **Web Components**: Add to `src/Elastic.Documentation.Site/`
- **Configuration**: Modify `src/Elastic.Documentation.Configuration/`

Expand Down
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,10 @@ jobs:
uses: ./.github/actions/bootstrap

- name: Validate Navigation
run: dotnet run --project src/tooling/docs-assembler -c release -- navigation validate
run: dotnet run --project src/tooling/docs-builder -c release -- assembler navigation validate

- name: Validate Content Sources
run: dotnet run --project src/tooling/docs-assembler -c release -- content-source validate
run: dotnet run --project src/tooling/docs-builder -c release -- assembler content-source validate

build-link-index-updater-lambda:
uses: ./.github/workflows/build-link-index-updater-lambda.yml
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/preview-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -456,7 +456,7 @@ jobs:
)
)
run: |
dotnet run --project src/tooling/docs-assembler -- navigation validate-link-reference
dotnet run --project src/tooling/docs-builder -- assembler navigation validate-link-reference

- uses: elastic/docs-builder/.github/actions/aws-auth@main
if: >
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,14 +167,12 @@ jobs:
with:
subject-path: |
.artifacts/publish/docs-builder/release/*.zip
.artifacts/publish/docs-assembler/release/*.zip

- name: Attach Distribution to release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-builder/release/*.zip
gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-assembler/release/*.zip
shell: bash

publish-release:
Expand Down
8 changes: 3 additions & 5 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@ This file contains instructions and guidance for AIs when working with the docs-

This is Elastic's distributed documentation tooling system built on .NET 9, consisting of:

- **docs-builder**: CLI tool for building single documentation sets
- **docs-assembler**: CLI tool for assembling multiple doc sets
- **docs-builder**: CLI tool for building documentation sets (either individual or assembled)
- Written in C# and F# with extensive Markdown processing capabilities

## Essential commands
Expand Down Expand Up @@ -50,7 +49,6 @@ dotnet test --logger "console;verbosity=detailed"

- `src/Elastic.Markdown/` - Core Markdown processing engine
- `src/tooling/docs-builder/` - Main CLI application
- `src/tooling/docs-assembler/` - Assembly tool
- `src/Elastic.Documentation.Site/` - Web rendering components

### Testing Structure
Expand All @@ -70,7 +68,7 @@ dotnet test --logger "console;verbosity=detailed"
### Adding New Features

1. **Markdown Extensions**: Add to `src/Elastic.Markdown/Myst/`
2. **CLI Commands**: Extend `src/tooling/docs-builder/Cli/` or `docs-assembler/Cli/`
2. **CLI Commands**: Extend `src/tooling/docs-builder/Commands/`
3. **Web Components**: Add to `src/Elastic.Documentation.Site/`
4. **Configuration**: Modify `src/Elastic.Documentation.Configuration/`

Expand Down Expand Up @@ -99,7 +97,7 @@ You MUST update the documentation when there are changes in the markdown syntax

## Useful file locations

- Entry points: `src/tooling/docs-builder/Program.cs`, `src/tooling/docs-assembler/Program.cs`
- Entry points: `src/tooling/docs-builder/Program.cs`
- Markdown processing: `src/Elastic.Markdown/Myst/`
- Web assets: `src/Elastic.Documentation.Site/Assets/`
- Configuration schemas: `src/Elastic.Documentation.Configuration/`
Expand Down
10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,9 @@

Distributed documentation tooling for a distributed company.

This repository is host to:

* *`docs-builder`* command line tool to generate single doc-sets
* *`docs-assembler`* command line tool to assemble all the doc sets.

Both get distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)
Distributed [as native OSX, Linux and Windows binaries for several CPU architectures.](#installation)

The documentation files:
* are written in common Markdown with [Additional syntax extensions](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/syntax/) to produce a richer writing and reading experience.
Expand All @@ -23,7 +20,7 @@ This tool builds each repository in isolation and in addition produces a full ma
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
For example, [Elasticsearch's links.json](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/elasticsearch/main/links.json) representing all linkable resources in the Elasticsearch repository.

The `docs-assembler` tool then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit.
The `docs-builder assemble` command then assembles all the repositories in the [link-registry](https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/link-index.json) using their last known good commit.

This allows us to:

Expand Down Expand Up @@ -58,8 +55,7 @@ Install [.NET 9.0](https://dotnet.microsoft.com/en-us/download/dotnet/9.0), then
After which the locally built binaries will be available at:

* **docs-builder**: `./.artifacts/publish/docs-builder/release/docs-builder`
* **docs-assembler**: `./.artifacts/publish/docs-assembler/release/docs-assembler`


## Getting Started

Our [Documentation](https://docs-v3-preview.elastic.dev/elastic/docs-builder/tree/main/contribute/locally) is the best place to learn how to start using the tool locally.
Expand Down
15 changes: 0 additions & 15 deletions actions/assembler/action.yml

This file was deleted.

4 changes: 2 additions & 2 deletions aspire/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ dotnet run --project aspire

This will automatically:

* clone all repositories according to `config/assembler.yml` using `docs-assembler repo clone-all`
* do a full site build of all repositories using `docs-assembler repo build-all`
* clone all repositories according to `config/assembler.yml` using `docs-builder assembler clone`
* do a full site build of all repositories using `docs-builder assembler build`
* Serve a copy of the fully assembled documentation using `docs-builder serve-static`.

This should start a management UI over at: https://localhost:17166. This UI exposes all logs, traces, and metrics for each service
Expand Down
1 change: 0 additions & 1 deletion aspire/aspire.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@

<ItemGroup>
<ProjectReference Include="..\src\api\Elastic.Documentation.Api.Lambda\Elastic.Documentation.Api.Lambda.csproj" />
<ProjectReference Include="..\src\tooling\docs-assembler\docs-assembler.csproj"/>
<ProjectReference Include="..\src\tooling\docs-builder\docs-builder.csproj"/>

<ProjectReference Include="..\src\tooling\Elastic.Documentation.Tooling\Elastic.Documentation.Tooling.csproj" IsAspireProjectResource="false" />
Expand Down
3 changes: 0 additions & 3 deletions build/Targets.fs
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@ let private clean _ =
removeArtifacts "release-notes"
removeArtifacts "tests"
removeArtifacts "docs-builder"
removeArtifacts "docs-assembler"

let private compile _ = exec { run "dotnet" "build" "-c" "release" }

Expand Down Expand Up @@ -57,7 +56,6 @@ let private pristineCheck (arguments:ParseResults<Build>) =

let private publishBinaries _ =
exec { run "dotnet" "publish" "src/tooling/docs-builder/docs-builder.csproj" }
exec { run "dotnet" "publish" "src/tooling/docs-assembler/docs-assembler.csproj" }

let private publishZip _ =
let zip tool =
Expand Down Expand Up @@ -128,7 +126,6 @@ let private publishContainers _ =
| _ -> []
exec { run "dotnet" (args @ registry) }
createImage "docs-builder"
createImage "docs-assembler"

let private runTests (testSuite: TestSuite) _ =
let testFilter =
Expand Down
20 changes: 0 additions & 20 deletions docs-builder.sln
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "publish-vercel", "publish-v
EndProject
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "build", "build\build.fsproj", "{10857974-6CF1-42B5-B793-AAA988BD7348}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs-assembler", "src\tooling\docs-assembler\docs-assembler.csproj", "{28350800-B44B-479B-86E2-1D39E321C0B4}"
EndProject
Project("{F2A71F9B-5D33-465A-A702-920D77279786}") = "authoring", "tests\authoring\authoring.fsproj", "{018F959E-824B-4664-B345-066784478D24}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.Refactor", "src\authoring\Elastic.Documentation.Refactor\Elastic.Documentation.Refactor.csproj", "{7D36DDDA-9E0B-4D2C-8033-5D62FF8B6166}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "assembler", "assembler", "{CFEE9FAD-9E0C-4C0E-A0C2-B97D594C14B5}"
ProjectSection(SolutionItems) = preProject
actions\assembler\action.yml = actions\assembler\action.yml
EndProjectSection
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Elastic.Documentation.Tooling", "src\tooling\Elastic.Documentation.Tooling\Elastic.Documentation.Tooling.csproj", "{4CCE599A-B9FE-4DF2-8763-34CF0A99D4AA}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "validate-inbound-local", "validate-inbound-local", "{6E2ED6CC-AFC1-4E58-965D-6AEC500EBB46}"
Expand All @@ -73,8 +66,6 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "update-link-index", "update
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs-lambda-index-publisher", "src\infra\docs-lambda-index-publisher\docs-lambda-index-publisher.csproj", "{C559D52D-100B-4B2B-BE87-2344D835761D}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "docs-assembler.Tests", "tests\docs-assembler.Tests\src\docs-assembler.Tests\docs-assembler.Tests.csproj", "{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "infra", "infra", "{4894063D-0DEF-4B7E-97D0-0D0A5B85C608}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "validate-path-prefixes-local", "validate-path-prefixes-local", "{BB789671-B262-43DD-91DB-39F9186B8257}"
Expand Down Expand Up @@ -188,10 +179,6 @@ Global
{10857974-6CF1-42B5-B793-AAA988BD7348}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{10857974-6CF1-42B5-B793-AAA988BD7348}.Debug|Any CPU.Build.0 = Debug|Any CPU
{10857974-6CF1-42B5-B793-AAA988BD7348}.Release|Any CPU.ActiveCfg = Release|Any CPU
{28350800-B44B-479B-86E2-1D39E321C0B4}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{28350800-B44B-479B-86E2-1D39E321C0B4}.Debug|Any CPU.Build.0 = Debug|Any CPU
{28350800-B44B-479B-86E2-1D39E321C0B4}.Release|Any CPU.ActiveCfg = Release|Any CPU
{28350800-B44B-479B-86E2-1D39E321C0B4}.Release|Any CPU.Build.0 = Release|Any CPU
{018F959E-824B-4664-B345-066784478D24}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{018F959E-824B-4664-B345-066784478D24}.Debug|Any CPU.Build.0 = Debug|Any CPU
{018F959E-824B-4664-B345-066784478D24}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand All @@ -208,10 +195,6 @@ Global
{C559D52D-100B-4B2B-BE87-2344D835761D}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C559D52D-100B-4B2B-BE87-2344D835761D}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C559D52D-100B-4B2B-BE87-2344D835761D}.Release|Any CPU.Build.0 = Release|Any CPU
{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3}.Debug|Any CPU.Build.0 = Debug|Any CPU
{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3}.Release|Any CPU.ActiveCfg = Release|Any CPU
{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3}.Release|Any CPU.Build.0 = Release|Any CPU
{09CE30F6-013A-49ED-B3D6-60AFA84682AC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{09CE30F6-013A-49ED-B3D6-60AFA84682AC}.Debug|Any CPU.Build.0 = Debug|Any CPU
{09CE30F6-013A-49ED-B3D6-60AFA84682AC}.Release|Any CPU.ActiveCfg = Release|Any CPU
Expand Down Expand Up @@ -291,17 +274,14 @@ Global
{CD2887E3-BDA9-434B-A5BF-9ED38DE20332} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{A2A34BBC-CB5E-4100-9529-A12B6ECB769C} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{018F959E-824B-4664-B345-066784478D24} = {67B576EE-02FA-4F9B-94BC-3630BC09ECE5}
{CFEE9FAD-9E0C-4C0E-A0C2-B97D594C14B5} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{6E2ED6CC-AFC1-4E58-965D-6AEC500EBB46} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{6554F917-73CE-4B3D-9101-F28EAA762C6B} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{CDC0ECF4-6597-4FBA-8D25-5C244F0877E3} = {67B576EE-02FA-4F9B-94BC-3630BC09ECE5}
{4894063D-0DEF-4B7E-97D0-0D0A5B85C608} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{C559D52D-100B-4B2B-BE87-2344D835761D} = {4894063D-0DEF-4B7E-97D0-0D0A5B85C608}
{BB789671-B262-43DD-91DB-39F9186B8257} = {245023D2-D3CA-47B9-831D-DAB91A2FFDC7}
{09CE30F6-013A-49ED-B3D6-60AFA84682AC} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{CD94F9E4-7FCD-4152-81F1-4288C6B75367} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{73ABAE37-118F-4A53-BC2C-F19333555C90} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
{28350800-B44B-479B-86E2-1D39E321C0B4} = {73ABAE37-118F-4A53-BC2C-F19333555C90}
{01F05AD0-E0E0-401F-A7EC-905928E1E9F0} = {73ABAE37-118F-4A53-BC2C-F19333555C90}
{4CCE599A-B9FE-4DF2-8763-34CF0A99D4AA} = {73ABAE37-118F-4A53-BC2C-F19333555C90}
{059E787F-85C1-43BE-9DD6-CE319E106383} = {BE6011CC-1200-4957-B01F-FCCA10C5CF5A}
Expand Down
2 changes: 1 addition & 1 deletion docs/cli/assembler/assembler-deploy-update-redirects.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,4 @@ docs-builder assembler deploy update-redirects [options...] [-h|--help] [--versi
: The environment to build (Required)

`--redirects-file` `<string>`
: Path to the redirects mapping pre-generated by docs-assembler (optional)
: Path to the redirects mapping pre-generated by docs-builder assemble (optional)
2 changes: 1 addition & 1 deletion docs/contribute/add-repo.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Add a new repository to the docs

Elastic documentation is built from many assembled repositories using `docs-assembler`. Adding a new repository requires making the assembly process aware of its existence.
Elastic documentation is built from many assembled repositories using `docs-builder assemble`. Adding a new repository requires making the assembly process aware of its existence.

Follow these instructions to add a new docs repository.

Expand Down
2 changes: 1 addition & 1 deletion src/Elastic.Documentation.LegacyDocs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ It uses a checked-in bloom filter file loaded into memory to check if an URL exi
The bloom filter file is created by running the following command:

```
dotnet run --project src/tooling/docs-assembler -- legacy-docs create-bloom-bin --built-docs-dir /path/to/elastic/built-docs
dotnet run --project src/tooling/docs-builder -- assembler bloom-filter create --built-docs-dir /path/to/elastic/built-docs
```

1. The `--built-docs-dir` option is the path to the locally checked-out [elastic/built-docs](https://github.com/elastic/built-docs) repository.
61 changes: 0 additions & 61 deletions src/tooling/docs-assembler/Cli/ContentSourceCommands.cs

This file was deleted.

Loading
Loading