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

Rename repo to cape, update README and related docs #212

Closed
pmackay opened this issue Dec 20, 2021 · 14 comments
Closed

Rename repo to cape, update README and related docs #212

pmackay opened this issue Dec 20, 2021 · 14 comments
Assignees

Comments

@pmackay
Copy link

pmackay commented Dec 20, 2021

Looks like the tool is now being referred to as Climate Action Plans Explorer, would be nice to make that consistent naming across the project?

@zarino
Copy link
Member

zarino commented Aug 2, 2022

Related: #400 Does the site need a new name?

@zarino zarino added this to the CAPE for non-experts milestone Nov 4, 2022
@ajparsons
Copy link
Contributor

From previous renaming project experience, I think we can just do this and github's redirects work fine until we recreate a mysociety/caps. Possibly for curating a collection of caps.

@zarino
Copy link
Member

zarino commented Nov 25, 2022

@struan @alexander-griffen – once we’ve renamed the repo, do you think we should rename the caps Django app as well, to avoid confusion? Seems like renaming a Django app is pretty involved.

@ajparsons
Copy link
Contributor

I think the second comment there suggests a half approach, where you set a config for a cape app like:

class CapeConfig(AppConfig):
    label = 'caps'
    verbose_name = "Cape"

Because django derives the database name from the app label, that should prevent the need to do database changes as well as code changes.

@ajparsons
Copy link
Contributor

#456 demonstrates that approach seems to work in principle. (Internally, django sees it as 'caps', but folder renamed).

@alexander-griffen
Copy link

Would this create confusion in the future if anything ever needs to be accessed internally?

@ajparsons
Copy link
Contributor

Tbh, we have a lot of projects that have strange internal names for things or databases. It wouldn't be terrible not to change it at all, but that seems like a halfway approach (which, might in certain situations, be confusing!).

@struan
Copy link
Member

struan commented Nov 28, 2022

This seems like an excellent way to introduce bugs and cause ourselves a lot of pain for very limited gain.

@ajparsons
Copy link
Contributor

In which case, just renaming the github repo and making a handful of readme changes would probably be enough for clarity that this is indeed the repo for the website 'cape'?

@zarino
Copy link
Member

zarino commented Nov 30, 2022

In which case, just renaming the github repo and making a handful of readme changes would probably be enough for clarity that this is indeed the repo for the website 'cape'?

Yeah, that’s what I’m now thinking. I guess it’s not unusual for Django apps to be oddly named, and I doubt people will care that much if the app is called caps while the repo is called cape. But from an external consistency point of view, having a site called "CAPE" at the domain cape.mysociety.org running code from a repo at github.com/mysociety/cape does feel neat and tidy 👍

@struan
Copy link
Member

struan commented Dec 1, 2022

I suspect there's also some sysadmin things to do but not too many as part of this.

@zarino
Copy link
Member

zarino commented Dec 1, 2022

Noted by @ajparsons in #460:

May be a sequencing thing, but if also updating the mysociety repo, need to adjust the bottom of https://github.com/mysociety/caps/blob/master/.github/workflows/mirror.yml

@zarino
Copy link
Member

zarino commented Dec 1, 2022

So I think this is the plan of action:

I’ve appended ‘??’ to the items I think need to happen but wouldn’t know how to implement myself!

@sagepe @struan @ajparsons does that seem about right? Anything we’re missing?

@zarino
Copy link
Member

zarino commented Feb 14, 2023

CAPE now lives at https://cape.mysociety.org (rather than https://data.climateemergency.uk) which is the big public-facing change we wanted to make.

Theoretically renaming the Github repo should be a simple change (and Github should handle redirects etc) but if our aim is full consistency, we’d also want to change"caps" to "cape" in lots of other places (see above) and that, right now, feels like a load of work we really don’t need to do.

Closing this ticket for now. If the caps/cape inconsistency annoys us again in future, we can always re-open.

@zarino zarino closed this as completed Feb 14, 2023
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

5 participants