Releases: elastic/docs-builder
Releases · elastic/docs-builder
docs-builder 0.19.0
✨ Features
- Allow substitutions in external links by @reakaleek in #715
- Add ability to set code block arguments by @reakaleek in #699
- Initial version of sourcing repositories for assembly by @Mpdreamz in #713
- Allow comments between code blocks and callouts by @bmorelli25 in #695
🐛 Bug Fixes
- Use https remotes for assembler clones by @Mpdreamz in #723
- AOT compile assembler by @Mpdreamz in #719
- Move base image for assembly over to jammy to ensure git is available by @Mpdreamz in #717
- Embedd assembler.yml in binary temporarily before its homed in docs-content by @Mpdreamz in #716
- Allow to open link in a new tab when pressing the modifier key (ctrl or cmd) by @reakaleek in #714
- Skip the navigation item if the parent group points to the same file by @reakaleek in #707
- Remove UseSoftlineBreakAsHardlineBreak from MarkdownParser by @Mpdreamz in #510
- Fix scroll position when opening a link with an anchor by @reakaleek in #702
- Fix
scrollTop
when navigating through pages by @reakaleek in #698 - Fix navigation by @reakaleek in #697
Full Changelog: 0.18.0...0.19.0
docs-builder 0.18.0
✨ Features
- Add
loading="lazy"
for images by @reakaleek in #691 - Add layout system and NotFound layout by @reakaleek in #676
- Allow substitutions in code blocks from global docset variables. by @reakaleek in #685
🐛 Bug Fixes
- Revert "Refactor file serving algorithm" by @reakaleek in #696
- Fix rendering of code blocks with callouts and a block in between by @reakaleek in #686
- Adjust heading font sizes by @reakaleek in #687
- Fix dropdown appearance in safari by @reakaleek in #688
- Use default font for definition lists by @reakaleek in #689
Full Changelog: 0.17.0...0.18.0
docs-builder 0.17.0
✨ Features
- Add support for screenshot class by @bmorelli25 in #665
- Add landing page feature flag by @reakaleek in #663
- feature/publish links index lamdba by @Mpdreamz in #668
- Add extension hook points to all special usecases to inject themselves into docs build process by @Mpdreamz in #666
- Add mobile navigations by @reakaleek in #662
🐛 Bug Fixes
- Fix image styling by @reakaleek in #682
- Fix scroll-margin-top by @reakaleek in #678
- Fix local file serving by @reakaleek in #675
- Fix links in landing page by @reakaleek in #674
- Disable
primary-nav
andlanding-page
feature in docs-builder by @reakaleek in #673 - Remove trailing dot after link in error message by @Mpdreamz in #671
- Adjust links and wording in primary and secondary navigation by @reakaleek in #659
📝 Documentation
- Add clarification to redirects.md by @lcawl in #683
- [docs] Update custom anchor links section in heading syntax docs by @colleenmcginnis in #677
🧰 Maintenance
- Refactor file serving algorithm by @reakaleek in #679
⚙️ Automation
Full Changelog: 0.16.0...0.17.0
docs-builder 0.16.0
✨ Features
🐛 Bug Fixes
- If GITHUB_REPOSITORY is set use it verbatim by @Mpdreamz in #655
- Add logging to git remote resolving by @Mpdreamz in #652
- Better error messages for cross_link errors (From
docs-builder
anddocs-assembler
) by @Mpdreamz in #651 - Refactor link index command into dedicated LinkRegistry module by @Mpdreamz in #649
- Add validate command for single published repository by @Mpdreamz in #648
- Fix preview-build.yml by @reakaleek in #644
- Inbound link checking, fully validate if found in links-index by @Mpdreamz in #643
📝 Documentation
- Update cross-repo links syntax info by @leemthompo in #654
🧰 Maintenance
- Remove unused workflows by @reakaleek in #646
⚙️ Automation
- Fix
environment_url
in preview deployment by @reakaleek in #658 - Add
landing-page-path
output and use it in preview workflow by @reakaleek in #642
Full Changelog: 0.15.0...0.16.0
docs-builder 0.15.0
✨ Features
- Add
primary-nav
feature by @reakaleek in #636 - Optimize preview build to avoid checkout on pull_request* events by @reakaleek in #633
🐛 Bug Fixes
- Revert "Add
PrimaryNav
feature" by @reakaleek in #635 - Default CurrentUrlPath to empty string while we investigate further by @Mpdreamz in #618
- Fix link to docs-builder docs by @colleenmcginnis in #606
- link validate-inbound-local's resolver was using a stale copy by @Mpdreamz in #602
- validate-inbound-local call docker image directly by @Mpdreamz in #596
📝 Documentation
- more updates to ref docs by @bmorelli25 in #612
- Add path-pattern to docs by @bmorelli25 in #607
- Draft runbook for moving reference content by @bmorelli25 in #603
🧰 Maintenance
- POC: Get currentl url to link renderer by @Mpdreamz in #605
- Relocate Elastic.Documentation.Tooling to src directory. by @Mpdreamz in #613
- Clean up legacy frontend resources by @reakaleek in #600
⚙️ Automation
- Run free-disk-space action in security-docs by @reakaleek in #639
- Add smoke tests by @reakaleek in #637
- Set correct deployment status on skipped builds by @reakaleek in #632
- Feature: allow the docs-build action to hint to subsequent steps to skip by @Mpdreamz in #631
- On ci skip if /docs folder has no docset.yml silently by @Mpdreamz in #630
- Continue-on-error temporarily for validate-inbound-links by @Mpdreamz in #627
- Update links-index.json whenever we push a links.json by @Mpdreamz in #624
- Update links-index.json whenever a PR get's closed by @Mpdreamz in #623
- Add update-reference-index action by @Mpdreamz in #622
- Just compare with repository name for now by @reakaleek in #619
- Fix
free-disk-space
input attempt 2 by @reakaleek in #617 - Simply if check on Free Disk Space by @Mpdreamz in #616
- Add
free-disk-space
input by @reakaleek in #614 - BREAKING: The preview build input
continue-on-error
is nowfalse
by default by @reakaleek in #608 - Also trigger preview build on deleted files by @reakaleek in #598
Full Changelog: 0.14.0...0.15.0
docs-builder 0.14.0
✨ Features
- Add local inbound links validation to the shared preview workflow by @Mpdreamz in #589
- Add inbound links validation by @Mpdreamz in #587
- Add htmx to dynamically load content by @reakaleek in #545
- Add redirects.yml to publish renames/delations in links.json for dependent docsets. by @Mpdreamz in #556
🐛 Bug Fixes
- Prefer GITHUB_REPOSITORY for remote name by @Mpdreamz in #594
- Remove erroneous warning for link text generation on missing page by @Mpdreamz in #592
- Fix "Edit this page" links to docs-content repo by @florent-leborgne in #591
- Fix htmx link in markdown content by @reakaleek in #588
- Support anchors and table of contents from included files by @Mpdreamz in #585
- Add hx attributes to breadcrumbs links by @reakaleek in #579
- Fix tabs in list by @reakaleek in #578
- Fix inline code wrapping by @reakaleek in #582
- Exclude navigation elements from browser search if collapsed by @reakaleek in #583
- Fix truncated text in code callout by @reakaleek in #584
- Also add breadcrumbs to the hx-select-oob list by @reakaleek in #575
- pages-nav: Fix spacing shift when clicking on a group by @reakaleek in #574
- Address a few allocation issues by @Mpdreamz in #551
- Empty url in markdown links should result in an error not warning by @Mpdreamz in #523
- Change one Security serverless "applies to" duplicate to missing Elasticsearch serverless by @florent-leborgne in #543
- Rename Elastic Cloud to Elastic Cloud Hosted for applies_to displayed values by @florent-leborgne in #542
📝 Documentation
- [DOCS] Update file_inclusion.md for linking to snippets with custom anchors by @leemthompo in #564
- Update applies.md by @lcawl in #546
- Remove admonition by @lcawl in #547
- Update file_inclusion.md by @leemthompo in #544
🧰 Maintenance
- Ensure docs-builder serve shares the same service collection bootstrapping as the CLI tools by @Mpdreamz in #553
- Add shared Elastic.Documentation.Tooling libraries for all CLI binaries by @Mpdreamz in #548
⚙️ Automation
- Support
merge_group
event for preview builds by @reakaleek in #593 - Add Free Disk Space to preview build workflow by @colleenmcginnis in #576
- Always deploy by @reakaleek in #557
- Github annotations for roslyn analyzers by @Mpdreamz in #539
🎨 Redesign
- tabs: Add slight border by @reakaleek in #573
- Add table by @reakaleek in #570
- Fix fonts by @reakaleek in #571
- Add definition list by @reakaleek in #572
Full Changelog: 0.13.0...0.14.0
docs-builder 0.13.0
✨ Features
- Load navigation javascript earlier by @reakaleek in #533
- Rework applies blocks to applies_to with new semantics by @Mpdreamz in #527
🐛 Bug Fixes
- Update code block parser to handle YAML key warnings by @Mpdreamz in #541
- Fix csharp code analysis warnings by @Mpdreamz in #538
- Cache Navigation by @Mpdreamz in #537
- Fix ToC nav by @reakaleek in #536
- Fix layout shift on page load by @reakaleek in #535
- Fix img src url by @reakaleek in #532
🎨 Redesign
- Add list styling by @reakaleek in #531
- Add dropdown styling by @reakaleek in #529
Full Changelog: 0.12.0...0.13.0
docs-builder 0.12.0
✨ Features
🐛 Bug Fixes
- Fix pages navigation by @reakaleek in #528
⚙️ Automation
Full Changelog: 0.11.0...0.12.0
docs-builder 0.11.0
docs-builder 0.10.0
✨ Features
- Enable new design by default by @reakaleek in #516
- Add Documentation Assembler GitHub Action by @Mpdreamz in #501
- Add
links create-index
command to the assembler by @Mpdreamz in #499 - Only validate
docs-content
cross links for now by @Mpdreamz in #496 - Initial support for cross link resolving by @Mpdreamz in #491
🐛 Bug Fixes
- Empty url in markdown links should result in an error not warning by @Mpdreamz in #515
- Do not attempt to read conf.yaml immediately, not all commands need it by @Mpdreamz in #511
- Allow for both :/ and <scheme:// style cross-link lookups by @Mpdreamz in #504
📝 Documentation
- update contributing on the web docs by @georgewallace in #474
- update contributor guide by @bmorelli25 in #481
- Add more prose use cases by @shainaraskas in #479
- Version docs by @shainaraskas in #478
🧰 Maintenance
- Create CODEOWNERS by @reakaleek in #498
- Fix new compilation errors introduced in 9.0.200 by @Mpdreamz in #476
⚙️ Automation
- Use task attribute to identify deployments by @reakaleek in #512
- Fix preview build workflow by @reakaleek in #480
- Rework preview deployment workflows by @reakaleek in #472
- Fix deployment cache invaldation by @reakaleek in #468
🎨 Redesign
- Add admonitions by @reakaleek in #513
- Add codeblocks by @reakaleek in #509
- Add headings by @reakaleek in #497
- Add tabs by @reakaleek in #489
- Add previous/next button design by @reakaleek in #487
- Add table of contents by @reakaleek in #477
- Add pages navigation by @reakaleek in #447
Full Changelog: 0.9.0...0.10.0