pvp icon indicating copy to clipboard operation
pvp copied to clipboard

remove misleading "suggest changes" link

Open mauke opened this issue 1 year ago • 7 comments

At the bottom of https://pvp.haskell.org/#related it says:

If you'd like suggest changes, please open an issue on GitHub.

But that doesn't do anything in practice because changes suggested on github are only made on Github; they don't make it to the website. For example, PR #20 from 2018 contained a bugfix that corrects a nonsensical suggestion in the flowchart diagram, but the website still hasn't been updated.

In practical terms, there is no way to get changes into the published PVP, so the Github issue suggestion should be removed.

mauke avatar Sep 15 '24 22:09 mauke

Isn't this proposal self-defeating? If your suggested change ever makes it to the website then that can only be because we've found a way of making changes to the GitHub repo make it to the website!

I suggest we just work out how to deploy changes to the website.

tomjaguarpaw avatar Sep 16 '24 07:09 tomjaguarpaw

The clc has day-to-day responsibility over the PVP. Whenever it wants to publish a new version, it should request the admin team help. Also we'd be happy to set up a more consistent sync if preferred.

gbaz avatar Oct 22 '24 15:10 gbaz

@gbaz I think the easiest way to sync would be to set up GitHub Pages for this repository and point pvp.haskell.org to them. Does it sit well with you?

Bodigrim avatar Nov 20 '24 00:11 Bodigrim

i'm fine with that i suppose. i keep saying that uploading files is not hard and its how we always used to do things back in the day, but... whatever. if you setup github pages i can handle the dns redirect for it.

gbaz avatar Dec 03 '24 00:12 gbaz

Given that we deploy once every other decade, I'm not sure what this automation gives us. Instead, it'll likely make it a little harder to do "releases“ properly, no? We don't want to upload everything that's merged immediately, or do we?

hasufell avatar Dec 03 '24 01:12 hasufell

I think we ought to have at least some branch (or tag) which indicates "latest version of PVP approved for release by CLC". I also think we ought to have very clear specified steps about what steps are required for a "release", ending up with https://pvp.haskell.org displaying the contents of that release.

Based on my experience[^1] of using GitHub Actions to https://www.haskell.org deploy automatically on merge to master, and to deploy my personal site https://h2.jaguarpaw.co.uk/ on GitHub Pages via push to a specific repo, I can recommend using GitHub Actions and GitHub pages to be the way we specify the steps involved in "release" (with the bonus that the specification is executable).

[^1]: jointly with @tikhonjelvis

tomjaguarpaw avatar Dec 03 '24 15:12 tomjaguarpaw

Given that we deploy once every other decade, I'm not sure what this automation gives us. Instead, it'll likely make it a little harder to do "releases“ properly, no? We don't want to upload everything that's merged immediately, or do we?

  • There are technical changes which we'd rather release immediately such as #61.

  • I'd like to have a page with PVP 1.1 work-in-progress available for public reference, and this one can benefit from reflecting changes immediately as well.

  • We indeed do not plan to change PVP 1.0 ever, so syncronizing it with Git can do no harm.

Bodigrim avatar Dec 04 '24 00:12 Bodigrim