You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Release notes script: change output from asciidoc to json logstash#13492
The new docs system is coming. We're breaking down product silos, and release notes/feature highlights/what's new will have a Elastic (not product) focus. The content will be easily searchable and filterable. The move to json output for release notes is an important milestone toward this effort.
Why? Plugins are not versioned, and all changes come from main. When we have mismatches with content in older versions, I have to remove regressions manually. The original design intent is that no new content gets picked up unless accompanied by a version bump. Re-implementing that behavior would solve this issue. Sample of manual workflow: Updated docs for 6.8 with regressions removed logstash-docs#1264
@roaksoax I opened the docs tooling meta issue as you requested. I'll flesh it out with more details and description soon. At least now it won't be as easy to lose or forget. :-)
karenzone
changed the title
[Meta] Enhancements and fixes to doc tooling
[Meta] Enhancements and fixes to Logstash doc tooling
May 3, 2021
Here's a list of fixes and enhancement requests that could save time, reduce risk of human error, and improve the quality of our documentation.
Strategic enhancements:
The new docs system is coming. We're breaking down product silos, and release notes/feature highlights/what's new will have a Elastic (not product) focus. The content will be easily searchable and filterable. The move to json output for release notes is an important milestone toward this effort.
Priority fixes/enhancements:
main
. When we have mismatches with content in older versions, I have to remove regressions manually. The original design intent is that no new content gets picked up unless accompanied by a version bump. Re-implementing that behavior would solve this issue. Sample of manual workflow: Updated docs for 6.8 with regressions removed logstash-docs#1264Important fixes:
FAILURE
#43Reevaluate and triage:
The text was updated successfully, but these errors were encountered: