search

RConsortium / rconsortium_website

http://r-consortium.org/
1 stars 3 forks source link

ISC Charter: Replace PDF version with HTML version #165

Closed HenrikBengtsson closed 4 weeks ago

HenrikBengtsson commented 1 month ago

This PR replaces the PDF version of the ISC Charter with a Markdown version, which is rendered in HTML by Quarto.

Members of the ISC team have:

  1. converted the 2023-08-11 version of the ISC Charter to Markdown (two people took different approaches and got the same results)
  2. they then repeated this for the 2024-08-13 version.

The nice thing with maintaining the Charter in plain text (here Markdown) is that it is straightforward to track changes, e.g. https://github.com/RConsortium/rconsortium_website/commit/5e77041a94757087660509ffa939d798c7c03ab4. Doing the same with PDFs is much harder. This will also allow us to automatically spellcheck the Charter (just like we could for the rest of the website). With Markdown, we also avoid any formatting issues. A Markdown/HTML version is more accessible than a PDF.

PS. I think we should move our other RC PDF documents into Markdown as well. We could probably still render also PDF versions, but I don't think it's really necessary.

netlify[bot] commented 1 month ago

Deploy Preview for rconsortium ready!

Name Link
Latest commit c9dfd174770039f34a02a75b207bfa9d4328f25c
Latest deploy log https://app.netlify.com/sites/rconsortium/deploys/670da7ef169ed800086e198d
Deploy Preview https://deploy-preview-165--rconsortium.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

krlmlr commented 1 month ago

Looks good. What's the source of truth for the text here? Should this then be removed from the isc-ops repo, or should we have code that copies it from there, perhaps with a "do not edit by hand" header?

The most recent changes in 5e77041a94757087660509ffa939d798c7c03ab4 have a typo, a tiny grammatical error: "a number of elected representative" -> "...ves" . Is this a new version, where do we track proposed changes to the charter?

HenrikBengtsson commented 4 weeks ago

The most recent changes in 5e77041 have a typo, a tiny grammatical error: "a number of elected representative" -> "...ves" . Is this a new version, where do we track proposed changes to the charter?

I took the freedom to fix this typo, cf. commit d0284cbd. I was just a typo, so it does not require updating the version date.