feature/publish links index lamdba #668
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
* On ci skip if /docs folder has no docset.yml silently * skip false not in finally * Add log message
* Add latest header design and adjust pages navigation * Fix unintended merge changes * fix * Pass markdownparser to directive html renderer * Change feature flag from UpperCamelCase to kebab-case * Update docs/_docset.yml * Refactor feature flags --------- Co-authored-by: Martijn Laarman <[email protected]>
This reverts commit 8edd22a.
* Add smoke test * fix
* Add latest header design and adjust pages navigation * Fix unintended merge changes * fix * Pass markdownparser to directive html renderer * Change feature flag from UpperCamelCase to kebab-case * Update docs/_docset.yml * Refactor feature flags * Fix case where targetUrl is null or empty * Revert Commands.cs * Don't fail-fast on matrix * Handle the case where there is no root index.md file * Fix * test * ok * fix * Fix --------- Co-authored-by: Martijn Laarman <[email protected]>
* Add first-page-path output and use it in preview build workflow * Refactor * Add to test * Fix smoke test * Refactor * Fix * Fix smoke test * Fix output name in usage and add output to action.yml * Refactor smoke-tests
Update command to be rooted to `docs-assembler inbound-links <command>`
Moved the "create-index" command from InboundLinkCommands to a new LinkRegistryCommands class for better modularity and maintainability. Updated program registration to include the new LinkRegistryCommands module and renamed the command to "update" for clarity.
…`docs-assembler`) (#651) * Ensure inbound links validation skips docset.yml declared repositories validation * Add warning that link links to repository not in yet in the registry * Add better errors to docs-builder to (link to links.json file)
* Add mobile navigations * Remove landing-page feature toggle
…s into docs build process (#666) * Move detection-rules support behind an extension system * Move EnabledExtensions to Configuration * add untracked files * Add documentation for extensions * Add more extensions points to isolate the DetectionRule extension further * Isolate file scanning in DocumentationSet * Do a ful parse
There was a problem hiding this comment.
PR Overview
This PR introduces multiple improvements and updates across workflows, documentation, and tooling. Key changes include the addition and update of several GitHub Actions for CI/CD (e.g. smoke tests, preview builds, reference index updates), refinements in the diagnostics logging for improved clarity, and documentation updates including content-set extensions and links syntax.
Reviewed Changes
| File | Description |
|---|---|
| .github/workflows/smoke-test.yml | Added smoke test workflow with multi-repository configuration |
| docs/configure/content-set/extensions.md | Added new documentation page for content set extensions |
| actions/update-reference-index/action.yml | Introduced an action to update the reference index |
| src/Elastic.Documentation.Tooling/Diagnostics/Console/ErrataFileSourceRepository.cs | Renamed ambiguous variables and updated guard clause logic |
| action.yml | Added new outputs for landing-page-path and skip hints |
| .github/workflows/preview-build.yml | Updated conditions and added free-disk-space input and additional steps |
| actions/validate-inbound-local/action.yml | Updated command for inbound link validation |
| .github/workflows/preview-cleanup.yml | Added an Update Reference Index step |
| docs/index.md | Updated front-matter for improved navigation |
| src/Elastic.Documentation.Tooling/Diagnostics/Log.cs | Added null coalescing default value for diagnostic line |
| src/Elastic.Documentation.Tooling/Diagnostics/Console/ConsoleDiagnosticsCollector.cs | Introduced state-check to prevent redundant stop logic |
| docs/_docset.yml | Introduced primary-nav feature flag and updated TOC |
| docs/syntax/links.md | Added a note about cross-repo link path requirements |
Copilot reviewed 98 out of 98 changed files in this pull request and generated 1 comment.
reakaleek
reviewed
Mar 4, 2025
Co-authored-by: Jan Calanog <[email protected]>
reakaleek
approved these changes
Mar 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Add
docs-lambda-index-publisherproject that we publish as a lambdabootstrapbinary that can run on an vanillaAmazon Linux 2023without any dependencies.For now this PR only includes manual build steps, will ensure this builds as part of releases and gets attached as binary to releases in a follow up PR.
The merges are out of whack on this PR 😭 but
Squash & Mergeshould get rid of the noise.