Separate static url prefix from path prefix #744
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It still defaults to UrlPathPrefix but with the assembler build we need a way to ensure static files can be rooted seperately from the path prefix of the page. To help with development we now have a 'dev' environment which defaults to http://localhost:4000/docs We can now view the output of `docs-assembler repo build all` with `docs-builder serve-static` which will host the combined docs under http://localhost:4000
reakaleek
approved these changes
Mar 14, 2025
Added explicit diagnostic suppression rules for IL3050 and IL2026 under the StaticWebHost.cs section in the .editorconfig file. This ensures consistent handling of these diagnostics specifically for StaticWebHost-related code.
There was a problem hiding this comment.
Pull Request Overview
This PR separates the static URL prefix from the path prefix to support serving static files independently and adds a new "dev" environment for development. Key changes include:
- Introducing a new StaticUrlPathPrefix property in BuildContext and updating view models to use it.
- Adding a new "serve-static" command endpoint that leverages the StaticWebHost.
- Updating the assembler and builder code to support environment-based URL and path prefix configurations.
Reviewed Changes
Copilot reviewed 13 out of 13 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/docs-builder/Http/StaticWebHost.cs | New static web host implementation for serving static files. |
| src/docs-builder/Cli/Commands.cs | Added ServeStatic command for hosting static files on a separate port. |
| src/Elastic.Markdown/BuildContext.cs | Introduced StaticUrlPathPrefix with fallback to UrlPathPrefix. |
| src/docs-assembler/Cli/RepositoryCommands.cs | Updated environment default to "dev" and adjusted BuildAllAsync call. |
| src/docs-assembler/assembler.yml | Added a new "dev" environment configuration. |
| src/docs-assembler/Building/AssemblerBuilder.cs | Adjusted BuildAllAsync and BuildAsync signatures for PublishEnvironment. |
| src/docs-assembler/Sourcing/RepositorySourcesFetcher.cs | Commented out an unused timeout setting. |
| src/Elastic.Markdown/Slices/_ViewModels.cs | Updated view models to include StaticUrlPathPrefix. |
| src/Elastic.Markdown/Slices/HtmlWriter.cs | Updated layout rendering to inject StaticUrlPathPrefix. |
| src/docs-assembler/AssembleContext.cs | Fixed assembler configuration file path resolution. |
| src/docs-assembler/Building/PublishEnvironmentUriResolver.cs | Updated constructor to use PublishEnvironment and improved URI parsing. |
| src/Elastic.Markdown/Slices/Index.cshtml | Updated razor view to include StaticUrlPathPrefix. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It still defaults to UrlPathPrefix but with the assembler build we need a way to ensure static files can
be rooted seperately from the path prefix of the page.
To help with development we now have a 'dev' environment which defaults to http://localhost:4000/docs
We can now view the output of
docs-assembler repo build allwithdocs-builder serve-staticwhich will host the combined docs under http://localhost:4000
This should fix the styling on: https://staging-website.elastic.co/docs/