Offer Docsy as a single Hugo Module

[chalin]

The intent would be to streamline use of Docsy for Hugo Module users, something which (IMHO) makes sense to do now that Git submodules were removed in 0.4.0, and NPM-package support is available (#949).

@deining - I can't find the thread, but at some point we discussed the possibility of eliminating the dependencies module, which was introduced as a means of addressing:

• Ensure a smooth transition for existing docsy-as-submodule users #848

This issue is to record that intent, and offer a place for discussing it.

Tasks

• Module rework: Offer Docsy as a single Hugo Module #1217
  • Support: How to disable landing page section? #173
• Bootstrap: correct file info #1730
• NPM dependencies: fix dep install timing issue #1738
• User guide updates - Single Hugo-module support: update CHANGELOG and docs #1743
• Changelog entry marking this as a breaking change for Hugo-module users of Docsy - Single Hugo-module support: update CHANGELOG and docs #1743
• User guide: use docsy as module (in workspace) #1731

References

• cmd/go: non-top-level packages ending in "/vendor" are omitted from module zip files golang/go#37397

[chalin]

@deining @geriom - is this something that you might have time to do this quarter, or coach me on how to do it?

[deining]

@deining @geriom - is this something that you might have time to do this quarter, or coach me on how to do it?

Hi Patrice,
I will certainly find time to look into this shortly. I will inform you about the outcomings then. My very first thought is that even after removal of the submodules the situation we are facing is completely the same as before. But I might be wrong here, give me a bit of time to study the new situation and reflect on it.

[chalin]

Thank you @deining! Btw, I'm ok at this point if there isn't a "smooth transition" moving forward for non-Hugo-module projects.

[deining]

The intent would be to streamline use of Docsy for Hugo Module users, something which (IMHO) makes sense to do now

I agree.

I'm ok at this point if there isn't a "smooth transition" moving forward for non-Hugo-module projects.

Great. that makes things a lot easier.

I worked on this issue (see PR #1217) and ended up with a consolidation of the two modules into one single docsy module, as proposed. With this PR applied, I can successfully run docsy from one single consolidated module. As expected, this single module isn't compatible and breaks existing installations based on npm or git submodules (see log of failed Netlify preview).

This issue is to record that intent, and offer a place for discussing it.

I hope my PR can serve as a good starting point for our discussion.

[chalin]

Tasks

• Module rework: Add support for Algolia DocSearch #127
• User guide updates
• Changelog entry marking this as a breaking change for Hugo-module users of Docsy

Now that #1217 is in, can you work on the other tasks too @deining?

[deining]

Now that #1217 is in, can you work on the other tasks too @deining?

Yes, I try to find time during to work on that during the weekend.

[chalin]

@deining - FYI, I've address the remaining tasks for this issue, PTAL at:

• Single Hugo-module support: update CHANGELOG and docs #1743