-
Notifications
You must be signed in to change notification settings - Fork 261
Restructure reference docs #988
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Errors reported in the doc-build/preview/build check will be fixed by elastic/docs-content#1071 |
The backport to
To backport manually, run these commands in your terminal: # Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-9.0 9.0
# Navigate to the new working tree
cd .worktrees/backport-9.0
# Create a new branch
git switch --create backport-988-to-9.0
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick --mainline 1 c8908c84c7f8e763686e3bc6163584a1e9cd70a6
# Push it to GitHub
git push --set-upstream origin backport-988-to-9.0
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-9.0 Then, create a pull request where the |
@swallez @l-trotta I only just realized this was merged in with docs build errors 😦 (https://github.com/elastic/elasticsearch-java/actions/runs/14374038419/job/40302335689) ... I'm working on fixing this now, but for future reference, this kind of restructuring needs a redirects.yml file: https://elastic.github.io/docs-builder/contribute/redirects/ |
(link was wrong, fixed now) |
In elastic/elasticsearch-java#988 we restructure the 9.x Java client docs to re-instate the folder structure we had with asciidoc along with adding docs for new 9.0 features. Because of this, some references to the Java docs will need to be updated once that PR is merged. This PR fixes this. Co-authored-by: Marci W <333176+marciw@users.noreply.github.com>
Troubleshooting content for the clients has moved back to the client docs repos. This PR makes corresponding changes in docs-content. Related PRs: elastic/elasticsearch-java#988 elastic/elasticsearch-js#2727 elastic/elasticsearch-net#8490 elastic/elasticsearch-ruby#2628 elastic/elasticsearch-js#2729
sorry @marciw, we were convinced the build errors were because of the missing pr on the docs side, not the opposite |
thanks @l-trotta -- no worries. When files move around, it creates a chicken-and-egg issue with inbound link validation in the docs build. So a For this one, I opened #997 |
Restructure the reference documentation to have a file hierarchy that follows the documentation structure.