-
Notifications
You must be signed in to change notification settings - Fork 33
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
Automate build & deployment #95
Comments
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
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
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
Update: The build & publishing process is now automated. I'm leaving this issue open so we can track the status of fixes we want to contribute upstream (so we can switch back to the vanilla |
Since #131 this project no longer relies on the Tech Docs gem. Unfortunately some of the PRs with bugfixes haven't been accepted yet, but I'm closing this issue because it's no longer a dependency. |
To automate the build we need to correct a few issues which appear to hand-corrected post-build at the moment
http_prefix
/ absolute asset pathshttp_prefix
- Search: Support Github pages / http_prefix alphagov/tech-docs-gem#196http_prefix
- fix: generate multipage TOC with http_prefix alphagov/tech-docs-gem#84http_prefix
- Assets: Support Github pages / http_prefix alphagov/tech-docs-gem#197These all stem from the fact that Github pages for a particular repo, rather than the organisation, have the repo name as the first segment of the path (e.g.
https://alphagov.github.io/api-catalogue/index.html
)The text was updated successfully, but these errors were encountered: