publiccodenet / publiccode.net

Home to the website of the Foundation for Public Code. This is the most public-facing place for people to learn about the organization.
https://publiccode.net
20 stars 6 forks source link

Description of Standard for Public Code includes a lot of stewardship explanation #322

Open clausmullie opened 7 months ago

clausmullie commented 7 months ago

The repository for the Standard for Public Code is made as neutral as possible - it contains only the standard, with all the stewardship related things moved into About. I remember this was to make the Standard a stand alone asset anyone can use and reuse as they see fit, while stewardship is something particular to our organization.

However, I get the sense this separation is not made as clearly on the homepage. The introduction to the standard page includes a lot of "how do we do stewardship" information that perhaps lives best on the introduction to stewardship page.

If we want to promote it as an asset separate from our stewardship activity, it would be best to untangle these two elements, keep the standard page strictly about the standard (and include community-inviting things like the community calls, translations, different ways it's being used and by who, etc) with a mention+hyperlink that we use it for stewardship. And then move all the audit/certification content to the stewardship page.

Ainali commented 7 months ago

The introduction to the standard page includes a lot of "how do we do stewardship" information that perhaps lives best on the introduction to stewardship page.

When you say "introduction", do you mean the text before the "Standard compliance or certification process" section?

clausmullie commented 7 months ago

When you say "introduction", do you mean the text before the "Standard compliance or certification process" section?

No, I meant the entire page. But on second thought, I'm doubting my original issue.

Ainali commented 7 months ago

I realize, though, that there isn't much of a text overview/introduction. The video has it all, but for someone just reading, it goes from the lead straight into the certification. One more paragraph under the video, summarizing it, would be a great addition.

Ainali commented 7 months ago

Following our call this morning, we summarized the actions to these two (for this repository):

  1. Move the detailed certification description to a sub-page and have a short paragraph pointing to it.
  2. Review, reorganize and rephrase the page so that it gives a brief overview about the standard and how we use it and with relevant links to those who would like to be certified, want to contribute to it, want to use it on their own or would like to be stewarded through the process.
clausmullie commented 7 months ago

My notes from the call

Use cases

There are three use cases for the standard 1) It's a reference document that anyone can use in whatever way they want --> The 'agnostic' product/tool 2) It's something we can audit a community/codebase against --> Codebase auditing 3) It's something we can use as guide to work with a community/codebase to get standard compliance --> Codebase stewardship

publiccode.net/standard

This should include a nice simple introduction to the standard to orient readers (+video) Followed by a brief section on each of the use cases, speaking to the user, what it can do for them, and how to get involved, with links to:

Ainali commented 7 months ago
  • I noticed this currently doesn't link to the standard, might be good to add that at the bottom

It links to standard.publiccode.net on line 37, but perhaps that link should go to the page about the standard on publiccode.net instead?