Skip to content

Commit f5da868

Browse files
authored
Remove docs-assembler completely (#2164)
* remove docs-assembler * Update tests * Move docs-assember tests to integration tests * Remove packaging docs-assembler and remove references to docs-assembler in text * Ensure ported tests wait for aspire * use available directories in ported tests * Ensure we pass skipPrivateRepositories to new tests * fix bootstrapping of ported assembly tests
1 parent 1ca6ce5 commit f5da868

File tree

30 files changed

+84
-614
lines changed

30 files changed

+84
-614
lines changed

.github/copilot-instructions.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,7 @@
33
**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.**
44

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

109
## Working Effectively
@@ -77,10 +76,10 @@ dotnet run --project src/tooling/docs-builder -- serve
7776
dotnet run --project src/tooling/docs-builder -- --help
7877

7978
# Get help for docs-assembler
80-
dotnet run --project src/tooling/docs-assembler -- --help
79+
dotnet run --project src/tooling/docs-builder -- assemble --help
8180

8281
# Validate assembler configuration - takes 15 seconds
83-
dotnet run --project src/tooling/docs-assembler -c release -- navigation validate
82+
dotnet run --project src/tooling/docs-builder -c release -- assembler navigation validate
8483
```
8584

8685
### Local Development Orchestration
@@ -126,7 +125,6 @@ src/
126125
├── Elastic.Markdown/ # Core Markdown processing engine
127126
├── tooling/
128127
│ ├── docs-builder/ # Main CLI application
129-
│ └── docs-assembler/ # Assembly tool
130128
├── Elastic.Documentation.Site/ # Web rendering components (TypeScript/CSS)
131129
└── Elastic.Documentation.Configuration/ # Configuration handling
132130
@@ -142,7 +140,7 @@ config/ # YAML configuration files
142140

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

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,10 +27,10 @@ jobs:
2727
uses: ./.github/actions/bootstrap
2828

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

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

3535
build-link-index-updater-lambda:
3636
uses: ./.github/workflows/build-link-index-updater-lambda.yml

.github/workflows/preview-build.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ jobs:
456456
)
457457
)
458458
run: |
459-
dotnet run --project src/tooling/docs-assembler -- navigation validate-link-reference
459+
dotnet run --project src/tooling/docs-builder -- assembler navigation validate-link-reference
460460
461461
- uses: elastic/docs-builder/.github/actions/aws-auth@main
462462
if: >

.github/workflows/release.yml

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -167,14 +167,12 @@ jobs:
167167
with:
168168
subject-path: |
169169
.artifacts/publish/docs-builder/release/*.zip
170-
.artifacts/publish/docs-assembler/release/*.zip
171170
172171
- name: Attach Distribution to release
173172
env:
174173
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
175174
run: |
176175
gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-builder/release/*.zip
177-
gh release upload ${{ needs.release-drafter.outputs.tag_name }} .artifacts/publish/docs-assembler/release/*.zip
178176
shell: bash
179177

180178
publish-release:

AGENTS.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,7 @@ This file contains instructions and guidance for AIs when working with the docs-
66

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

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

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

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

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

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

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

10098
## Useful file locations
10199

102-
- Entry points: `src/tooling/docs-builder/Program.cs`, `src/tooling/docs-assembler/Program.cs`
100+
- Entry points: `src/tooling/docs-builder/Program.cs`
103101
- Markdown processing: `src/Elastic.Markdown/Myst/`
104102
- Web assets: `src/Elastic.Documentation.Site/Assets/`
105103
- Configuration schemas: `src/Elastic.Documentation.Configuration/`

README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,9 @@
44

55
Distributed documentation tooling for a distributed company.
66

7-
This repository is host to:
8-
97
* *`docs-builder`* command line tool to generate single doc-sets
10-
* *`docs-assembler`* command line tool to assemble all the doc sets.
118

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

1411
The documentation files:
1512
* 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.
@@ -23,7 +20,7 @@ This tool builds each repository in isolation and in addition produces a full ma
2320
Each time a repository successfully builds on its respective main integration branch, our automation will publish its links.json file.
2421
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.
2522

26-
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.
23+
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.
2724

2825
This allows us to:
2926

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

6057
* **docs-builder**: `./.artifacts/publish/docs-builder/release/docs-builder`
61-
* **docs-assembler**: `./.artifacts/publish/docs-assembler/release/docs-assembler`
62-
58+
6359
## Getting Started
6460

6561
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.

actions/assembler/action.yml

Lines changed: 0 additions & 15 deletions
This file was deleted.

aspire/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ dotnet run --project aspire
2727

2828
This will automatically:
2929

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

3434
This should start a management UI over at: https://localhost:17166. This UI exposes all logs, traces, and metrics for each service

aspire/aspire.csproj

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121

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

2726
<ProjectReference Include="..\src\tooling\Elastic.Documentation.Tooling\Elastic.Documentation.Tooling.csproj" IsAspireProjectResource="false" />

build/Targets.fs

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@ let private clean _ =
1919
removeArtifacts "release-notes"
2020
removeArtifacts "tests"
2121
removeArtifacts "docs-builder"
22-
removeArtifacts "docs-assembler"
2322

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

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

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

6260
let private publishZip _ =
6361
let zip tool =
@@ -128,7 +126,6 @@ let private publishContainers _ =
128126
| _ -> []
129127
exec { run "dotnet" (args @ registry) }
130128
createImage "docs-builder"
131-
createImage "docs-assembler"
132129

133130
let private runTests (testSuite: TestSuite) _ =
134131
let testFilter =

0 commit comments

Comments
 (0)