Skip to content
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

[docs] Clean up cross-repo links #6557

Merged

Conversation

colleenmcginnis
Copy link
Contributor

Follow up to #6554

When using cross-repo links, the path should be relative to the docset.yml not the full path within the repo (updated docs-builder docs).

@colleenmcginnis colleenmcginnis requested a review from a team as a code owner February 28, 2025 19:47
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

Copy link
Contributor

mergify bot commented Feb 28, 2025

This pull request does not have a backport label. Could you fix it @colleenmcginnis? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • v7.x is the label to automatically backport to the 7.x branch.
  • v7./d./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking care of these links, @colleenmcginnis! I did some quick spot-checks and only noticed a few minor things. In addition to the comments that I left below, there is one other link that's not properly resolving in the preview:

Screenshot 2025-02-28 at 3 54 26 PM

Looks like a parentheses is missing from the end of the URL and we might need to move the text before the URL, e.g.:
[Date Math format](https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#date-math)

@colleenmcginnis
Copy link
Contributor Author

Looks like a parentheses is missing from the end of the URL and we might need to move the text before the URL, e.g.:
Date Math format

Feel free to push a commit here or open another PR to fix other syntax issues!

Copy link
Contributor

@nastasha-solomon nastasha-solomon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can open a separate PR to fix the refs to the ES date time page. Thanks again for updating these links!

@colleenmcginnis colleenmcginnis merged commit dcb8811 into elastic:main Mar 3, 2025
5 checks passed
@colleenmcginnis colleenmcginnis deleted the docs-fix-cross-repo-links branch March 3, 2025 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants