Update multi-page navigation to allow custom path prefix #136
Conversation
Currently if the tech-docs is deployed on a path (e.g. `https://alphagov.github.io/api-catalogue/`) the navigation links are broken as they are generated from root (`/`). One way to avoid this without affecting current single-page or multi-page configuration is to define a `path_prefix` in config that is prepended to each link.
alex-ju
changed the title
alex-ju
changed the title
I thought a lot about that, but not sure where it fits as the test suite currently relies on one configuration file. This change will require a separate config and not sure where to accommodate that. Open to suggestions. |
There was a problem hiding this comment.
I think what you've built here has already been done in another PR: #79
I don't see how this differs to http_prefix 🤔 and if http_prefix isn't doing what we want, it's probably a bug in its implementation and we should fix that rather than add a new property.
As for tests, we can define separate config & tests inside helpers_spec.rb.
I may be missing some context here - let me know if you'd like to pair on it this week! 😊
Ha, I haven't thought about that - I saw it as more of a way to specify the protocol (http/https). I'll give it a go, if it doesn't work I would really appreciate a hand, thank you! |
|
I agree the naming could be better! |
|
As mentioned in the comments – this seems to have been addressed already. |
|
This is still a problem – maybe #84 will fix it. |
Currently if the tech-docs is deployed on a path (e.g.
https://alphagov.github.io/api-catalogue/) the navigation links are broken as they are generated from root (/). One way to avoid this without affecting current single-page or multi-page configuration is to define apath_prefixin config that is prepended to each link.This is an attempt to fix #128 which is currently blocking any deployment for the api-catalogue.
I'm open to any other suggestions that will unblock this - especially since I'm not familiar with this project or Middleman.
Note: I needed to refactor the conditional statements as linter was complaining about the code having too many lines (
Metrics/BlockLength: Block has too many lines. [31/25])