Skip to content

[DOCS] Work around broken links#97910

Merged
jrodewig merged 1 commit intoelastic:8.9from
lcawl:89-workaround
Jul 24, 2023
Merged

[DOCS] Work around broken links#97910
jrodewig merged 1 commit intoelastic:8.9from
lcawl:89-workaround

Conversation

@lcawl
Copy link
Contributor

@lcawl lcawl commented Jul 24, 2023

Relates to elastic/docs#2722, #96415

This PR provides a work-around for the following broken links:

13:40:21 INFO:build_docs:Bad cross-document links:
13:40:21 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/8.9/api-reference.html contains broken links to:
13:40:21 INFO:build_docs:   - en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html
13:40:21 INFO:build_docs:   - en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html
13:40:21 INFO:build_docs:  /tmp/docsbuild/target_repo/html/en/elasticsearch/client/javascript-api/current/api-reference.html contains broken links to:
13:40:21 INFO:build_docs:   - en/elasticsearch/reference/8.9/security-api-create-cross-cluster-api-key.html
13:40:21 INFO:build_docs:   - en/elasticsearch/reference/8.9/security-api-update-cross-cluster-api-key.html

@github-actions
Copy link
Contributor

Documentation preview:

@lcawl lcawl added >docs General docs changes Team:Docs Meta label for docs team v8.9.0 labels Jul 24, 2023
@lcawl lcawl marked this pull request as ready for review July 24, 2023 21:03
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

@lcawl lcawl requested a review from a team July 24, 2023 21:15
Copy link
Contributor

@jrodewig jrodewig left a comment

Choose a reason for hiding this comment

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

Approved. The text could be improved, but I don't think we should block the release over it.

[role="exclude",id="security-api-create-cross-cluster-api-key"]
=== Create Cross-Cluster API key API

{es-feature-flag}
Copy link
Contributor

@jrodewig jrodewig Jul 24, 2023

Choose a reason for hiding this comment

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

The text for this attribute doesn't really make sense here:

This feature is in development and not yet available for use. This documentation is provided for informational purposes only.

There is no "documentation" in this case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

True. I thought that was a better stop-gap than referring to master docs for now, but hopefully there will be a quick fix and we can remove these redirects entirely.

@jrodewig
Copy link
Contributor

@lcawl I'm going to merge this in and kick off a fresh build for elastic/docs#2722.

Thanks again!

@jrodewig jrodewig merged commit 995d95d into elastic:8.9 Jul 24, 2023
@lcawl lcawl deleted the 89-workaround branch July 24, 2023 23:54
lcawl added a commit to lcawl/elasticsearch that referenced this pull request Jul 25, 2023
lcawl added a commit that referenced this pull request Jul 26, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes Team:Docs Meta label for docs team v8.9.0 v8.9.1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants