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

Replace content & config with tech-docs version #92

Merged
merged 1 commit into from
Aug 6, 2020
Merged

Conversation

digitalronin
Copy link
Contributor

@digitalronin digitalronin commented 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

You can see what the site will look like after this PR is merged here:
https://ministryofjustice.github.io/technical-guidance2/
(that repository and site will be deleted after this PR is merged).

After merging this PR, this repository's settings will need to be changed so that github pages publishes the /docs folder of the gh-pages branch.

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 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.
Copy link
Contributor

@SteveMarshall SteveMarshall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great, but it'd be nice if it was possible to have the homepage dynamically generated again. Or does that page become irrelevant under the new system?

@@ -11,48 +11,34 @@ which covers service design more broadly.

## Principles

{% assign principle_groups = site.pages
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it possible to maintain the dynamic generation of this page?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure, TBH. tech-docs is based on middleman rather than jekyll, but I imagine middleman has the same kind of features for doing that. I'll look into it.

@digitalronin
Copy link
Contributor Author

does that page become irrelevant under the new system?

No, it's still important. We just maintain the index page manually for our user-guide site. The nice thing about that is that you can prepare a page in advance and not necessarily index it until later.

e.g. this page for our CLI

https://user-guide.cloud-platform.service.justice.gov.uk/documentation/getting-started/cloud-platform-cli.html#the-cloud-platform-cli

It was quite useful to have that in place and not indexed at first, while we were working on things. But I will have a look and see how we could do the same thing with middleman. I'm sure it must be possible.

@digitalronin digitalronin merged commit dfb5ed2 into main Aug 6, 2020
@digitalronin digitalronin deleted the tech-docs branch August 6, 2020 09:50
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