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

Configure build for Github pages #97

Merged
merged 2 commits into from
Oct 2, 2020
Merged

Configure build for Github pages #97

merged 2 commits into from
Oct 2, 2020

Conversation

odlp
Copy link
Contributor

@odlp odlp commented Oct 1, 2020

Changes:

  • Configure Middleman to apply a http_prefix of /api-catalogue/ when building (for Github Pages compatibility)
  • Use absolute links & asset paths throughout (instead of relative)
  • Switch to a branch of tech-docs-gem which adds http_prefix support (fixes Search, ToC, and asset paths)

Forms part of #95

@odlp odlp changed the title Fix build for Github pages Configure build for Github pages Oct 1, 2020
Base automatically changed from ft-csv-build to master October 2, 2020 08:18
odlp added 2 commits October 2, 2020 09:20
This allows us to build the site with absolute URLs (rather than relative)
and have features like search working without post-build edits.
This moves us closer to an automated build.

Builds need to consider the http-prefix because Github pages for repo-specific
sites include the repo name in the first segement of the path, e.g:
https://alphagov.github.io/api-catalogue/

The fork of tech-docs-gem is intended to be temporary, until fixes for issues
documented here have been resolved & merged upstream:
#95
@odlp odlp force-pushed the ft-support-http-prefix branch from 8fef8c4 to 902c3f5 Compare October 2, 2020 08:20
@odlp odlp marked this pull request as ready for review October 2, 2020 08:44
@odlp odlp merged commit e7a8671 into master Oct 2, 2020
@odlp odlp deleted the ft-support-http-prefix branch October 2, 2020 15:44
duncanjbrown added a commit to DFE-Digital/dfe-job-descriptions that referenced this pull request May 26, 2022
middleman build (ie prod builds) will override the default to respect
the github pages path

Crib from co-cddo/api-catalogue#97
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

Successfully merging this pull request may close these issues.

2 participants