Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Look and Feel Update / Front Pages #228

Merged
merged 15 commits into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/InnerSource/Introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: InnerSource
sidebar_position: 0
---

Hello
5 changes: 5 additions & 0 deletions docs/InnerSource/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
position: 6
label: 'InnerSource'
link:
type: doc
id: Introduction
2 changes: 1 addition & 1 deletion docs/bok/Activities/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion docs/bok/Activities/Level-3/Culture.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ tags:
- Business (Role)
- OSPO (Role)
- Placeholder
- InnerSource
- Level 3 (OSMM)
sidebar_position: 8
sidebar_label: Culture
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/bok/Artifacts/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
1 change: 1 addition & 0 deletions docs/bok/Certifications/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ sidebar_label: Introduction
sidebar_position: 0
tags:
- Introduction
- Training
- Placeholder
---

Expand Down
Original file line number Diff line number Diff line change
@@ -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
---


Expand Down
10 changes: 5 additions & 5 deletions docs/about.md → docs/bok/Contribution.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
14 changes: 6 additions & 8 deletions docs/bok/Introduction.md
Original file line number Diff line number Diff line change
@@ -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"/>
14 changes: 1 addition & 13 deletions docs/bok/OSMM/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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]).

5 changes: 5 additions & 0 deletions docs/bok/Resources/_category_.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
position: 9
label: 'Resources'
link:
type: doc
id: osr-resources
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
id: external-resources
title: External Resources
sidebar_label: External Resources
slug: /osr-resources/external-resources
tags:
- Resources
---

## Similar Efforts
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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._
Expand Down
4 changes: 4 additions & 0 deletions docs/operations/oslc.md → docs/bok/Resources/oslc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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>

Expand Down
10 changes: 10 additions & 0 deletions docs/bok/Resources/osr-resources.md
Original file line number Diff line number Diff line change
@@ -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" />
Original file line number Diff line number Diff line change
Expand Up @@ -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)
2 changes: 1 addition & 1 deletion docs/bok/Risks/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
5 changes: 5 additions & 0 deletions docs/bok/Training/Introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
robmoffat marked this conversation as resolved.
Show resolved Hide resolved

See: [OSR Training](/docs/osr-resources/Training)

## Linux Foundation Training Courses

<CourseList filter="Training" tag="LF-Training" />
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/bok/Training/LFD121-Secure-Software-Dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ tags:
- LF-Training
- Training
- FSOSD (Certification)
- Developer (Role)
course:
publisher: Linux Foundation
code: LFD121
Expand Down
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
8 changes: 5 additions & 3 deletions docs/bok/Training/Understanding-Competitive-Advantage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion docs/bok/_category_.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
position: 5
label: 'Body Of Knowledge'
label: 'Open Source Readiness'
link:
type: doc
id: Introduction
12 changes: 0 additions & 12 deletions docs/meetings.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/operations/_category_.yaml

This file was deleted.

9 changes: 0 additions & 9 deletions docs/operations/foss-policy.md

This file was deleted.

Loading