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

Automate build & deployment #95

Closed
2 of 5 tasks
odlp opened this issue Sep 29, 2020 · 2 comments
Closed
2 of 5 tasks

Automate build & deployment #95

odlp opened this issue Sep 29, 2020 · 2 comments
Assignees

Comments

@odlp
Copy link
Contributor

odlp commented Sep 29, 2020

To automate the build we need to correct a few issues which appear to hand-corrected post-build at the moment

These 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)

@odlp odlp self-assigned this Sep 29, 2020
odlp added a commit that referenced this issue Sep 30, 2020
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 added a commit that referenced this issue Oct 2, 2020
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 added a commit that referenced this issue Oct 2, 2020
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
Copy link
Contributor Author

odlp commented Oct 26, 2020

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 govuk_tech_docs gem, rather than a branch).

@odlp
Copy link
Contributor Author

odlp commented Nov 23, 2020

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.

@odlp odlp closed this as completed Nov 23, 2020
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

No branches or pull requests

1 participant