Releases: elastic/docs-builder
Releases · elastic/docs-builder
docs-builder 0.27.0
✨ Features
- Add update-link-index-all command by @reakaleek in #963
🐛 Bug Fixes
- Revert to original implementation with s3client by @reakaleek in #970
- Use SHA256 checksum algorithm while uploading link reference by @reakaleek in #969
- Use temporary folder for output in update-all-link-reference command by @reakaleek in #967
- Fix misplaced guard for checking for updates on CI by @Mpdreamz in #966
- Add rust back as supported language by @Mpdreamz in #965
Full Changelog: 0.26.1...0.27.0
docs-builder 0.26.1
🐛 Bug Fixes
Full Changelog: 0.26.0...0.26.1
docs-builder 0.26.0
✨ Features
🐛 Bug Fixes
- Use CrtChecksums explicitly to download S3 objects inside lambda function by @Mpdreamz in #961
- Fix table header appearance when a cell is empty by @reakaleek in #958
Full Changelog: 0.25.1...0.26.0
docs-builder 0.25.1
🐛 Bug Fixes
- Use github.event.release.tag_name explicitly during release workflow to upload artifacts by @Mpdreamz in #960
Full Changelog: 0.25.0...0.25.1
docs-builder 0.25.0
✨ Features
- Redirect to first markdownfile on serve command in case index.md doesn't exist by @reakaleek in #956
- All L1 navigation links are now collapsed by default by @reakaleek in #951
- Update link registry listings to include git reference by @Mpdreamz in #947
- Add support for Myst inline role syntax with applies_to as first usecase by @Mpdreamz in #875
- Add archive easter egg by @reakaleek in #896
- Add content_source (current/next) to assembler by @Mpdreamz in #894
- Add 'archive' layout by @reakaleek in #892
- Previous version links on document pages with mapped entries in front matter by @cotti in #876
🐛 Bug Fixes
- Fix copy-paste of code blocks with code callouts by @reakaleek in #946
- Fix same page anchor links by @reakaleek in #944
- Resolve links in link parser using MarkdownFile.Url if available by @Mpdreamz in #941
- Fix sticky footer by @reakaleek in #900
📝 Documentation
- Provides syntax for subscript & superscript examples by @natasha-moore-elastic in #886
🧰 Maintenance
- Add prettier sort import plugin by @reakaleek in #945
- Downgrade xUnit v3 to 1.1.0 by @Mpdreamz in #942
- Bump Markdig from 0.39.1 to 0.40.0 by @dependabot[bot] in #924
- Bump xunit.v3 from 1.1.0 to 2.0.0 by @dependabot[bot] in #922
- Bump Markdig from 0.39.1 to 0.40.0 in /src/Elastic.Markdown.Refactor by @dependabot[bot] in #925
- Bump NetEscapades.EnumGenerators from 1.0.0-beta11 to 1.0.0-beta12 by @dependabot[bot] in #923
- Bump actions/github-script from 6 to 7 in /.github/workflows by @dependabot[bot] in #909
- Bump actions/github-script from 6 to 7 by @dependabot[bot] in #902
- Bump typescript-eslint from 8.28.0 to 8.29.0 in /src/Elastic.Markdown by @dependabot[bot] in #912
- Bump SoftCircuits.IniFileParser from 2.6.0 to 2.7.0 by @dependabot[bot] in #913
- Bump aws-actions/configure-aws-credentials from 4.0.2 to 4.1.0 in /actions/update-link-index by @dependabot[bot] in #911
- Bump Microsoft.Extensions.Logging and Microsoft.Extensions.Logging.Console by @dependabot[bot] in #915
- Bump Octokit from 13.0.1 to 14.0.0 by @dependabot[bot] in #916
- Bump Westwind.AspNetCore.LiveReload from 0.5.0 to 0.5.2 by @dependabot[bot] in #917
- Bump coverlet.collector from 6.0.0 to 6.0.4 by @dependabot[bot] in #918
- Bump tailwindcss from 4.0.17 to 4.1.0 in /src/Elastic.Markdown by @dependabot[bot] in #907
- Bump aws-actions/configure-aws-credentials from 4.0.2 to 4.1.0 in /.github/actions/aws-auth by @dependabot[bot] in #906
- Bump release-drafter/release-drafter from 6.0.0 to 6.1.0 by @dependabot[bot] in #905
- Bump mheap/github-action-required-labels from 5.4.1 to 5.5.0 by @dependabot[bot] in #904
- Bump @tailwindcss/postcss from 4.0.3 to 4.1.0 in /src/Elastic.Markdown by @dependabot[bot] in #903
- Update dependabot.yml by @reakaleek in #914
- Fix dependabot config by @reakaleek in #901
- Add nuget and github-actions to dependabot config by @reakaleek in #893
⚙️ Automation
Full Changelog: 0.24.0...0.25.0
docs-builder 0.24.0
✨ Features
- Add anchors in landing page by @reakaleek in #867
- Add landing overview page for detection rules. by @Mpdreamz in #868
- Optimize hljs by @reakaleek in #864
- Add a modal for images to expand to upon being clicked instead of leaving the current page by @cotti in #858
- Extend navigation validate command to check publish links by @Mpdreamz in #850
- Remove image from landing page by @reakaleek in #855
- 404: Make clear it's linking to the docs home page by @reakaleek in #856
- Update
navigation.yml
by @colleenmcginnis in #845 - Add navigation build commands to assembler: 'validate' and 'validate-link-reference' by @Mpdreamz in #848
- Add ability to set different Google Tag Manager snippets for each environment by @reakaleek in #846
🐛 Bug Fixes
- Fix CurrentUrlPath being empty on deeply nested snippets by @Mpdreamz in #887
- Add extension method for relative path trimming when using ReadOnlySpan by @cotti in #888
- Only filter out detection rules that are within an '_deprecated' folder by @reakaleek in #885
- Fix sub-path resolution in DiagnosticLinkInlineParser by @Mpdreamz in #884
- Correct landing page wording for the cloud account section by @florent-leborgne in #882
- Add elastic/detection-rules to assembler navigation.yml by @colleenmcginnis in #857
- Update landing page links by @reakaleek in #871
- Fix relative links by @reakaleek in #861
- Keep track of navigation source on markdown files for easier root navigation lookups in assembler by @Mpdreamz in #862
- Fix page switcher dropdown on safari by @reakaleek in #860
- Path prefix duplication detection in navigation.yml by @Mpdreamz in #844
- Protect against asciidoc headers by @Mpdreamz in #843
- Sticky footer by @reakaleek in #841
🧰 Maintenance
- Set up prettier by @reakaleek in #883
- Bump select-dom from 9.3.0 to 9.3.1 in /src/Elastic.Markdown by @dependabot in #878
- Bump parcel from 2.14.2 to 2.14.4 in /src/Elastic.Markdown by @dependabot in #880
- Bump postcss from 8.5.1 to 8.5.3 in /src/Elastic.Markdown by @dependabot in #881
- Bump ua-parser-js from 2.0.2 to 2.0.3 in /src/Elastic.Markdown by @dependabot in #879
- Bump tailwindcss from 4.0.3 to 4.0.17 in /src/Elastic.Markdown by @dependabot in #877
- Pin dependencies and configure dependabot by @reakaleek in #870
- Set up eslint by @reakaleek in #872
⚙️ Automation
- Add validate-path-prefixes-local to preview-build workflow by @Mpdreamz in #851
- Add local prefix validation action to solution by @Mpdreamz in #849
- Ensure we checkout before build/releasing our lamdba binary by @Mpdreamz in #842
Full Changelog: 0.23.0...0.24.0
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