rubygems / gemstash

A RubyGems.org cache and private gem server
MIT License
752 stars 120 forks source link

Documentation bug: broken link to detailled protected fetch #322

Open kalsan opened 1 year ago

kalsan commented 1 year ago

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 commented 3 weeks ago

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 commented 3 weeks ago

@johnTurknett no update from my side :-(

johnTurknett commented 3 weeks ago

@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 commented 3 weeks ago

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 commented 3 weeks ago

👋 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. https://github.com/rubygems/gemstash/pull/399 - and perhaps especially https://github.com/rubygems/gemstash/pull/399/commits/2ff4a7b925d7a35922e7442ae6231907be711865 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 commented 3 weeks ago

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