Skip to content

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

Merged
merged 14 commits into from
Apr 10, 2025
Merged

Restructure reference docs #988

merged 14 commits into from
Apr 10, 2025

Conversation

swallez
Copy link
Member

@swallez swallez commented Apr 8, 2025

Restructure the reference documentation to have a file hierarchy that follows the documentation structure.

@swallez swallez added backport 9.0 Area: Documentation Improvements or additions to documentation labels Apr 8, 2025
@swallez swallez changed the title [WIP] Restructure reference docs Restructure reference docs Apr 9, 2025
@swallez swallez requested a review from l-trotta April 9, 2025 17:16
@swallez
Copy link
Member Author

swallez commented Apr 10, 2025

Errors reported in the doc-build/preview/build check will be fixed by elastic/docs-content#1071

@swallez swallez merged commit c8908c8 into main Apr 10, 2025
7 of 8 checks passed
@swallez swallez deleted the reference-docs branch April 10, 2025 08:15
Copy link

The backport to 9.0 failed:

The process '/usr/bin/git' failed with exit code 1

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 base branch is 9.0 and the compare/head branch is backport-988-to-9.0.

@marciw
Copy link
Contributor

marciw commented Apr 11, 2025

@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/

@marciw
Copy link
Contributor

marciw commented Apr 11, 2025

... 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)

marciw added a commit to elastic/docs-content that referenced this pull request Apr 11, 2025
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>
marciw added a commit to elastic/docs-content that referenced this pull request Apr 11, 2025
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
@l-trotta
Copy link
Contributor

sorry @marciw, we were convinced the build errors were because of the missing pr on the docs side, not the opposite

@marciw
Copy link
Contributor

marciw commented Apr 15, 2025

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 redirects.yml file is needed: https://elastic.github.io/docs-builder/contribute/redirects/
(see also https://elastic.github.io/docs-builder/contribute/move/)

For this one, I opened #997

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Documentation Improvements or additions to documentation backport 9.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants