alphagov / govuk-prototype-kit-docs

Site for the GOV.UK Prototype Kit
https://prototype-kit.service.gov.uk/docs
MIT License
3 stars 2 forks source link

Update docs with latest changes from Prototype Kit repo #22

Closed lfdebrux closed 2 years ago

lfdebrux commented 2 years ago

What

Things have diverged a bit since we last looked at this, we need to refresh the content in this repo.

We should pull in the necessary stuff from the Prototype Kit repo to bring these docs up-to-date with the docs there.

I'd also like to consider whether we should also bring through the app infrastructure. This would allow us to quickly deploy to Heroku, publish, and then iterate later, and should make updating the content for now easier in my opinion. If this is technically challenging though we should continue with the current method.

We might want to consider having a docs freeze, once we've done this (but before we've completed the switchover), so we don't have issues with needing to update two repos at once. Otherwise we'll also want to move any pull requests changing docs to over here.

Why

We want to switch out the docs as soon as possible!

Who needs to do this

Developer

Who needs to review this

Developer, anyone else?

Done when

lfdebrux commented 2 years ago

I'm trying to decide whether to rewrite the history of the main branch, or to try and merge in the content of the prototype kit repo. I'm leaning towards rewriting history, because it might make serving older versions easier later down the line.

I've put the history for the original main branch in a new branch from-govuk-design-system, and the whole history of the govuk-prototype-kit in a branch called from-govuk-prototype-kit.

lfdebrux commented 2 years ago

I've renamed the main branch to main, and rewritten it to have all the history from from from-govuk-prototype-kit

You may have some issues next time you try to do a pull of the govuk-prototype-kit-docs repo.

If you’re doing any work on changing docs for the prototype kit, from now onwards please base it off https://github.com/alphagov/govuk-prototype-kit-docs, and raise any pull requests there.

lfdebrux commented 2 years ago

I'm going to now go through the open PRs in the prototype kit repo to see what needs to be moved to this repo.

lfdebrux commented 2 years ago

I think the only PRs of interest are:

I've left comments to that effect on the PRs, will move them when the requesters are ready.