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] Remove broken link to Cloud API doc #679

Merged
merged 1 commit into from
Nov 26, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented Nov 26, 2024

Description

The ECCTL documentation references en/cloud/current/definitions.html#KeystoreContents which no longer exists now that we're generating documentation directly from OpenAPI. In particular if a link is still required, it should go to the appropriate endpoint, such as https://www.elastic.co/docs/api/doc/cloud/operation/operation-set-deployment-es-resource-keystore. Schema objects are no longer published separate from where they're used.

Related Issues

Fixes #678

Motivation and Context

Documentation build failures.

How Has This Been Tested?

Types of Changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Refactoring (improves code quality but has no user-facing effect)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation

Readiness Checklist

  • My code follows the code style of this project
  • My change requires a change to the documentation
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • All new and existing tests passed

@lcawl lcawl requested review from alaudazzi and a team as code owners November 26, 2024 01:08
@lcawl lcawl requested a review from a team November 26, 2024 01:28
@leemthompo leemthompo merged commit 6041fdd into elastic:master Nov 26, 2024
3 checks passed
florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.14

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.13

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.12

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.11

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.10

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.9

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.8

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.7

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/ecctl that referenced this pull request Nov 26, 2024
@florent-leborgne
Copy link

💚 All backports created successfully

Status Branch Result
1.6

Questions ?

Please refer to the Backport tool documentation

@florent-leborgne
Copy link

Created backports since it seems this is affecting several versions:

INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.10/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.11/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.12/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.13/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.14/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.6/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.7/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.8/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/1.9/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/current/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents INFO:build_docs: /tmp/docsbuild/target_repo/html/en/ecctl/master/ecctl_deployment_elasticsearch_keystore_update.html contains broken links to: INFO:build_docs: - en/cloud/current/definitions.html#KeystoreContents

florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
florent-leborgne added a commit that referenced this pull request Nov 26, 2024
(cherry picked from commit 6041fdd)

Co-authored-by: Lisa Cawley <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOCS] Broken links
3 participants