logstash icon indicating copy to clipboard operation
logstash copied to clipboard

Doc: Publish Logstash docs from non-main branch

Open karenzone opened this issue 8 months ago • 1 comments

Related:

  • https://github.com/elastic/docs-projects/issues/490
  • Prior art: https://github.com/elastic/docs-projects/issues/491

This is the process we'd follow to start publishing from the 9.0 branch.

Prep

Make sure all relevant docs updates have been backported to 9.0.

Configure

  • [x] Open a PR updating CI triggers (docs) (https://github.com/elastic/logstash/pull/17700)
    • [x] https://github.com/elastic/logstash/pull/17705
  • [x] Merge to main and the intended version branch (9.0)
  • [x] Ensure the docs build
    • [x] https://docs-v3-preview.elastic.dev/elastic/logstash/tree/9.0/reference/. 🎉
  • [x] Open a PR updating assembler.yml (https://github.com/elastic/docs-builder/pull/1346):
    logstash:
        current: "9.0"
        next: main
    
    • [x] Add the ci label to the PR.
    • [ ] Confirm that the 9.0 branch is publishing to the link service: https://elastic-docs-link-index.s3.us-east-2.amazonaws.com/elastic/logstash/9.0/links.json
    • [ ] Rerun ci / validate-assembler (pull_request) in the PR
    • [ ] Merge when docs eng approves and all checks pass
  • [ ] Docs eng release docs-builder

karenzone avatar Jun 05 '25 22:06 karenzone

I added a couple more items/subitems to the list based on my experience with the beats repo. (Trying to help out our future selves who might do this for other repos!)

colleenmcginnis avatar Jun 11 '25 15:06 colleenmcginnis

@colleenmcginnis, I added a validation step and looked here:

Image

Then I noticed that all docs (including Beats) are set to 9.0+. Should I be validating the change to Logstash publishing another way? If all docs are set to 9.0+, were these steps necessary?

karenzone avatar Jun 18 '25 13:06 karenzone

Then I noticed that all docs (including Beats) are set to 9.0+. Should I be validating the change to Logstash publishing another way? If all docs are set to 9.0+, were these steps necessary?

The dropdown always says 9.0+ for Stack versioned pages regardless of which branch it's being published from. To validate that it's working, you'll have to find a page that has different content in main and 9.0.

colleenmcginnis avatar Jun 18 '25 14:06 colleenmcginnis

@karenzone is there anything left to do here?

colleenmcginnis avatar Jun 25 '25 16:06 colleenmcginnis

@karenzone is there anything left to do here?

Just to validate it. I've missed several opportunities because of my fast-follow backport habit.

karenzone avatar Jun 25 '25 16:06 karenzone