Flatten remaining user-guide subtrees (partial fix for #1044 #1051) - #12817
Flatten remaining user-guide subtrees (partial fix for #1044 #1051)#12817OVI3D0 wants to merge 3 commits into
Conversation
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). |
…ith-workloads/ (PR C2) This is PR C2 in the flatten stack (C1 landed as opensearch-project#12788). Continues esrally-style flattening: collapse deep user-guide subtrees into top-level pages under _benchmark/. Files moved from _benchmark/user-guide/optimizing-benchmarks/ to _benchmark/: - distributed-load.md - expand-data-corpus.md - performance-testing-best-practices.md - randomizing-queries.md - target-throughput.md Files moved from _benchmark/user-guide/working-with-workloads/ to _benchmark/: - running-workloads.md - creating-custom-workloads.md - finetune-workloads.md - contributing-workloads.md target-throughput.md and the working-with-workloads/ pages had existing redirect_from entries; those are preserved and each moved file picks up an additional redirect_from for its just-vacated subtree path. creating-custom-workloads.md dropped its redundant redirect_from entry for /benchmark/creating-custom-workloads/ since that is now the file's canonical permalink. Three landing pages deleted: - _benchmark/user-guide/optimizing-benchmarks/index.md - _benchmark/user-guide/understanding-results/index.md - _benchmark/user-guide/working-with-workloads/index.md The understanding-results/ subtree only had this landing page left after PR opensearch-project#12394 (telemetry unification) and PR opensearch-project#12734 (summary-report consolidation) moved the other pages out. The User guide index (_benchmark/user-guide/index.md) had three cards pointing at the just-deleted landing pages. They now point at canonical successor pages: reference/summary-report/ (analyze results), performance-testing-best-practices/ (optimization), and running-workloads/ (run and customize). Also cleaned up a few lingering absolute links pointing at the pre-C2 paths in anatomy-of-a-workload.md, choosing-a-workload.md, and _benchmark/index.md. The redirect_from entries would have kept them working, but the new paths are cleaner. Partial fix for opensearch-project/opensearch-benchmark#1044 opensearch-project/opensearch-benchmark#1051 After this PR, the User guide subtree is reduced to just _benchmark/user-guide/concepts.md and _benchmark/user-guide/install-and-configure/, which are candidates for a follow-up PR C3 if maintainers want to flatten further. Local Jekyll build with JEKYLL_LINK_CHECKER=internal completed cleanly (exit 0, zero errors, zero warnings). Signed-off-by: Michael Oviedo <mikeovi@amazon.com>
f5ee678 to
49e6112
Compare
|
@kolchfa-aws ready for review! cc @rishabh6788 |
|
@OVI3D0 When you move pages, you need to add redirects from any page that you deleted to an existing page. If an index page is deleted, we need to add a redirect to one of the surviving pages. I added those as part of the doc review. Also, reordered the pages in the top-level nav as follows: OpenSearch Benchmark For now, I left vector search on the top level, but it's a workload type and it belongs with the other workload types. So I would restructure as follows, keeping in mind that the current Anatomy of a workload and Workload reference have some overlap: |
Signed-off-by: Fanit Kolchina <kolchfa@amazon.com>
Description
PR C2 in the flatten stack. C1 (#12788) landed and this continues the same esrally-inspired approach: collapse deep
_benchmark/user-guide/*subtrees into top-level pages under_benchmark/.This PR now covers the remaining user-guide subtrees in a single change (previously planned as separate C2 and C3 PRs). Combined, they are still small: 16 files touched, +31/-102 lines.
Files moved
From
_benchmark/user-guide/optimizing-benchmarks/→_benchmark/:distributed-load.mdexpand-data-corpus.mdperformance-testing-best-practices.mdrandomizing-queries.mdtarget-throughput.mdFrom
_benchmark/user-guide/working-with-workloads/→_benchmark/:running-workloads.mdcreating-custom-workloads.mdfinetune-workloads.mdcontributing-workloads.mdEach moved file has a
redirect_fromentry for its just-vacated subtree path. Files that already hadredirect_fromentries (target-throughput.md, the working-with-workloads pages) preserve them and pick up the new one.creating-custom-workloads.mdalso drops a redundant self-referentialredirect_fromentry that pointed at its new canonical URL.Files deleted
_benchmark/user-guide/optimizing-benchmarks/index.md(subtree landing page)_benchmark/user-guide/understanding-results/index.md(subtree landing page — this directory was already empty after #12394 unified telemetry and #12734 consolidated summary-report)_benchmark/user-guide/working-with-workloads/index.md(subtree landing page)Cross-references updated
Three cards in
_benchmark/user-guide/index.mdpointed at the just-deleted landing pages. They now point at canonical successor pages:reference/summary-report/performance-testing-best-practices/running-workloads/Also cleaned up a few lingering absolute links in
anatomy-of-a-workload.md,choosing-a-workload.md, and_benchmark/index.mdthat pointed at the pre-C2 paths. Theredirect_fromentries would have kept them working, but the new paths are cleaner.Issues Resolved
Partial fix for:
After this PR, the
_benchmark/user-guide/subtree contains onlyconcepts.mdandinstall-and-configure/— candidates for a follow-up PR if maintainers want to flatten further.Version
all
Validation
JEKYLL_LINK_CHECKER=internalcompleted cleanly (exit 0, zero errors, zero warnings).redirect_fromstubs that meta-refresh to the canonical new URLs.redirect_fromentries).Checklist