Skip to content

Conversation

reakaleek
Copy link
Member

@reakaleek reakaleek commented Jan 10, 2025

Closes #162

Context

For our Links Validation Service, we need to generate a list of cross-links (links pointing to external documentation in our system) that will be uploaded to the Link Index.

Changes

Add external links to the links.json

Resulting JSON file:

{
  "origin": {
    "branch": "feature/add-external-links",
    "remote": "elastic/docs-builder-unknown",
    "ref": "03c22a29e6585b72f64a0aa64f087dd5664c939f"
  },
  "url_path_prefix": "",
  "internal_links": [
    "index.md",
    "configure/index.md",
    "configure/page.md",
    "testing/external-links.md",
    "...",
  ],
  "cross_links": [
    "kibana://index.md",
    "elasticsearch://index.md"
  ]
}

Notes

Changed the naming to Cross-Links, so it won't get confused with external hosts.

@reakaleek reakaleek requested a review from Mpdreamz January 10, 2025 20:28
@reakaleek reakaleek self-assigned this Jan 10, 2025
@reakaleek reakaleek marked this pull request as ready for review January 10, 2025 20:29
@reakaleek reakaleek changed the title Add exteranl links to links.json Add external links to links.json Jan 10, 2025
@reakaleek reakaleek changed the title Add external links to links.json Add cross links to links.json Jan 10, 2025
@reakaleek reakaleek changed the title Add cross links to links.json Add cross-links to links.json Jan 10, 2025
Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

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

Small nit otherwise LGTM! nice work!

Copy link
Member

@Mpdreamz Mpdreamz left a comment

Choose a reason for hiding this comment

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

Lgtm!

@reakaleek reakaleek merged commit fbd89ea into main Jan 13, 2025
3 checks passed
@reakaleek reakaleek deleted the feature/external-links-v2 branch January 13, 2025 09:11
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.

Add cross-links to links.json artifact
2 participants