Doc: Publish Logstash docs from non-main branch
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
mainand 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
cilabel 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
- [x] Add the
- [ ] Docs eng release docs-builder
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, I added a validation step and looked here:
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?
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.
@karenzone is there anything left to do here?
@karenzone is there anything left to do here?
Just to validate it. I've missed several opportunities because of my fast-follow backport habit.