Merge pull request #228 from finos/look-and-feel

Look and Feel Update / Front Pages
finos · Jan 24, 2024 · 0b270a6 · 0b270a6
2 parents 5b99c77 + 86c5643
commit 0b270a6
Show file tree

Hide file tree

Showing 117 changed files with 659 additions and 222 deletions.
diff --git a/docs/InnerSource/Introduction.md b/docs/InnerSource/Introduction.md
@@ -0,0 +1,6 @@
+---
+title: InnerSource
+sidebar_position: 0
+---
+
+Hello
diff --git a/docs/InnerSource/_category_.yaml b/docs/InnerSource/_category_.yaml
@@ -0,0 +1,5 @@
+position: 6 
+label: 'InnerSource'
+link:
+  type: doc
+  id: Introduction
diff --git a/docs/bok/Activities/Introduction.md b/docs/bok/Activities/Introduction.md
@@ -6,7 +6,7 @@ tags:
   - Introduction
 ---
 
-This section of the OSBOK describes common activities performed by staff involved in the consumption or contribution of open source software.  Where possible, the OSBOK identifies the [role](../Roles/Introduction.md) performing this activity.
+This section describes common activities performed by staff involved in the consumption or contribution of open source software.  Where possible, we identify the [role](../Roles/Introduction.md) performing this activity.
 
 ## The Activities
 

diff --git a/docs/bok/Activities/Level-3/Culture.md b/docs/bok/Activities/Level-3/Culture.md
@@ -5,6 +5,7 @@ tags:
   - Business (Role)
   - OSPO (Role)
   - Placeholder
+  - InnerSource
   - Level 3 (OSMM)
 sidebar_position: 8
 sidebar_label: Culture
@@ -193,7 +194,7 @@ Some reasons for considering this (from [Wikipedia](https://en.wikipedia.org/wik
  - [Using open source methods for internal software projects](https://www.oreilly.com/content/using-open-source-methods-for-internal-software-projects/) - Article by Jared Smith of O'Reilly.
  - [InnerSource Commons](https://innersourcecommons.org): InnerSource Commons is the world's largest community of InnerSource practitioners. 
  - [Wikipedia Page on InnerSource](https://en.wikipedia.org/wiki/Inner_source).
- - [Presentation on Inner Source Licensing](../../../osr-resources/InnerSource).
+ - [Presentation on Inner Source Licensing](/docs/bok/osr-resources/InnerSource).
 
 
 ## Conclusion

diff --git a/docs/bok/Artifacts/Introduction.md b/docs/bok/Artifacts/Introduction.md
@@ -6,7 +6,7 @@ tags:
   - Introduction
 ---
 
-This section of the OSBOK describes common artifacts either consumed or produced when managing open source software within the enterprise.  Artifacts may be machine- or process- generated (such as an [SBOM](SBOMs)) or the result of human effort (such as an [Open Source Strategy](Strategy)).
+This section describes common artifacts either consumed or produced when managing open source software within the enterprise.  Artifacts may be machine- or process- generated (such as an [SBOM](SBOMs)) or the result of human effort (such as an [Open Source Strategy](Strategy)).
 
 ## The Artifacts
 

diff --git a/docs/bok/Certifications/Introduction.md b/docs/bok/Certifications/Introduction.md
@@ -4,6 +4,7 @@ sidebar_label: Introduction
 sidebar_position: 0
 tags: 
   - Introduction
+  - Training
   - Placeholder
 ---
 

diff --git a/...r-resources/certification-instructions.md → ...tifications/certification-instructions.md b/...r-resources/certification-instructions.md → ...tifications/certification-instructions.md
@@ -1,7 +1,8 @@
 --- 
 title: FINOS Financial Services Open Source Developer (FSOSD) Exam Instructions
-sidebar_label: Certification
+sidebar_label: FSOSD Instructions
 id: CertificationInstructions
+slug: /osr-resources/CertificationInstructions
 ---
 
 

diff --git a/docs/about.md → docs/bok/Contribution.md b/docs/about.md → docs/bok/Contribution.md
@@ -1,11 +1,11 @@
 ---
-id: about
-sidebar_position: 1
-title: About the OSR SIG
-sidebar_label: About
+slug: /about
+title: Contributing
 ---
 
-## Vision
+The Open Source Readiness Special Interest Group (OSR SIG) is dedicated to helping financial services firms advance their open source programs. 
+
+## Open Source Readiness SIG Vision
 
 Be a trusted venue for our members and community in their open source journey and enable them to achieve the highest state of open source maturity.
 

diff --git a/docs/bok/Introduction.md b/docs/bok/Introduction.md
@@ -1,20 +1,18 @@
 ---
-title: Introduction
-sidebar_position: 0
-sidebar_label: About
-show_label: Introduction
+title: Welcome to Open Source Readiness
 ---
+Open Source Readiness is a collaborative project aimed at developing a comprehensive body of knowledge (BOK) on open source software and its ecosystem. It is a community-driven initiative that brings together individuals, organizations, and experts from different fields to contribute their knowledge and experience. The project is based on the principle of openness and transparency, with all the content and contributions being made available under open licenses.
 
-The Open Source Body of Knowledge (OSBOK) is a collaborative project aimed at developing a comprehensive body of knowledge on open source software and its ecosystem. It is a community-driven initiative that brings together individuals, organizations, and experts from different fields to contribute their knowledge and experience. The OSBOK project is based on the principle of openness and transparency, with all the content and contributions being made available under open licenses.
+The project aims to provide a reference point for individuals, organizations, and communities interested in open source software. It is designed to be a comprehensive resource for enterprises looking to use or contribute to open source software.  It covers the philosophy of open source, the different types of licenses, best practices for managing open source projects and the tools and technologies used in open source development. 
 
-The OSBOK project aims to provide a reference point for individuals, organizations, and communities interested in open source software. It is designed to be a comprehensive resource for enterprises looking to consume or contribute to open source software.  It covers philosophy of open source, the different types of licenses, best practices for managing open source projects, and the tools and technologies used in open source development. The OSBOK project is expected to facilitate the adoption and growth of open source software within the enterprise and promote a better understanding of the open source ecosystem.
+The BOK is expected to facilitate the adoption and growth of open source software within the industry and promote a better understanding of the open source ecosystem.
 
 ## Information Architecture
 
-The OSBOK is designed as a collection of interconnecting documents and categories which can be browsed in any order.   The following diagram summarizes the information architecture:
+This site is designed as a collection of interconnecting documents and categories which can be browsed in any order.   The following diagram summarizes the information architecture:
 
 ![Information Architecture](/img/bok/information-architecture.png)
 
 Please see the following introductory articles on these areas:
 
-<BokTagList tag="Introduction" geff="sfda" />
+<BokTagList tag="Introduction"/>
diff --git a/docs/bok/OSMM/Introduction.md b/docs/bok/OSMM/Introduction.md
@@ -18,7 +18,7 @@ tags:
 
 ## Existing Maturity Models
 
-There are two pre-existing published open source maturity models at the time of writing which are both fairly similar.  The OSBOK attempts to synthesize these into a single whole:
+There are two pre-existing published open source maturity models at the time of writing which are both fairly similar.  Here we attempt to synthesize these into a single whole:
 
 - In December 2021, [The OSPO Alliance](https://ospo.zone) published on the [OW2](https://www.ow2.org) site the "[OW2 Open Source Good Governance Initiative](https://www.ow2.org/view/OSS_Governance/) which is a 5-level maturity model 
 
@@ -37,15 +37,3 @@ Each level of the Open Source Maturity Model corresponds to a different set of [
 This means it is possible for an organization to be making progress on _multiple levels at the same time_:  they might be performing _all_ of the activities at [Level 1](Level-1) and [Level 2](Level-2) and _some_ of the activities of each of levels 3 to 5.  
 
 Only by completing _all_ the activities at a given level and the levels below can an organization be regarded to be operating at that level.  (Unless there is some convincing reason for omitting to perform a given activity.)
-
-## FINOS OSMM Survey
-
-The FINOS [OSMM Survey](https://survey.osmm.finos.org/551476) can be answered in different ways:  as an individual, a function or the whole 
-ation.  The survey aims to:
-
- - Establish which activities the respondent is performing.   
- - Provide a maturity _level_ corresponding to these activities.
- - Give suggestions to the respondent about which activities need further work to move to a higher maturity level.
-
-**NB:** The FINOS OSMM Survey is currently in beta.  Feedback on this would be [greatly appreciated](mailto:[email protected]).  
-
diff --git a/docs/bok/Resources/_category_.yaml b/docs/bok/Resources/_category_.yaml
@@ -0,0 +1,5 @@
+position: 9
+label: 'Resources'
+link:
+  type: doc
+  id: osr-resources
diff --git a/docs/operations/compliance-workflows.md → docs/bok/Resources/compliance-workflows.md b/docs/operations/compliance-workflows.md → docs/bok/Resources/compliance-workflows.md
@@ -2,6 +2,9 @@
 id: compliance-workflows
 title: Open Source Compliance Workflows
 sidebar_label: Compliance Workflows
+slug: /operations/compliance-workflows
+tags:
+ - Resources
 ---
 
 Below are some high-level workflows for common open source compliance processes. To provide a point of reference for the various steps, the workflows refer to the functional components of an open source compliance toolchain in the diagram below, produced by the Open Source Tooling group of the OpenChain Project.

diff --git a/docs/operations/electronic-communications.md → ...ok/Resources/electronic-communications.md b/docs/operations/electronic-communications.md → ...ok/Resources/electronic-communications.md
@@ -1,13 +1,19 @@
 ---
 id: electronic-communications
 title: Considerations and Guidance for Electronic Communications Policies and Open Source
-sidebar_label: Electronic Communications Policies
+sidebar_label: ECOM Policies
+slug: /operations/electronic-communications
+tags:
+ - Resources
 ---
-<!-- 
-TODO:
+
+<BoxOut title="Work In Progress" image="/img/bok/warning.png">
+
 * List/link to example regulations
 * Provide example policy wording
--->
+
+</BoxOut>
+
 It's common for companies in the financial service industry to be subject to regulations requires retention of firm business-related electronic communications for a certain amount of time (that time varies by jurisdiction and type of communication). Frequently, firms struggle with how to manage open source interactions within the guidelines set both by the regulations and by their own company policies. This article covers how some member firms from our community have approached the matter.
 
 Remember that only communications related to firm business require retention. As electronic communications for open source use, support, and contribution aren't typically directly related to that business (related instead to the software that can _enable_ the business), these communications don't require retention under the regulations. For instance, there's no need to retain emails or copies of issue tracker comments for questions about how to use a feature of an open source project. That's a technical support question and doesn't relate to firm business. This is helpful, since the nature of some of the communication routes (Slack, for instance) cannot guarantee that the communications would be available for the required retention period and would otherwise require special accomodations to archive and retain.

diff --git a/docs/osr-resources/external-resources.md → docs/bok/Resources/external-resources.md b/docs/osr-resources/external-resources.md → docs/bok/Resources/external-resources.md
@@ -2,6 +2,9 @@
 id: external-resources
 title: External Resources
 sidebar_label: External Resources
+slug: /osr-resources/external-resources
+tags:
+ - Resources
 ---
 
 ## Similar Efforts

diff --git a/docs/osr-resources/oslc-licenses.md → docs/bok/Resources/oslc-licenses.md b/docs/osr-resources/oslc-licenses.md → docs/bok/Resources/oslc-licenses.md
@@ -3,6 +3,9 @@ id: oslc-licenses
 title: OSLC Handbook Licenses
 sidebar_label: Licenses
 sidebar_position: 5
+slug: /osr-resources/oslc-licenses
+tags:
+ - Resources
 ---
 
 _Please review [OSLC Documentation](../operations/oslc) for a primer on this, and the [Licenses](../bok/Artifacts/Licenses) article for more details on softwre licensing._

diff --git a/docs/operations/oslc.md → docs/bok/Resources/oslc.md b/docs/operations/oslc.md → docs/bok/Resources/oslc.md
@@ -2,6 +2,10 @@
 id: oslc
 title: OSLC Handbook
 sidebar_label: OSLC Handbook
+slug: /operations/oslc
+sidebar_position: 0
+tags:
+ - Resources
 ---
 
 This handbook provides information on how to comply with some common open source licenses under a specific set of use-cases. The goal here is to provide developers and engineers with some "self-serve" information to facilitate the end goal of open source license compliance, particularly for the easy-to-comply with conditions in open source licenses. This handbook also aims to help identify some of the more complex open source license compliance conditions for which consultation with open source counsel may be needed.

diff --git a/docs/osr-resources/osr-checklist.md → docs/bok/Resources/osr-checklist.md b/docs/osr-resources/osr-checklist.md → docs/bok/Resources/osr-checklist.md
@@ -4,13 +4,16 @@ authors:
   - url: https://github.com/copiesofcopies
 title: "OSR Checklist"
 sidebar_position: 6
+slug: /osr-resources/osr-checklist
+tags:
+ - Resources
 ---
 
 <BoxOut title="Warning: Possibly out-of-date" image="/img/bok/roles/ospo.png">
 
 This is content originally from the [FINOS OSR Checklist Project](https://github.com/finos/osr-checklists/edit/master/checklists/oss-compliance-program.md) which has not been updated recently.  Feel free to suggest edits.
 
-Consider folding into the OSMM checklist.
+Consider folding into the [OSMM checklist.](https://github.com/finos/open-source-readiness/pull/223)
 
 </BoxOut>
 

diff --git a/docs/bok/Resources/osr-resources.md b/docs/bok/Resources/osr-resources.md
@@ -0,0 +1,10 @@
+---
+id: osr-resources
+title: OSR Resources
+sidebar_label: OSR Resources
+tags:
+ - Introduction
+---
+
+The OSR SIG has produced several resources to help financial services firms along their open source journey.
+<BokTagList tag="Resources" />
diff --git a/docs/osr-resources/whitepaper.md → docs/bok/Resources/whitepaper.md b/docs/osr-resources/whitepaper.md → docs/bok/Resources/whitepaper.md
@@ -3,12 +3,15 @@ id: whitepaper
 title: "White Paper: Business Value of Open Source in Financial Services"
 sidebar_label: White Paper
 sidebar_position: 8
+slug: /osr-resources/whitepaper
+tags:
+ - Resources
 ---
 
 This white paper outlines the benefits and value of open source for financial services across varying degrees of open source engagement including consumption, contribution to existing projects and open sourcing proprietary software. It also looks at the real and perceived risks and challenges to open source participation and ways to address these.
 
 ## Whitepaper: Business Value of Open Source in Financial Services
 
-<a href="https://github.com/finos/open-source-readiness/tree/master/docs/osr-resources/materials/FINOS-business-value-of-open-source.pdf"><img src="https://github.com/finos/open-source-readiness/blob/master/docs/osr-resources/images/finos-business-value-of-open-source.png?raw=true" width="40%" /></a>
+[![Business Value](/img/resources/finos-business-value-of-open-source.png)](/pdf/FINOS-business-value-of-open-source.pdf)
 
-<a href="https://github.com/finos/open-source-readiness/tree/master/docs/osr-resources/materials/FINOS-business-value-of-open-source.pdf">Download the whitepaper</a>
+[Download the whitepaper](/pdf/FINOS-business-value-of-open-source.pdf)
diff --git a/docs/bok/Risks/Introduction.md b/docs/bok/Risks/Introduction.md
@@ -6,7 +6,7 @@ tags:
   - Introduction
 ---
 
-This section of the OSBOK breaks down the different types of risks that enterprises face by consuming or contributing to open source software.
+This section breaks down the different types of risks that enterprises face by consuming or contributing to open source software.
 
 ## The Risks
 

diff --git a/docs/bok/Training/Introduction.md b/docs/bok/Training/Introduction.md
@@ -4,11 +4,16 @@ sidebar_label: Introduction
 sidebar_position: 0
 tags: 
   - Introduction
+  - Training
   - Placeholder
 ---
 
 This section of the body of knowledge looks at the available training on open source.
 
+## Training and Certification Materials Produced By the OSR SIG
+
+See: [OSR Training](/docs/osr-resources/Training)
+
 ## Linux Foundation Training Courses
 
 <CourseList filter="Training" tag="LF-Training" />

diff --git a/docs/bok/Training/LFC193-Introduction-to-OSS-License-Compliance-Management.md b/docs/bok/Training/LFC193-Introduction-to-OSS-License-Compliance-Management.md
@@ -1,7 +1,8 @@
 --- 
 title: Introduction to Open Source License Compliance Management
 tags:
-  - Developer (Role)
+  - Legal (Role)
+  - OSPO (Role)
   - License Compliance Management (Activity)
   - Training
   - LF-Training

diff --git a/docs/bok/Training/LFD121-Secure-Software-Dev.md b/docs/bok/Training/LFD121-Secure-Software-Dev.md
@@ -4,6 +4,7 @@ tags:
   - LF-Training
   - Training
   - FSOSD (Certification)
+  - Developer (Role)
 course:
   publisher: Linux Foundation
   code: LFD121

diff --git a/docs/osr-resources/Training.md → docs/bok/Training/OSR-Training.md b/docs/osr-resources/Training.md → docs/bok/Training/OSR-Training.md
@@ -1,10 +1,13 @@
 ---
-title: Training and Certification
-sidebar_label: Training
+title: OSR Training and Certification
+sidebar_label: OSR Training
+tags:
+ - Training
+ - FINOS-Training
+slug: /osr-resources/Training
+sidebar_position: 1
 ---
 
-## OSR Published Training & Certification (2023)
-
 In November 2023 the OSR SIG team are proud to announce general availability of the following materials:
 
 ### [Open Source Contribution in Finance (LFD137)](../bok/Training/LFD137-Contribution-In-Finance)

diff --git a/docs/bok/Training/Understanding-Competitive-Advantage.md b/docs/bok/Training/Understanding-Competitive-Advantage.md
@@ -7,6 +7,8 @@ tags:
   - Other-Training
 ---
 
-Open Source Business Models 
-OPen Source as Marketing
-How to build better products with open source
+**THIS IS A PLACEHOLDER**
+
+- Open Source Business Models 
+- OPen Source as Marketing
+- How to build better products with open source
diff --git a/docs/bok/_category_.yaml b/docs/bok/_category_.yaml
@@ -1,5 +1,5 @@
 position: 5 
-label: 'Body Of Knowledge'
+label: 'Open Source Readiness'
 link:
   type: doc
   id: Introduction
diff --git a/docs/meetings.md b/docs/meetings.md
diff --git a/docs/operations/_category_.yaml b/docs/operations/_category_.yaml
diff --git a/docs/operations/foss-policy.md b/docs/operations/foss-policy.md