diff --git a/_config.yml b/_config.yml index 39aeba1..ccbcccd 100644 --- a/_config.yml +++ b/_config.yml @@ -46,6 +46,10 @@ defaults: values: layout: "default" +kramdown: + input: GFM + gfm_quirks: [paragraph_end] + callouts: highlight: color: yellow diff --git a/_plugins/gfm_callouts.rb b/_plugins/gfm_callouts.rb new file mode 100644 index 0000000..cc88b6c --- /dev/null +++ b/_plugins/gfm_callouts.rb @@ -0,0 +1,19 @@ +Jekyll::Hooks.register [:posts, :pages, :documents], :pre_render do |doc| + # Map GFM alert tags to Just the Docs classes + callout_map = { + 'NOTE' => 'note', + 'TIP' => 'highlight', + 'WARNING' => 'warning', + 'IMPORTANT' => 'important', + 'CAUTION' => 'important' + } + + callout_map.each do |gfm_type, jtd_class| + # Convert '> [!NOTE]' followed by content into Just the Docs block attributes + pattern = /^>\s*\[!#{gfm_type}\]\s*\n((?:^>.*$\n?)+)/i + doc.content.gsub!(pattern) do + content = $1 + "#{content}{: .#{jtd_class} }\n" + end + end +end diff --git a/docs/assets.md b/docs/assets.md new file mode 100644 index 0000000..b30da60 --- /dev/null +++ b/docs/assets.md @@ -0,0 +1,41 @@ +--- +title: Assets Development +parent: Groups +--- + +# Assets Development for OpenChain Groups + +* TOC +{:toc} + + +OpenChain Groups are natural collaboration points for interested parties to come together to develop various assets for public consumption. These assets generally include: + +- White Papers +- Guides +- Checklists +- Presentations + +The document outlines the general process and guidelines around asset development. + +## Key Requirements for any assets + +- Per the [OpenChain Project Charter IP Poilcy ( Section 12(a) )](https://charter.openchainproject.org), all assets must be licensed under the [Creative Commons Zero License version 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/) unless there has been written approval of the OpenChain Governing Board. +- All assets must be developed on openly available tools and platforms. Generally, groups use GitHub ( OpenChain provisions out GitHub repos for all it's groups ), but tools such as Google Docs are acceptable if the contents is available for public consumption and there is a mechanism for public feedback. + +## Soliciting Public Comment/Feedback + +OpenChain Groups developing assets for public consumption will often find it helpful to get broad community feedback on the asset before the asset is formally released. OpenChain Groups are free to set the timeperiod for such feedback, and the below items are best practices for managing public comments/feedback. + +- Announce the asset open for Public Comment/Feedback via the group email list, as well as the general OpenChain mailing list. OpenChain Staff can assist in sharing via OpenChain social channels if interested. +- Ensure there is a clear path to provide feedback. Generally this would be a GitHub Issue, but groups may choose to have feedback sent to the mailing list instead/as well. Do avoid requiring indivduals wanting to provide feedback being required to attend a group meeting, unless there is live discussion around the feedback required. +- Clearly announce the time period for Public Comment/Feedback, and send reminders as the end of the period approaches. +- Ensure all contributors recognize their contributions will be under the project license for the asset ( [Creative Commons Zero License version 1.0 Universal (CC0 1.0)](https://creativecommons.org/publicdomain/zero/1.0/) unless there has been written approval of the OpenChain Governing Board. ) + +## Working with Standards and Standards Bodies + +In some cases, assets from groups may make sense to either make a standards body aware of, or perhaps consider formal standardization. The Linux Foundation through the Joint Development Foundation (JDF) has staff and resources to guide these processes, and should be engaged any time such actions would be considered. Groups can contact for assistance. + +> [!NOTE] +> It is critical that if a group is wanting to approach a Standard Body ( such as IEEE or IEC ) that it contacts the JDF *before* making any contact ( which can be contacted through ). JDF has numerous liasion agreements and relationships to guide these engagements. + diff --git a/docs/index.md b/docs/index.md index 2d70082..8e6dcae 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,8 +9,8 @@ permalink: / Welcome to the central portal for OpenChain Project governance, working group operations, and compliance policies. -{: .note } -> All OpenChain groups operate under the antitrust, IP, and code of conduct policies established in the [OpenChain Project Charter](https://charter.openchainproject.org). +> [!NOTE] +> All OpenChain groups operate under the antitrust, IP, and code of conduct policies established in the [OpenChain Project Charter](https://charter.openchainproject.org/). ## How to Contribute to Guidelines @@ -18,4 +18,3 @@ This documentation hub is hosted directly on GitHub and maintained by the OpenCh 1. **Suggest Changes:** Submit an issue or pull request directly to the [.github repository](https://github.com/OpenChain-Project/.github). 2. **Join Discussion:** Participate in our bi-weekly governance calls listed on the official [OpenChain Calendar](https://www.openchainproject.org). -