diff --git a/docs/collaboration-infrastructure.mdx b/docs/collaboration-infrastructure.mdx index 02a294f6..c6927769 100644 --- a/docs/collaboration-infrastructure.mdx +++ b/docs/collaboration-infrastructure.mdx @@ -1,6 +1,7 @@ --- id: collaboration-infrastructure title: Collaboration Infrastructure +description: "GitHub-based collaboration for FINOS: CLAs, org access, issues, and workflows that maintainers and contributors use across projects, SIGs, and programs." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/code-validation/codeclimate.mdx b/docs/development-infrastructure/code-validation/codeclimate.mdx index b85ed78a..99811285 100644 --- a/docs/development-infrastructure/code-validation/codeclimate.mdx +++ b/docs/development-infrastructure/code-validation/codeclimate.mdx @@ -1,6 +1,7 @@ --- id: codeclimate title: Code Climate +description: "Code Climate metrics for FINOS: coverage, maintainability, and technical debt signals in pull requests to keep project codebases healthy and reviewable." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/code-validation/coverityscan.mdx b/docs/development-infrastructure/code-validation/coverityscan.mdx index 863d69f4..b2cb041a 100644 --- a/docs/development-infrastructure/code-validation/coverityscan.mdx +++ b/docs/development-infrastructure/code-validation/coverityscan.mdx @@ -1,6 +1,7 @@ --- id: coverityscan title: Coverity Scan +description: "Coverity static analysis in FINOS builds: find defects in C, C++, and other supported languages before they ship in security-sensitive financial software." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/code-validation/intro.md b/docs/development-infrastructure/code-validation/intro.md index 1e59be3e..3a0b0c86 100644 --- a/docs/development-infrastructure/code-validation/intro.md +++ b/docs/development-infrastructure/code-validation/intro.md @@ -1,6 +1,7 @@ --- id: intro title: Code Validation +description: "Code validation in FINOS CI: static analysis, coverage, and supply-chain checks that keep security and quality high across GitHub-based repositories." --- In order to assess Security, Quality and Legal compliance of software hosted by the Foundation, project leads and committers can configure integrations with third-party systems that are provided by the Foundation; the result of these processes can be published in the project's documentation to improve the final consumer experience and when requesting activation. diff --git a/docs/development-infrastructure/code-validation/sonarcloud.mdx b/docs/development-infrastructure/code-validation/sonarcloud.mdx index 77a50473..f166dcaa 100644 --- a/docs/development-infrastructure/code-validation/sonarcloud.mdx +++ b/docs/development-infrastructure/code-validation/sonarcloud.mdx @@ -1,6 +1,7 @@ --- id: sonarcloud title: Sonar Cloud +description: "SonarCloud quality and security analysis for FINOS: continuous inspection of bugs, vulnerabilities, and smells on pull requests and main branches." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/code-validation/sonatype.mdx b/docs/development-infrastructure/code-validation/sonatype.mdx index 9a518bed..ad791fd8 100644 --- a/docs/development-infrastructure/code-validation/sonatype.mdx +++ b/docs/development-infrastructure/code-validation/sonatype.mdx @@ -1,6 +1,7 @@ --- id: sonatype title: Sonatype Lifecycle +description: "Sonatype dependency governance for FINOS: license and policy compliance across your supply chain as projects consume open source in regulated environments." --- # Sonatype Lifecycle diff --git a/docs/development-infrastructure/code-validation/whitesource.mdx b/docs/development-infrastructure/code-validation/whitesource.mdx index d7bf1e8d..27ecf0b0 100644 --- a/docs/development-infrastructure/code-validation/whitesource.mdx +++ b/docs/development-infrastructure/code-validation/whitesource.mdx @@ -1,6 +1,7 @@ --- id: whitesource title: Whitesource +description: "Mend/Whitesource for FINOS: open source license and vulnerability scanning in CI to catch risky dependencies before they reach production financial systems." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/continuous-delivery.mdx b/docs/development-infrastructure/continuous-delivery.mdx index f9c21b33..e3e702cb 100644 --- a/docs/development-infrastructure/continuous-delivery.mdx +++ b/docs/development-infrastructure/continuous-delivery.mdx @@ -1,6 +1,7 @@ --- id: continuous-delivery title: Continuous Delivery +description: "Continuous delivery for FINOS projects: release automation, safe deployments, and practices that get trusted artifacts to users and downstream systems." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/continuous-integration/clojure.md b/docs/development-infrastructure/continuous-integration/clojure.md index 0af2a0a9..d3cb60f6 100644 --- a/docs/development-infrastructure/continuous-integration/clojure.md +++ b/docs/development-infrastructure/continuous-integration/clojure.md @@ -1,6 +1,7 @@ --- id: clojure title: Clojure +description: "Continuous integration for Clojure at FINOS: ODP, GitHub Actions, and testing patterns to build, verify, and publish JVM libraries to trusted registries." --- [**Clojure**](https://clojure.org/) is a dialect of the Lisp programming language that runs on the Java virtual machine, Common Language Runtime, and JavaScript engines; the Foundation hosts [some Clojure projects](https://github.com/finos?q=&type=&language=clojure) that can be browsed as examples. diff --git a/docs/development-infrastructure/continuous-integration/csharp.mdx b/docs/development-infrastructure/continuous-integration/csharp.mdx index 0dac5439..15f12ba0 100644 --- a/docs/development-infrastructure/continuous-integration/csharp.mdx +++ b/docs/development-infrastructure/continuous-integration/csharp.mdx @@ -1,6 +1,7 @@ --- id: csharp title: C# +description: "C# and .NET continuous integration for FINOS: build, test, and release pipelines for managed projects on GitHub in open source financial services." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/continuous-integration/docker.md b/docs/development-infrastructure/continuous-integration/docker.md index 995afe2d..014e83cc 100644 --- a/docs/development-infrastructure/continuous-integration/docker.md +++ b/docs/development-infrastructure/continuous-integration/docker.md @@ -1,6 +1,7 @@ --- id: docker title: Docker Build and Publish +description: "Docker build and publish for FINOS: secure container image pipelines, registries, and best practices for projects shipping services and tools as containers." --- ## Why Docker? diff --git a/docs/development-infrastructure/continuous-integration/intro.mdx b/docs/development-infrastructure/continuous-integration/intro.mdx index be695879..69a62116 100644 --- a/docs/development-infrastructure/continuous-integration/intro.mdx +++ b/docs/development-infrastructure/continuous-integration/intro.mdx @@ -1,6 +1,7 @@ --- id: intro title: Continuous Integration +description: "Continuous integration for FINOS on GitHub: ODP, automated builds, tests, and quality checks that keep open finance codebases reliable in every language." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/continuous-integration/java.mdx b/docs/development-infrastructure/continuous-integration/java.mdx index f89f281f..a2c6ea0a 100644 --- a/docs/development-infrastructure/continuous-integration/java.mdx +++ b/docs/development-infrastructure/continuous-integration/java.mdx @@ -1,6 +1,7 @@ --- id: java title: Java +description: "Java build and test automation for FINOS: Maven, Gradle, ODP patterns, and quality gates for widely used JVM projects across the open finance stack." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/development-infrastructure/continuous-integration/javascript.md b/docs/development-infrastructure/continuous-integration/javascript.md index 7c1fc529..43b02566 100644 --- a/docs/development-infrastructure/continuous-integration/javascript.md +++ b/docs/development-infrastructure/continuous-integration/javascript.md @@ -1,6 +1,7 @@ --- id: javascript title: Javascript +description: "JavaScript and Node continuous integration for FINOS: npm, yarn, GitHub Actions, and testing for front-end and back-end open source in the foundation." --- In the last decade, Javascript (JS) has been increasingly used for backend software development, especially since the first appearance of Node.js. Listed below are some of the most common processes that are involved in a Javascript project lifecycle in several JS ecosystems/platforms, and how they interact with the project infrastructure provided by the Foundation. diff --git a/docs/development-infrastructure/continuous-integration/python.md b/docs/development-infrastructure/continuous-integration/python.md index 9dd927c5..e3995cbd 100644 --- a/docs/development-infrastructure/continuous-integration/python.md +++ b/docs/development-infrastructure/continuous-integration/python.md @@ -1,6 +1,7 @@ --- id: python title: Python +description: "Python CI for FINOS: pip, poetry, tox, and GitHub Actions to test and package data and service projects with consistent quality in open finance." --- [**Python**](https://www.python.org/) is an interpreted, object-oriented, high-level programming language with dynamic semantics. Packages are published on the [Python Package Index (pypi)](https://pypi.python.org/pypi), however the FINOS account is still empty, see [pypi.org/user/finos](https://pypi.org/user/finos/) . diff --git a/docs/development-infrastructure/project-documentation.mdx b/docs/development-infrastructure/project-documentation.mdx index ce66a191..cd0f6a70 100644 --- a/docs/development-infrastructure/project-documentation.mdx +++ b/docs/development-infrastructure/project-documentation.mdx @@ -1,6 +1,7 @@ --- id: project-documentation title: Project Documentation +description: "Publish FINOS project documentation: Docusaurus, GitHub Pages, and patterns for clear docs sites that follow foundation branding and best practices." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/finos-contributor-cheatsheet.md b/docs/finos-contributor-cheatsheet.md index 14215596..232b2117 100644 --- a/docs/finos-contributor-cheatsheet.md +++ b/docs/finos-contributor-cheatsheet.md @@ -1,6 +1,7 @@ --- id: finos-contributors-cheatsheet title: FINOS Contributor Cheatsheet +description: "A practical reference for new FINOS contributors: CLAs and EasyCLA, issues and pull requests, Good First Issues, and where to get help." --- ## Contributor License Agreement (CLA) and DCO diff --git a/docs/finos-maintainer-cheatsheet.mdx b/docs/finos-maintainer-cheatsheet.mdx index 128e3e51..fa4b9072 100644 --- a/docs/finos-maintainer-cheatsheet.mdx +++ b/docs/finos-maintainer-cheatsheet.mdx @@ -1,9 +1,9 @@ --- id: finos-maintainers-cheatsheet title: FINOS Maintainers Cheatsheet +description: "A practical guide for FINOS maintainers: roles, meetings, CI/CD, documentation, security scanning, and FINOS marketing and operations support." --- -# Welcome Welcome to the FINOS Maintainers Cheatsheet, the guide for new and experienced [FINOS Maintainers](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles) on engaging with the [FINOS Community](https://www.finos.org/get-involved), [FINOS Team](https://www.finos.org/team) and [FINOS Governing Board](https://www.finos.org/governing-board) to drive project success. ## About FINOS @@ -17,18 +17,18 @@ The open source software and standards projects hosted within FINOS cover a wide The [FINOS Landscape](https://landscape.finos.org) provides an overview of all FINOS projects and Special Interest Groups, and the [FINOS GitHub organization](https://github.com/finos) hosts the code of all FINOS projects. -# Maintainer Role +## Maintainer Role Each FINOS project and SIG has a community of [participants](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles), also referred to as "contributors", and [maintainers](https://github.com/finos/software-project-blueprint/blob/main/CONTRIBUTING.md#roles). A **contributor** is anyone who submits a contribution to the project. Contributions include code & pull requests, issues, comments, documentation, media, or any combination of the above. -A **maintainer** is a contributor who, by virtue of their contribution history, has been given [write access](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations) to project repositories and may approve and merge contributions to the project. +A **maintainer** is a contributor who, by virtue of their contribution history, has been given [write access](https://docs.github.com/en/organizations/managing-access-to-your-organizations-repositories/repository-roles-for-an-organization#repository-roles-for-organizations) to project repositories and may approve and merge contributions to the project. It is possible, and advised, that projects have multiple maintainers, in which case maintainers will elect one or two **lead maintainers**. The lead maintainer is the project's interface with the FINOS Team and Governing Board. Lead maintainers are responsible for communicating with the FINOS Team, Governing Board and Community on behalf of the project. The lead maintainer(s) are also accountable for steering project direction and prioritisation with the rest of the project community. They are also accountable for the quality of deliverables produced by the project community. FINOS Standards projects can also have [**editors**](https://github.com/finos/standards-project-blueprint/blob/master/governance-documents/5._Governance.md#1roles). -# Maintainer responsibilities and available resources +## Maintainer responsibilities and available resources FINOS project maintainers are responsible for technical & subject matter oversight of the project, and for driving community growth and engagement. FINOS supports project maintainers and their project communities through: - **operational enablement & support**: GitHub, meeting infrastructure @@ -41,8 +41,8 @@ The below table lists maintainers' responsibilities and available resources. Ple | Maintainer Responsibility | How FINOS supports you | |:---|:---| -| **Grow project maturity and community** | Virtually all FINOS hosted projects are expected to strive towards, and ultimately attain, [Graduated status](/docs/governance/lifecycle-stages/graduated). The FINOS team supports projects in this journey through: | +| **Grow project maturity and community** | Virtually all FINOS hosted projects are expected to strive towards, and ultimately attain, [Graduated status](/docs/governance/lifecycle-stages/graduated). The FINOS team supports projects in this journey through: | | **Run Project Meetings** | Project maintainers are welcome to engage with their project community through project meetings. If they choose to do so, maintainers are responsible for creating meeting agendas, recording meeting attendance and publishing meeting minutes. | -| **CI/CD** . | Project maintainers are responsible for integrating Continuous Integration and Continuous Deployment into their FINOS project builds: | +| **CI/CD** | Project maintainers are responsible for integrating Continuous Integration and Continuous Deployment into their FINOS project builds: | | **Documentation** | Maintainers are responsible for publishing project documentation from their project's GitHub Repositories to FINOS Project Websites. | | **Security** | Maintainers are responsible for preventing, discovering and responsibly disclosing Security Vulnerability Issues as they affect their projects | diff --git a/docs/governance/Board-Election-Procedure.md b/docs/governance/Board-Election-Procedure.md index b28fbee8..fe79c818 100644 --- a/docs/governance/Board-Election-Procedure.md +++ b/docs/governance/Board-Election-Procedure.md @@ -1,6 +1,7 @@ --- id: board-election title: Governing Board Election Procedure +description: "How FINOS elects its Governing Board: procedures, ranked-choice voting, seat classes, and participation for Platinum, Gold, and Silver member firms." --- FINOS uses a ranked-choice instant-runoff voting process for elections of Gold and Silver representatives on the Governing Board. These are the rules by which the results are tabulated. (Platinum representatives are not elected, but are appointed by individual Platinum members.) diff --git a/docs/governance/Charter.md b/docs/governance/Charter.md index d5bd4a00..343a1f8f 100644 --- a/docs/governance/Charter.md +++ b/docs/governance/Charter.md @@ -1,6 +1,7 @@ --- id: funding-documents title: FINOS Funding Documents +description: "The Linux Foundation FINOS Charter and Participation Agreement: membership, board structure, and legal terms for collaborative open source projects." --- FINOS is a directed fund of the Linux Foundation governed by the following documents publicly available on the [FINOS website governance page](https://finos.org/governance): diff --git a/docs/governance/Code-of-Conduct.md b/docs/governance/Code-of-Conduct.md index 0057e7f6..becc2254 100644 --- a/docs/governance/Code-of-Conduct.md +++ b/docs/governance/Code-of-Conduct.md @@ -1,6 +1,7 @@ --- id: code-of-conduct title: Community Code of Conduct +description: "The FINOS Community Code of Conduct: expected behavior, reporting issues, and inclusive collaboration across meetings, chat, and GitHub for all participants." --- ## Overview diff --git a/docs/governance/Collaborative-Principles.md b/docs/governance/Collaborative-Principles.md index 28252022..04334cd2 100644 --- a/docs/governance/Collaborative-Principles.md +++ b/docs/governance/Collaborative-Principles.md @@ -1,6 +1,7 @@ --- id: collaborative-principles title: Our Collaborative Principles +description: "Collaborative principles for FINOS: openness, respect, transparency, and productive engagement across members, maintainers, and contributors in open finance." --- FINOS technical projects are free to determine their own governance so long as it is consistent with [FINOS policies](https://finos.org/governance). However, projects are expected to adhere to best practices for open source collaboration. The practices documented here help to ensure that FINOS projects are well-documented, inclusive, free of intellectual property issues, and responsive to their communities. diff --git a/docs/governance/Individual-Supporter-Program.md b/docs/governance/Individual-Supporter-Program.md index cbdf62aa..bc62479d 100644 --- a/docs/governance/Individual-Supporter-Program.md +++ b/docs/governance/Individual-Supporter-Program.md @@ -1,6 +1,7 @@ --- id: individual-supporter-program title: Individual Supporter Program +description: "FINOS Individual Supporter program: benefits and recognition for people who give sustained contributions to projects without a corporate membership." --- The Individual Supporter program recognizes individuals who are not affiliated with FINOS corporate members but have made significant contributions to FINOS collaborative projects. Individuals who meet the criteria below may apply to join the program and receive members-only benefits. diff --git a/docs/governance/Meeting-Procedures.md b/docs/governance/Meeting-Procedures.md index 49bf4c2e..f5e907db 100644 --- a/docs/governance/Meeting-Procedures.md +++ b/docs/governance/Meeting-Procedures.md @@ -1,6 +1,7 @@ --- id: meeting-procedures title: Meetings of FINOS projects +description: "How FINOS projects and SIGs run meetings: agendas, minutes, the public community calendar, and tools maintainers use to keep discussions effective." --- :::caution diff --git a/docs/governance/Project-Branding-Guidelines.md b/docs/governance/Project-Branding-Guidelines.md index 08c64f32..d6ec30a4 100644 --- a/docs/governance/Project-Branding-Guidelines.md +++ b/docs/governance/Project-Branding-Guidelines.md @@ -1,6 +1,7 @@ --- id: project-branding-guidelines title: Project Branding Guidelines +description: "Project naming, logos, and trademarks for FINOS software: follow foundation branding and Linux Foundation policies so users can trust your marks." --- One of the first steps any open source project takes is choosing a name (and possibly a logo). Project names and logos (referred to collectively as "marks" in this document) should be distinctive and should avoid incorporating the names and logos of third parties and third-party products. diff --git a/docs/governance/Project-Lifecycle.md b/docs/governance/Project-Lifecycle.md index d5281ea5..52996818 100644 --- a/docs/governance/Project-Lifecycle.md +++ b/docs/governance/Project-Lifecycle.md @@ -1,6 +1,7 @@ --- id: project-lifecycle title: Lifecycle introduction +description: "FINOS project lifecycle at a glance: how projects move from formation through graduated or archived, and what each stage means for users and members." --- # Introduction diff --git a/docs/governance/README.md b/docs/governance/README.md index 09de95ef..ee940ee7 100644 --- a/docs/governance/README.md +++ b/docs/governance/README.md @@ -1,12 +1,12 @@ --- id: intro -title: Overview +title: Foundation Governance +sidebar_label: Overview +description: "How FINOS is governed: Governing Board, TOC, membership tiers, policies, and community rules for software projects, standards, and SIGs." --- This space provides an overview of the Foundation's governance: -# Foundation Governance - ## Membership FINOS is a membership organization within the [Linux Foundation](http://linuxfoundation.org/). We have four tiers of corporate membership (Platinum, Gold, Silver and Associate), each with different rights and obligations under the Foundation's [Funding Documents](funding-documents). Please refer to the FINOS website for more information on [FINOS members and membership benefits](https://www.finos.org/membership-benefits) or reach out to [membership@finos.org](mailto:membership@finos.org). @@ -68,19 +68,19 @@ All participants in SIGs are subject to [FINOS Policies](#policies) and [Communi Documents produced or contributed as part of the SIG will be contributed and made available under CC-BY-4.0. -# Project Lifecycle and steering +## Project Lifecycle and Steering -## Project Lifecycle +### Project Lifecycle Software projects follow the [Project Lifecycle](/docs/governance/project-lifecycle), a useful tool for consumers and contributors to quickly evaluate maturity, activity, and quality. Projects may begin in either the "Labs" or "Incubating" state, graduate to "Graduated", and finally may move to the "Archived" state (from either Labs, Incubating, or Graduated) if they are no longer actively developed. The TOC approves lifecycle transitions following objective criteria detailed for [Incubating](/docs/governance/lifecycle-stages/incubating) and [Graduated](/docs/governance/lifecycle-stages/graduated) projects. Some projects may optionally start in a time-bound pre-incubation stage called *Formation*, which is typically restricted to FINOS Members or at the discretion of the project lead. [Forming projects](/docs/governance/project-lifecycle) might not be publicly visible until entering Incubation when they will be fully open sourced. -## Project Metrics +### Project Metrics Live metrics of Project activity and contributions across all FINOS collaboration systems are publicly available in [FINOS Project Activity Dashboard](https://metrics.finos.org). -## Project Governing Board Reporting +### Project Governing Board Reporting Periodically data about the health, activity, and progress of projects is reported to the Governing Board. Reports are largely generated automatically out of the [FINOS Project Activity Dashboard](https://metrics.finos.org) and provided to the TOC for review before being passed along to the board. The Governing Board, TOC and FINOS team use these reports to determine which projects need additional attention, which should be considered for archiving, etc. Every year, the Governing Board identifies a few "strategic initiatives" to receive extra attention from the FINOS team during an agreed time period, with the goal of supporting growth and progression through the Project Lifecycle. Focus projects should be prepared to provide more detailed progress reports to the Board at the next Board meeting. diff --git a/docs/governance/Software-Projects/CSLA.md b/docs/governance/Software-Projects/CSLA.md index d2469c92..b0c74a5e 100644 --- a/docs/governance/Software-Projects/CSLA.md +++ b/docs/governance/Software-Projects/CSLA.md @@ -1,6 +1,7 @@ --- id: csla title: CSLA +description: "How FINOS governs open standards: participation models, IP rules, and what differs from open source software projects in the landscape." --- Within FINOS, an Open standard project is a project chartered primarily to produce technical standards specifications, rather than software. Standards projects follow a different set of processes than software projects, to account for the different intellectual property requirements of standards. The purpose of these rules is to ensure that all contributions to a standard are appropriately licensed and that the final published standard may be implemented freely by FINOS members and the community at large. diff --git a/docs/governance/Software-Projects/Contribution-Compliance-Requirements.md b/docs/governance/Software-Projects/Contribution-Compliance-Requirements.md index 53a00f61..51ec5d2c 100644 --- a/docs/governance/Software-Projects/Contribution-Compliance-Requirements.md +++ b/docs/governance/Software-Projects/Contribution-Compliance-Requirements.md @@ -2,6 +2,7 @@ id: contribution-compliance-requirements title: Contribution Requirements sidebar_label: Contribution Requirements +description: "Requirements before FINOS can merge your code: ICLA, CCLA, license checks, and policies that keep contributions compliant across regulated financial firms." --- ## Overview {#overview} diff --git a/docs/governance/Software-Projects/Contribution.md b/docs/governance/Software-Projects/Contribution.md index 91ce830a..0a8d26d4 100644 --- a/docs/governance/Software-Projects/Contribution.md +++ b/docs/governance/Software-Projects/Contribution.md @@ -1,6 +1,7 @@ --- id: contribution title: Contributing to FINOS +description: "Ways to contribute to FINOS: new project proposals, code and documentation, CLA steps, and joining SIGs and community programs across the foundation." --- There are several ways you can contribute to our existing projects and SIGs, and [FINOS Members](https://finos.org/members) can propose new projects for contribution. Take a look at the diagram below for an overall picture of how contributions flow into FINOS: diff --git a/docs/governance/Software-Projects/EasyCLA.md b/docs/governance/Software-Projects/EasyCLA.md index bc98d11c..826dcd3b 100644 --- a/docs/governance/Software-Projects/EasyCLA.md +++ b/docs/governance/Software-Projects/EasyCLA.md @@ -1,6 +1,7 @@ --- id: easycla title: EasyCLA +description: "EasyCLA: sign individual and corporate CLAs, verify employees, and satisfy merge gates so pull requests to FINOS repositories stay compliant and fast." --- :::caution diff --git a/docs/governance/Software-Projects/License-categories.md b/docs/governance/Software-Projects/License-categories.md index 899b5171..c1a2d585 100644 --- a/docs/governance/Software-Projects/License-categories.md +++ b/docs/governance/Software-Projects/License-categories.md @@ -1,6 +1,7 @@ --- id: license-categories title: License Categories +description: "License categories and policies for FINOS open source: approved licenses, documentation expectations, and how projects select SPDX identifiers for users." --- For additional background on license categories in FINOS and related resources, see [OSLC licenses](https://osr.finos.org/docs/osr-resources/oslc-licenses) in the FINOS Open Source Readiness documentation. diff --git a/docs/governance/Software-Projects/Security-Vulnerabilities-Responsible-Disclosure-Policy.md b/docs/governance/Software-Projects/Security-Vulnerabilities-Responsible-Disclosure-Policy.md index 2affc4ba..89031259 100644 --- a/docs/governance/Software-Projects/Security-Vulnerabilities-Responsible-Disclosure-Policy.md +++ b/docs/governance/Software-Projects/Security-Vulnerabilities-Responsible-Disclosure-Policy.md @@ -1,6 +1,7 @@ --- id: cve-responsible-disclosure title: FINOS Security Vulnerabilities Responsible Disclosure Policy +description: "Responsible disclosure for FINOS security issues: how reporters, maintainers, and users coordinate fixes, embargoes, and public communication about CVEs." --- :::caution Right now, FINOS does not operate a bug bounty program, and does not offer rewards or compensations of any kind in exchange for submitting potential bugs, issues or vulnerabilities. diff --git a/docs/governance/lifecycle-stages/archived.md b/docs/governance/lifecycle-stages/archived.md index 9ce5980c..ed25839b 100644 --- a/docs/governance/lifecycle-stages/archived.md +++ b/docs/governance/lifecycle-stages/archived.md @@ -1,6 +1,7 @@ --- id: archived title: Archived Stage +description: "Archived FINOS projects: what happens when work winds down, repository expectations, and continuity for long-term users and dependent communities." --- ## Badge diff --git a/docs/governance/lifecycle-stages/forming.md b/docs/governance/lifecycle-stages/forming.md index fd0364bd..95f4d784 100644 --- a/docs/governance/lifecycle-stages/forming.md +++ b/docs/governance/lifecycle-stages/forming.md @@ -1,6 +1,7 @@ --- id: forming title: Forming Stage +description: "Forming stage for FINOS: proposing projects and early SIGs, community bootstrapping, and expectations before a team advances toward full incubation." --- ## Badge diff --git a/docs/governance/lifecycle-stages/graduated.md b/docs/governance/lifecycle-stages/graduated.md index 4c96b0a0..a29b2d38 100644 --- a/docs/governance/lifecycle-stages/graduated.md +++ b/docs/governance/lifecycle-stages/graduated.md @@ -1,6 +1,7 @@ --- id: graduated title: Graduated Stage +description: "Graduated projects at FINOS: signal of maturity, active maintainers, and what users and members can expect from flagship open finance software and standards." --- ## Badge diff --git a/docs/governance/lifecycle-stages/incubating.md b/docs/governance/lifecycle-stages/incubating.md index d91646d7..f23af170 100644 --- a/docs/governance/lifecycle-stages/incubating.md +++ b/docs/governance/lifecycle-stages/incubating.md @@ -1,6 +1,7 @@ --- id: incubating title: Incubating Stage +description: "Incubating FINOS projects: quality expectations, community growth, and the journey toward strong graduated adoption in open source financial services." --- ## Badge diff --git a/docs/governance/lifecycle-stages/labs.md b/docs/governance/lifecycle-stages/labs.md index b310f6fe..1aeb38e0 100644 --- a/docs/governance/lifecycle-stages/labs.md +++ b/docs/governance/lifecycle-stages/labs.md @@ -1,6 +1,7 @@ --- id: labs title: Labs Stage +description: "Labs stage experiments: how early FINOS projects iterate with foundation support, exit criteria, and the path from innovation toward stable incubation." --- ## Badge diff --git a/docs/governance/special-interest-groups/README.md b/docs/governance/special-interest-groups/README.md index e1d09ad1..74edf187 100644 --- a/docs/governance/special-interest-groups/README.md +++ b/docs/governance/special-interest-groups/README.md @@ -1,6 +1,7 @@ --- id: intro title: Special Interest Groups +description: "Active FINOS Special Interest Groups: charters, leadership, and meeting info—plus how to propose a new SIG and engage across regulatory and tech topics." --- Special Interest Groups provide a venue to discuss and compare notes on a common topic of interest. SIGs governance is documented [here](/docs/governance#special-interest-groups). @@ -11,10 +12,10 @@ Here's a list of special interest groups (SIGs) currently active in FINOS: |---|---|---|---| | [Open Source Readiness](https://github.com/finos/open-source-readiness) | 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.| Cara Delia (Red Hat)
Brittany Istenes (Fannie Mae)
Thomas Cooper (RBC)
Peter Smulovics (Morgan Stanley) | April 21st 2021 | | [Financial Objects](https://github.com/finos/finos-fo/) | Provide a neutral forum for individuals across the financial services industry to collectively identify the need for new, open, financial objects standards as well as modifications to existing ones. Work to promote adoption of financial object definitions and models that support common industry workflows and use cases.| Ffion Acland (Goldman Sachs)
Ian Sloyan (ISDA) | April 21st 2021| -| [Innersource](https://github.com/finos/InnerSource/) | Create a safe space to identify and share challenges and solutions that accelerate Financial Services organizations’ efforts to implement InnerSource. | [Chairs](https://github.com/finos/InnerSource#innersource-sig-leadership) | [January 20st 2021](/governance-docs/202101-InnerSource-SIG-Proposal-APPROVED.pdf) | +| [Innersource](https://github.com/finos/InnerSource/) | Create a safe space to identify and share challenges and solutions that accelerate Financial Services organizations’ efforts to implement InnerSource. | [Chairs](https://github.com/finos/InnerSource#innersource-sig-leadership) | [January 20th, 2021](/governance-docs/202101-InnerSource-SIG-Proposal-APPROVED.pdf) | | [Regulation Innovation](https://github.com/finos/open-regtech) | The Regulation Innovation SIG will be a community of people interested in creating open source solutions for regulatory and compliance issues. Creating open source solutions to regulatory compliance is particularly important because the market is currently using custom-built, one-off solutions, that are expensive, inefficient, and costly to manage and update over time. | Ian Hollowbread (ING)
David Ehrich (AIR) | October 21st 2020 | | [DevOps Automation](https://github.com/finos/devops-automation) | Identify and share homegrown solutions that enable regulated enterprises to manage the engineering toolchain, from ‘admin proxies’ to ‘glue to connect multiple tools together’, whilst finding opportunities to collaborate with the FINOS Community and possibly set standards on how these challenges should be addressed. | Amol Shukla (Morgan Stanley)
Robb Keayes (Nomura) | October 21st 2020 | -| [Open Source Talent Acceleration](https://github.com/finos/open-source-talent-acceleration) | To provide actionable pathways for newcomers and mid-career professionals to nurture and drive continuous growth; bridge the skill gap and optimize the impact of open-source collaboration for FSIs. | [Chairs](https://github.com/finos/open-source-talent-acceleration?tab=readme-ov-file#co-chairs-2025) | In January 2022, the Board ratified this group operating as a SIG, after one year running as a Board committeee | January 2022 | +| [Open Source Talent Acceleration](https://github.com/finos/open-source-talent-acceleration) | To provide actionable pathways for newcomers and mid-career professionals to nurture and drive continuous growth; bridge the skill gap and optimize the impact of open-source collaboration for FSIs. | [Chairs](https://github.com/finos/open-source-talent-acceleration?tab=readme-ov-file#co-chairs-2025) | In January 2022, the Board ratified this group operating as a SIG, after one year running as a Board committee | January 2022 | | [Zenith](https://github.com/finos/zenith) | To explore and promote the adoption of new and innovative technologies in the financial services industry. | Peter Smulovics (Morgan Stanley)
Keith O'Donell (Feynic)
Patrick Downing (Morgan Stanley) | April 26th 2023 | | [AI Readiness](https://github.com/finos/ai-readiness) | Our goal is to mutually develop a governance framework that manages the on-boarding, development of, and running AI-based solutions within financial services organisations - allowing us all to unlock the potential of this disruptive technology in a safe, trustworthy and compliant way. | Colin Eberhardt (Scott Logic)
Ian Micallef (Citi) | January 30th 2024 | | ![badge-labs](https://user-images.githubusercontent.com/327285/230928932-7c75f8ed-e57b-41db-9fb7-a292a13a1e58.svg) [Distinguished Engineer Community](https://github.com/finos-labs/distinguished-engineer-community) | To build a community of Engineering leaders who can influence digital technology to have a positive impact on society. | Chair: Mark Brotherwood (Davies Group)
Co-Chair: Peter Thomas, DB | The SIG was approved on May 13th 2025 to begin operating in [finos-labs](https://github.com/finos-labs/) | diff --git a/docs/growing-your-project-community/finos-community-strategy/README.md b/docs/growing-your-project-community/finos-community-strategy/README.md index d906a710..c77969c9 100644 --- a/docs/growing-your-project-community/finos-community-strategy/README.md +++ b/docs/growing-your-project-community/finos-community-strategy/README.md @@ -1,6 +1,7 @@ --- id: leveraging-finos-projects-sigs title: Leveraging FINOS to Build Flourishing Projects and SIGs +description: "FINOS 2022 strategy for project and SIG leads: using foundation services to grow community, visibility, and sustainable collaboration in open finance." --- # Leveraging FINOS to Build Flourishing Projects and SIGs diff --git a/docs/growing-your-project-community/finos-community-strategy/communicate-why-and-how.md b/docs/growing-your-project-community/finos-community-strategy/communicate-why-and-how.md index a5c9935f..3b2d2a87 100644 --- a/docs/growing-your-project-community/finos-community-strategy/communicate-why-and-how.md +++ b/docs/growing-your-project-community/finos-community-strategy/communicate-why-and-how.md @@ -1,6 +1,7 @@ --- id: communicate-why-and-how title: Communicate WHY and HOW the FINOS Community should contribute +description: "Help contributors understand why FINOS matters and how to participate—clear messaging, onboarding, and calls to action for your project or SIG." --- # Communicate WHY and HOW the FINOS Community should contribute diff --git a/docs/growing-your-project-community/finos-community-strategy/coordinate-work.md b/docs/growing-your-project-community/finos-community-strategy/coordinate-work.md index 6db89ffb..3301e6a4 100644 --- a/docs/growing-your-project-community/finos-community-strategy/coordinate-work.md +++ b/docs/growing-your-project-community/finos-community-strategy/coordinate-work.md @@ -1,6 +1,7 @@ --- id: coordinate-work title: Coordinate work through GitHub Issues, Discussions and FINOS Slack +description: "Coordinate work on FINOS projects with GitHub Issues, Discussions, and FINOS Slack: practical patterns for maintainers to keep progress visible and organized." --- # Coordinate work through GitHub Issues, Discussions and FINOS Slack diff --git a/docs/growing-your-project-community/finos-community-strategy/create-an-open-profile.md b/docs/growing-your-project-community/finos-community-strategy/create-an-open-profile.md index f5ba118d..223dc274 100644 --- a/docs/growing-your-project-community/finos-community-strategy/create-an-open-profile.md +++ b/docs/growing-your-project-community/finos-community-strategy/create-an-open-profile.md @@ -1,6 +1,7 @@ --- id: create-an-open-profile title: Create an Open Profile to Benefit Maintainers and Contributors +description: "Why open maintainer and contributor profiles matter: discoverability, trust, and lower friction for newcomers joining your FINOS project or SIG on GitHub." --- # Create an Open Profile to Benefit Maintainers and Contributors diff --git a/docs/growing-your-project-community/finos-community-strategy/ensure-finos-project-security.md b/docs/growing-your-project-community/finos-community-strategy/ensure-finos-project-security.md index 8d8b76fd..b30d51cc 100644 --- a/docs/growing-your-project-community/finos-community-strategy/ensure-finos-project-security.md +++ b/docs/growing-your-project-community/finos-community-strategy/ensure-finos-project-security.md @@ -1,6 +1,7 @@ --- id: ensure-finos-project-security title: Ensure FINOS Project Security with LF Security Training and OpenSSF +description: "Security for FINOS projects: Linux Foundation security training, OpenSSF practices, and reducing risk across dependencies, tooling, and contributor workflows." --- # Ensure FINOS Project Security with LF Security Training and OpenSSF diff --git a/docs/growing-your-project-community/finos-community-strategy/finos-community-2022-strategic-overview.md b/docs/growing-your-project-community/finos-community-strategy/finos-community-2022-strategic-overview.md index c27ed41a..a55f0813 100644 --- a/docs/growing-your-project-community/finos-community-strategy/finos-community-2022-strategic-overview.md +++ b/docs/growing-your-project-community/finos-community-strategy/finos-community-2022-strategic-overview.md @@ -1,6 +1,7 @@ --- id: finos-community-2022-strategic-overview title: FINOS Community 2022 Strategic Overview +description: "Summary of the 2022 FINOS community strategy: goals for project growth, collaboration, and foundation programs for open source in financial services." --- # FINOS Community 2022 Strategic Overview diff --git a/docs/growing-your-project-community/finos-community-strategy/measure-finos-project-and-sig-success.md b/docs/growing-your-project-community/finos-community-strategy/measure-finos-project-and-sig-success.md index 6277d02d..1f1397e2 100644 --- a/docs/growing-your-project-community/finos-community-strategy/measure-finos-project-and-sig-success.md +++ b/docs/growing-your-project-community/finos-community-strategy/measure-finos-project-and-sig-success.md @@ -1,6 +1,7 @@ --- id: measure-finos-project-and-sig-success title: Measure FINOS Project and SIG Success with LFX Insights +description: "Measure FINOS project and SIG health with LFX Insights: community activity, diversity signals, and adoption trends for maintainers and the broader foundation." --- # Measure FINOS Project and SIG Success with LFX Insights diff --git a/docs/growing-your-project-community/finos-community-strategy/provide-an-amazing-engineering-experience.md b/docs/growing-your-project-community/finos-community-strategy/provide-an-amazing-engineering-experience.md index f130c009..1973f26d 100644 --- a/docs/growing-your-project-community/finos-community-strategy/provide-an-amazing-engineering-experience.md +++ b/docs/growing-your-project-community/finos-community-strategy/provide-an-amazing-engineering-experience.md @@ -1,6 +1,7 @@ --- id: provide-an-amazing-engineering-experience title: Provide an amazing engineering experience for first time contributors +description: "Give first time contributors a strong experience: triage, documentation, CI feedback, and reviews that make FINOS repositories welcoming to newcomers." --- # Provide an amazing engineering experience for first time contributors diff --git a/docs/growing-your-project-community/finos-community-strategy/recognise-community-achievements.md b/docs/growing-your-project-community/finos-community-strategy/recognise-community-achievements.md index 95c10873..bd3d71fd 100644 --- a/docs/growing-your-project-community/finos-community-strategy/recognise-community-achievements.md +++ b/docs/growing-your-project-community/finos-community-strategy/recognise-community-achievements.md @@ -1,6 +1,7 @@ --- id: recognise-community-achievements title: Work with FINOS to Recognise Community Achievements +description: "Recognize community achievements with FINOS: swag, blog coverage, and programs that thank contributors and maintainers for open source impact in finance." --- # Work with FINOS to Recognise Community Achievements diff --git a/docs/growing-your-project-community/meetups/README.md b/docs/growing-your-project-community/meetups/README.md index 01f39cfe..52aff0ff 100644 --- a/docs/growing-your-project-community/meetups/README.md +++ b/docs/growing-your-project-community/meetups/README.md @@ -1,6 +1,7 @@ --- id: finos-meetups title: FINOS Community Meetups +description: "FINOS community meetups: global and partner events, how to join technical talks, and how to host or present sessions on open source in financial services." --- The following are details of all FINOS and FINOS Member / Partner meetups open to the FINOS and wider open source community to join. Please reach out to help@finos.org if you'd like to organize or present at a FINOS meetup. diff --git a/docs/journey/Consume.md b/docs/journey/Consume.md index 987335ad..9ca29a94 100644 --- a/docs/journey/Consume.md +++ b/docs/journey/Consume.md @@ -1,6 +1,7 @@ --- id: consume title: Consume +description: "Use FINOS projects in your organization: find them in the landscape, assess maturity, licenses, and security, then engage the community or contribute." --- ## Ready to consume? diff --git a/docs/journey/Engage.md b/docs/journey/Engage.md index e1edbcb6..9f721df6 100644 --- a/docs/journey/Engage.md +++ b/docs/journey/Engage.md @@ -1,18 +1,19 @@ --- id: engage title: Engage +description: "Engage with FINOS: Code of Conduct, X and LinkedIn, meetings, events, OSFF, mailing lists, Slack, Symphony, and foundation support contacts." --- -# Ready to engage with our Community? +# Engage If you have already [learned](https://community.finos.org/docs/journey/learn) how FINOS works and started [using FINOS projects](https://community.finos.org/docs/journey/consume), this page shows how to take the next step: engage with the community and participate in activities across our [landscape](https://landscape.finos.org). -### Code of Conduct Violations +## Code of Conduct Violations Before we start, please know that all in-person and online interactions must happen within our [Community Code of Conduct page](https://www.finos.org/code-of-conduct). Instructions on reporting Code of Conduct violations are also included in that page. -### Engage & Amplify our message -As an individual you can play a huge part in amplifying our open-source message by following us, engaging / resharing, and sending us questions / feedback on [Twitter](https://twitter.com/finosfoundation) or [LinkedIn](https://www.linkedin.com/company/finosfoundation/). +## Engage & Amplify our message +As an individual you can play a huge part in amplifying our open-source message by following us, engaging / resharing, and sending us questions / feedback on [X](https://twitter.com/finosfoundation) or [LinkedIn](https://www.linkedin.com/company/finosfoundation/). ## Meet the Community! -Why not joining a Project or a SIG online Meeting? Browse the [FINOS Community Calendar](https://www.finos.org/finos-community-calendar) and know all of our project or SIG meetings are open to anyone and free to attend. +Why not join a Project or a SIG online Meeting? Browse the [FINOS Community Calendar](https://www.finos.org/finos-community-calendar) and know all of our project or SIG meetings are open to anyone and free to attend. Ready to meet the Community at large, online or in person? Take a look at our [recurring meetups schedule](/docs/growing-your-project-community/meetups) and our [Events](https://www.finos.org/hosted-events), including our flagship event the [Open Source in Finance Forum](https://events.linuxfoundation.org/open-source-finance-forum/), the global event solely dedicated to open source in financial services. diff --git a/docs/journey/Lead.md b/docs/journey/Lead.md index d1feb260..f2928f1c 100644 --- a/docs/journey/Lead.md +++ b/docs/journey/Lead.md @@ -1,6 +1,7 @@ --- id: lead title: Lead +description: "Paths to leadership at FINOS: project maintainership, corporate membership, governance contributions, meetups, and speaking at Open Source in Finance Forum." --- ## How can you become a FINOS Community leader? As you start [consuming](https://community.finos.org/docs/journey/consume) and [contributing](https://community.finos.org/docs/journey/participate) to FINOS projects, there are multiple ways for you to become a leader in our community: diff --git a/docs/journey/Learn.md b/docs/journey/Learn.md index ddf5af60..25794582 100644 --- a/docs/journey/Learn.md +++ b/docs/journey/Learn.md @@ -1,6 +1,7 @@ --- id: learn title: Learn +description: "New to FINOS? Explore resources, Slack, lists, the landscape, governance, Open Source Readiness, office hours, and where to get help from the team." --- If you are new to FINOS, new to Open Source, or working for an organization looking to accelerate their open source consumption and contribution, FINOS hosts a set of free and member-only resources, as well as meetings, events and other venues for financial services developers and subject matter experts to fully embrace the benefits of open source. @@ -12,7 +13,7 @@ Additionally, FINOS provides access to self-serve and interactive channels to le Here are some suggestions to kick off your FINOS journey: - Join the [Community Mailing List](mailto:community+subscribe@finos.org) and/ or the [FINOS Member-only mailing List](mailto:member+subscribe@finos.org) if you are an employee of a [FINOS Member](https://finos.org/members) -- Join our [Slack channels](https://finos-lf.slack.com/messages/finos-community/) (email [help@finos](mailto:help@finos.org) if you have issues joining) +- Join our [Slack channels](https://finos-lf.slack.com/messages/finos-community/) (email [help@finos.org](mailto:help@finos.org) if you have issues joining) - Learn about [FINOS Projects & Special Interest Groups](http://landscape.finos.org/) and a [Project or SIG Meeting](https://www.finos.org/finos-community-calendar) - Learn about the FINOS [Open Source Readiness Initiative](https://finos.org/open-source-readiness) and join [Open Source Readiness Special Interest Group (SIG)](https://osr.finos.org) meeting to improve your firm's participation to Open Source - Learn [how the FINOS Community is governed](/docs/governance) @@ -25,7 +26,7 @@ Here are some suggestions to kick off your FINOS journey: - Browse the [FINOS Youtube Channel](https://www.youtube.com/c/FINOS) - Read our [FAQ](https://www.finos.org/faq) - [Sign up for FINOS updates](https://www.finos.org/sign-up) -- Follow us on [Twitter](https://twitter.com/finosfoundation) or [LinkedIn](https://www.linkedin.com/company/finosfoundation/) +- Follow us on [X](https://twitter.com/finosfoundation) or [LinkedIn](https://www.linkedin.com/company/finosfoundation/) ## Need help? Email [help@finos.org](mailto:help@finos.org) and we will be in touch shortly diff --git a/docs/journey/Participate.md b/docs/journey/Participate.md index 34aae4c2..fd84f1db 100644 --- a/docs/journey/Participate.md +++ b/docs/journey/Participate.md @@ -1,6 +1,7 @@ --- id: participate title: Contribute +description: "Start contributing to FINOS: EasyCLA, Good First Issues, your first pull request, and links to contribution rules and the contributor cheatsheet." --- ## Quickstart If you want the tl;dr of how to start contributing to FINOS, a great starting point is our [Community Quickstart page](https://www.finos.org/get-involved). diff --git a/docs/platforms/legend-studio-shared.mdx b/docs/platforms/legend-studio-shared.mdx index c53e55a2..9c0c78a5 100644 --- a/docs/platforms/legend-studio-shared.mdx +++ b/docs/platforms/legend-studio-shared.mdx @@ -1,6 +1,7 @@ --- id: legend-studio-shared title: FINOS Legend Studio Shared instance +description: "Shared Legend Studio sandbox for FINOS: evaluate the end-to-end data platform, try workflows, and learn how Legend supports open finance modeling." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/platforms/symphony-dev-pod.mdx b/docs/platforms/symphony-dev-pod.mdx index 5675098a..a1319daa 100644 --- a/docs/platforms/symphony-dev-pod.mdx +++ b/docs/platforms/symphony-dev-pod.mdx @@ -1,6 +1,7 @@ --- id: symphony-dev-pod title: Symphony Developer Pod +description: "Symphony Developer Pod access for FINOS projects: accounts, compliance notes, and how teams build bots and integrations on Symphony in open programs." --- import useBaseUrl from '@docusaurus/useBaseUrl'; diff --git a/docs/project-sandbox.mdx b/docs/project-sandbox.mdx index 37b4b560..3e472eca 100644 --- a/docs/project-sandbox.mdx +++ b/docs/project-sandbox.mdx @@ -1,6 +1,7 @@ --- id: project-sandbox title: FINOS Project Sandbox +description: "FINOS Project Sandbox: shared infrastructure for live demos and evaluation environments, with operations support to help projects showcase software safely." --- The FINOS Project Sandbox allows [FINOS open source projects](https://landscape.finos.org) to host a public runtime environment to serve different purposes, like enabling easy evaluation, public collaboration or delivering real life demo environments. The FINOS technology team provides infrastructure and operational support to project maintainers, enabling them to focus on development rather than operations. diff --git a/docs/project-support-guidelines.md b/docs/project-support-guidelines.md index bd1073d8..533c9f81 100644 --- a/docs/project-support-guidelines.md +++ b/docs/project-support-guidelines.md @@ -1,6 +1,7 @@ --- id: project-support-guidelines title: Project Support Guidelines +description: "What FINOS provides by lifecycle stage: legal, security scanning, events, and platform support available to help project teams across formation to graduated." --- ||Formation (Focus)|Formation (Non Focus)||Incubating (Focus)|Incubating (Non Focus)|Graduated (Focus)|Graduated (Non Focus)|Archived|Notes (and work to be done)|Issue URL| diff --git a/docs/rfcs/202001-rfc-program-removal.md b/docs/rfcs/202001-rfc-program-removal.md index 06b179d0..597c3200 100644 --- a/docs/rfcs/202001-rfc-program-removal.md +++ b/docs/rfcs/202001-rfc-program-removal.md @@ -1,4 +1,3 @@ - # Foreword The purpose of this document is to propose simplifications to the governance of FINOS projects. We’ll discuss several issues with the existing governance structure and propose a simplified structure reducing hierarchy and bureaucracy. diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 3b4fe089..3267489e 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -11,13 +11,15 @@ module.exports = { projectName: `FINOS ${projectName}`, organizationName: 'FINOS', // fail build on broken links - // onBrokenLinks: 'log', + onBrokenLinks: 'throw', + onBrokenMarkdownLinks: 'warn', customFields: { repoUrl: `https://github.com/finos/${projectSlug}`, }, scripts: ['https://buttons.github.io/buttons.js'], stylesheets: ['https://fonts.googleapis.com/css?family=Overpass:400,400i,700'], themeConfig: { + image: 'img/og-image.png', // Algolia search is only enabled when ALGOLIA_API_KEY is set // For builds without the API key, search will be disabled gracefully ...(process.env.ALGOLIA_API_KEY && { @@ -36,6 +38,12 @@ module.exports = { defaultMode: 'light', disableSwitch: true, }, + metadata: [ + { name: 'keywords', content: 'FINOS, open source finance, financial services, fintech, community, Linux Foundation' }, + { name: 'description', content: 'The FINOS Community site — governance, contributor onboarding, SIGs, and best practices for the Fintech Open Source Foundation.' }, + { name: 'twitter:card', content: 'summary_large_image' }, + { name: 'twitter:site', content: '@FINOSFoundation' }, + ], navbar: { title: `FINOS ${projectName}`, logo: { @@ -147,9 +155,15 @@ module.exports = { 'https://github.com/finos/community/edit/main/website/', sidebarPath: require.resolve('./sidebars.js') }, + sitemap: { + changefreq: 'monthly', + priority: 0.7, + filename: 'sitemap.xml', + ignorePatterns: ['/404*'], + }, theme: { customCss: require.resolve('./src/css/custom.css'), - } + }, } ] ] diff --git a/website/src/pages/index.js b/website/src/pages/index.js index b9831eab..bcb60581 100644 --- a/website/src/pages/index.js +++ b/website/src/pages/index.js @@ -12,7 +12,7 @@ function Home() { return ( + description="FINOS Community documentation: governance, contributor onboarding, SIGs, project lifecycle, collaboration on GitHub, CI/CD, and best practices for open finance.">
diff --git a/website/static/img/og-image.png b/website/static/img/og-image.png new file mode 100644 index 00000000..ceee5c17 Binary files /dev/null and b/website/static/img/og-image.png differ diff --git a/website/static/robots.txt b/website/static/robots.txt new file mode 100644 index 00000000..0063525d --- /dev/null +++ b/website/static/robots.txt @@ -0,0 +1,3 @@ +User-agent: * +Allow: / +Sitemap: https://community.finos.org/sitemap.xml