Releases: elastic/docs-builder
Releases · elastic/docs-builder
docs-builder 0.23.0
✨ Features
- Introduce a "Report an issue" link on documentation pages. by @cotti in #817
- SEO optimized title by @reakaleek in #819
- Update
navigation.yml
by @colleenmcginnis in #780 - Implement sitemap by @cotti in #828
- Assembler: Inject global navigation into the build by @Mpdreamz in #822
- Add footer and fix landing page layout by @reakaleek in #824
- Refactor and optimize htmx attributes by @reakaleek in #812
- Swap Elastic products and How-to guides in landing page by @reakaleek in #811
🐛 Bug Fixes
- Reorder after reinjecting tree into global navigation by @Mpdreamz in #839
- Also close pages switcher when clicking on the active item by @reakaleek in #838
- Ensure pages switcher is closed by @reakaleek in #837
- Quick cleanup: Address compiler hints by @Mpdreamz in #836
- GlobalNavigationPathProvider: change definition for the newRelativePath by @cotti in #835
- Fix anchor within details for non Chrome browsers by @reakaleek in #823
- Adjust sitemap publish path by @cotti in #829
- Refine TOC validation logic and error messaging. by @Mpdreamz in #827
- Remove custom dataLayer push by @reakaleek in #821
- Fix secondary nav htmx attributes by @reakaleek in #820
- Remove custom spacing of lists by @reakaleek in #813
⚙️ Automation
- Add Lambda build and release jobs to CI workflows by @Mpdreamz in #840
- Also add workflow_dispatch to link index steps by @reakaleek in #832
- Add ability to run workflow manually by @reakaleek in #831
Full Changelog: 0.22.0...0.23.0
docs-builder 0.22.0
docs-builder 0.21.0
✨ Features
- Add google tag manager by @reakaleek in #808
- Add canonical base url to assembler build by @reakaleek in #797
- Add simple header for
IsPrimaryNavEnabled==false
by @reakaleek in #802 - Open external links in another tab by @reakaleek in #793
- Add og meta tags by @reakaleek in #785
- Add ability to set description meta tag by @reakaleek in #778
- Add ability to set canonical base url by @reakaleek in #776
- Refactor navigation to be more anemic. by @Mpdreamz in #781
- feature/assembler global toc by @Mpdreamz in #770
- Add table of contents scope management and refactor diagnostics by @Mpdreamz in #774
- Restrict docset.yml configs that define toc.yml sections to ONLY link to sub toc.yml files by @Mpdreamz in #767
- Preload fonts in use as per CSS definitions by @cotti in #765
- Skip preview jobs on fork repositories by @reakaleek in #763
🐛 Bug Fixes
- Detect variables as they are parsed in the AST by @Mpdreamz in #809
- Allow extensions to inject IDocumentationFileExporter and control the relative path published in links.json by @Mpdreamz in #806
- Fix elastic global nav by @reakaleek in #807
- Fix HTMX head changes by @reakaleek in #805
- Add beats/extend folder to assembler navigation by @Mpdreamz in #801
- Fix pages nav behaviour attempt 2 by @reakaleek in #800
- Includes GITHUB_PR_REF_NAME as a job-level environment variable. by @cotti in #799
- Fix "Edit This File" path by @cotti in #790
- Fix pages nav behaviour by @reakaleek in #795
- Ensure we fallback to the embedded navigation.yml for the assembler build by @Mpdreamz in #796
- Add support for custom GitCheckoutInformation in BuildContext by @Mpdreamz in #794
- Only show "Edit this page" link if the url is not
null
by @reakaleek in #792 - Refactor to use
WorkingDirectoryRoot
overRoot
. by @Mpdreamz in #791 - Fix pages navigation appearance by @reakaleek in #787
- Fix table styling by @reakaleek in #789
- Move meta charset up by @reakaleek in #784
- Update detection rule extension to be more feature complete by @Mpdreamz in #782
- Revert "Remove tj-actions usage, eventhough we had it pinned as gitref" by @reakaleek in #766
- Fix/font preload static path by @cotti in #775
- Fix layout and horizontal scrollable tables by @reakaleek in #772
📝 Documentation
- Update frontmatter docs by @reakaleek in #786
🧰 Maintenance
- Rename assembler environment from
production
toprod
by @reakaleek in #798
Full Changelog: 0.20.0...0.21.0
docs-builder 0.20.0
✨ Features
- Add support for diagnostic hints and track unused substitution keys by @Mpdreamz in #762
- Add favicon tags by @reakaleek in #761
- User friendly table design by @reakaleek in #755
- Add content hash as query string to static file paths by @reakaleek in #758
- Refactor TOC handling and support nested TOC configurations by @Mpdreamz in #749
- Add the notion of documentation file exporters. by @Mpdreamz in #739
- Add global elastic.co nav by @reakaleek in #721
- Introduce IUriEnvironmentResolver to resolve crosslinks based on deployment environment by @Mpdreamz in #728
- Assembler share single crosslink resolver over all the builds by @Mpdreamz in #726
- Initial v0 of docs-assembler repos build-all command. by @Mpdreamz in #725
🐛 Bug Fixes
- Fix git information lookup folder, fixes incremental compilation. by @Mpdreamz in #756
- Fix table of contents progress indicator by @reakaleek in #752
- Sidebar nav styling changes by @reakaleek in #751
- Landing page adjustments pt2 by @reakaleek in #750
- Typography adjustments by @reakaleek in #747
- Control allow index per environment, default to false by @Mpdreamz in #745
- Landing page changes by @reakaleek in #746
- Separate static url prefix from path prefix by @Mpdreamz in #744
- Adjust path resolution to enable Windows support. by @cotti in #738
- Fix preview-build.yml by @reakaleek in #742
- Add shift and modifier key handling again by @reakaleek in #740
- Remove hardcoded links to link references, use advertised path from the registry by @Mpdreamz in #735
- Fix code copying in Console blocks by @bmorelli25 in #730
- Fix Exec() not passing name so git clone no longer works in assembler by @Mpdreamz in #727
📝 Documentation
- Fix links to content pattern examples by @karenzone in #729
🧰 Maintenance
⚙️ Automation
- Add matrix to pr workflow by @reakaleek in #425
- Remove tj-actions usage, eventhough we had it pinned as gitref by @Mpdreamz in #753
- Free disk space is no longer needed for asciidocalypse by @Mpdreamz in #743
- Ensure we pass along metadata-only in preview-build to docs-builder action by @Mpdreamz in #741
- Build docs on
master
branches too for repositories not moved over to main by @Mpdreamz in #732 - Update CODEOWNERS by @bmorelli25 in #731
Full Changelog: 0.19.0...0.20.0
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