Patch the gov.uk tech-docs gems after installing #393
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
These files represent the patches described in this issue: alphagov/tech-docs-gem#191 They enable using (a patched version of) the gov.uk tech-docs gem to publish a documentation site using github pages without requiring the site to be published at the root docpath ("/") of a dedicated domain. i.e. this enables publishing a site at: ``` https://username.github.io/my-repo ``` This is the default github pages URL for the repository "my-repo" belonging to the github user/organisation "username". As opposed to: ``` https://my.custom.domain/ ``` Without these patches, the search function of the site will not work correctly. The patch files in this directory are used in the Dockerfile to build the docker image which is used in the publishing process. This is a nasty hack, but the alternative is to maintain forks of two gems, `govuk_tech_docs` and `middleman-search-gds`, so this seems a pragmatic solution until the issue above is resolved in the upstream gems.
digitalronin
added a commit
to ministryofjustice/technical-guidance
that referenced
this pull request
Aug 6, 2020
This change converts the site to use (a patched version of) the gov.uk tech-docs template & gems. https://github.com/alphagov/tech-docs-template Details of the patch are here: ministryofjustice/cloud-platform-user-guide#393 This gives the site a search feature, as well as dynamic review dates (i.e. you see a big red banner at the foot of the page if the content was not reviewed when it should have been). Publishing is now done via a github action. See: .github/workflows/publish.yml ...for details.
This was referenced Aug 6, 2020
pwyborn
approved these changes
Aug 10, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
These files represent the patches described in this issue:
alphagov/tech-docs-gem#191
They enable using (a patched version of) the gov.uk tech-docs gem to publish a
documentation site using github pages without requiring the site to be
published at the root docpath ("/") of a dedicated domain.
i.e. this enables publishing a site at:
This is the default github pages URL for the repository "my-repo" belonging to
the github user/organisation "username".
As opposed to:
Without these patches, the search function of the site will not work correctly.
The patch files in this directory are used in the Dockerfile to build the
docker image which is used in the publishing process.
This is a nasty hack, but the alternative is to maintain forks of two gems,
govuk_tech_docsandmiddleman-search-gds, so this seems a pragmaticsolution until the issue above is resolved in the upstream gems.