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

Documentation file howto-guides/claim-and-run-jobs.md contains a broken link #820

Closed
eecavanna opened this issue Dec 8, 2024 · 3 comments · Fixed by #847
Closed

Documentation file howto-guides/claim-and-run-jobs.md contains a broken link #820

eecavanna opened this issue Dec 8, 2024 · 3 comments · Fixed by #847
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@eecavanna
Copy link
Collaborator

eecavanna commented Dec 8, 2024

Describe the bug

From the Mkdocs build output:

WARNING -  Doc file 'howto-guides/claim-and-run-jobs.md' contains a link 'guide-create-triggers.md', but the target 'howto-guides/guide-create-triggers.md' is not found among documentation files.

To Reproduce

Steps to reproduce the behavior:

  1. Go to https://microbiomedata.github.io/nmdc-runtime/howto-guides/claim-and-run-jobs/
  2. Click on the link that says "Guide - Create Workflow Triggers To Spawn Jobs"
  3. See error page

Expected behavior

User story:

AS A user,
INSTEAD OF seeing at an error page when I clicked the link,
I EXPECTED to see a page about creating triggers

Screenshots

Here's the broken link:

image

Here's the error page it leads to:

image

@eecavanna eecavanna added bug Something isn't working documentation Improvements or additions to documentation labels Dec 8, 2024
@eecavanna eecavanna changed the title Documentation howto-guides/claim-and-run-jobs.md contains a broken link Documentation file howto-guides/claim-and-run-jobs.md contains a broken link Dec 8, 2024
@eecavanna eecavanna added the good first issue Good for newcomers label Dec 8, 2024
@Brijeshthummar02
Copy link

@eecavanna can you show me the path to file where it should be changed and also correct link for it, thanks.

@eecavanna
Copy link
Collaborator Author

eecavanna commented Dec 8, 2024

Hi @Brijeshthummar02,

can you show me the path to file where it should be changed

A relative path to the Markdown file containing the broken link is listed in the first part of the warning message above:

WARNING -  Doc file 'howto-guides/claim-and-run-jobs.md' contains [...]

That path is relative to the following base directory in this repository: docs/

So, the full path to that file in this repository is:

https://github.com/microbiomedata/nmdc-runtime/blob/main/docs/howto-guides/claim-and-run-jobs.md

and also correct link for it

I assume the author intended for the link to point here:

https://github.com/microbiomedata/nmdc-runtime/blob/main/docs/howto-guides/create-triggers.md

Looks like there is an extra guide- in the URL currently in use in the Markdown file, per the warning message above:

[...] a link 'guide-create-triggers.md'

@Brijeshthummar02
Copy link

@eecavanna pr #823 according to me will point to perfect file.

dwinston added a commit that referenced this issue Dec 17, 2024
closes #820
closes #821
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
2 participants