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 bug: broken link to detailled protected fetch #322

Open
kalsan opened this issue Dec 5, 2022 · 6 comments
Open

Documentation bug: broken link to detailled protected fetch #322

kalsan opened this issue Dec 5, 2022 · 6 comments

Comments

@kalsan
Copy link

kalsan commented Dec 5, 2022

In [1], the link [2] is broken.

[1] https://github.com/rubygems/gemstash/blob/master/docs/gemstash-customize.7.md

[2] More details on protected_fetch are here.

@johnTurknett
Copy link

I came to report this same thing. It's sad to see it unresolved based on the original post date. @kalsan Did you ever find the information you needed?

@kalsan
Copy link
Author

kalsan commented Aug 28, 2024

@johnTurknett no update from my side :-(

@johnTurknett
Copy link

@kalsan If you have not seen it, This Page seems to have the relevant information. I have not walked through it yet, but it looks promising.

@kalsan
Copy link
Author

kalsan commented Aug 29, 2024

Thanks @johnTurknett !

Indeed, seems like the link should be updated to https://github.com/rubygems/gemstash/blob/main/docs/gemstash-private-gems.7.md#protected-fetching

I'll let the maintainers decide though.

@olleolleolle
Copy link
Member

olleolleolle commented Aug 29, 2024

👋 A note from a maintainer.

The man directory holds source Markdown, from which the docs/ directory gets its information.

The source document's link is relative: it points to the neighboring document, if one clicks that link, one is taken to the "protected fetching" section.
https://github.com/rubygems/gemstash/blob/main/man/gemstash-customize.7.md

The generation of the documentation is a rake task which kicks off a few pandoc jobs and others.

The issue Perhaps some too-large nesting is done when generating the Markdown for the docs/ directory.

Related, with an example of the generated docs: I recently did a PR about the generation of those pages. #399 - and perhaps especially 2ff4a7b which is a regeneration commit.

PS: I realize this is not what you were seeking, but perhaps some of this helps you find/fix things.

@johnTurknett
Copy link

@olleolleolle Thank you for taking the time to provide some insight.

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

No branches or pull requests

3 participants