Create a web page copied of contributing guidelines, page style and metadata guidelines

[anenadic]

Create a web page copied of contributing guidelines, page style and metadata guidelines - once these documents settle, so we do not have to duplicate the work of maintaining both the copies in the repository and the ones that are meant to render as web pages.

[egpbos]

I'd be happy to implement this in a simple way: maintain only these guidelines on the website pages (no copy-pasting or including CONTRIBUTING.md) and from the CONTRIBUTING.md file we simply replace all content with a link to the website section/pages. We discussed this also in the editorial board just now. If you agree @anenadic I'd be happy to make a PR for this.

[anenadic]

I'd be happy to implement this in a simple way: maintain only these guidelines on the website pages (no copy-pasting or including CONTRIBUTING.md) and from the CONTRIBUTING.md file we simply replace all content with a link to the website section/pages. We discussed this also in the editorial board just now. If you agree @anenadic I'd be happy to make a PR for this.

Hi, yes that was exactly what I was planning to do @egpbos:

• review all relevant files currenlty visible from the repo only and make sure the content is correct/as we want it
• port these files under the website and make them visible there and only maitain this version of the files (so no duplication)

[egpbos]

Alright, let's make sure we don't duplicate efforts then :) Let me know if you want me to contribute or whether you prefer doing it yourself.

[egpbos]

• Move CONTRIBUTING.md to become a page.
  • Link to new page from README and website.
  • After this (and checking links didn't break) readd a new CONTRIBUTING.md that points to the "how to contribute" page.
  • Maybe add "for working with git look at ..." like the "Git Way" page in RDMkit, or check whether the contents of CONTRIBUTING.md are enough for us.
  • Markdown cheatsheet: just add a short statement on the Markdown dialect we use, see the RDMKit page on this ("Kramdown"), refer to external Kramdown reference.
• Move EDITORS_CHECKLIST.md to become a page.
  • Link to new page from README and website.
• Move INSTALL.md to become a page.
• Remove METADATA_GUIDELINES.md and STYLE_GUIDELINES.md
• Actually write Metadata Guidelines page -> Finalise metadata guidelines #157
• Actually write Style guide page -> Finalise page style guidelines #156
• Add "all page ids" page

[dgarijo]

I have to write the metadata guidelines page, when things calm down a bit :( El mar., 21 ene. 2025 1:05 p. m., Patrick Bos ***@***.***> escribió:

…

- Move CONTRIBUTING.md to become a page. - Link to new page from README and website. - After this (and checking links didn't break) readd a new CONTRIBUTING.md that points to the "how to contribute" page. - Maybe add "for working with git look at ..." like the "Git Way" page in RDMkit, or check whether the contents of CONTRIBUTING.md are enough for us. - Markdown cheatsheet: just add a short statement on the Markdown dialect we use, see the RDMKit page on this ("Kramdown"), refer to external Kramdown reference. - Move EDITORS_CHECKLIST.md to become a page. - Link to new page from README and website. - Move INSTALL.md to become a page. - Remove METADATA_GUIDELINES.md and STYLE_GUIDELINES.md - Actually write Metadata Guidelines page - Actually write Style guide page — Reply to this email directly, view it on GitHub <#155 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AALTIGSXK54PRXRMNZONUND2LYZXLAVCNFSM6AAAAABTJM5HRWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMMBUGU2DENZRHA> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>