diff --git a/GOVERNANCE.md b/GOVERNANCE.md index 981582c819..04c2a5352f 100644 --- a/GOVERNANCE.md +++ b/GOVERNANCE.md @@ -22,7 +22,7 @@ OpenFL has the following roles in the project: ### Users One of the main OpenFL design principles is a **great usability**. We aim to build an easily to use library for Federated Learning and bring to users a great developer experience. We believe that our users and customers should guide us in building the great software that solves the data silo and data privacy problems. We encourage users to provide us feedback, ask questions, initiate discussions, propose bug reports and suggest features through the following tools and formats: -- Usage of [OpenFL](https://openfl.readthedocs.io/en/latest/manual.html); +- Usage of [OpenFL](https://openfl.readthedocs.io/en/latest/developer_guide/manual.html); - Discussions in our [Slack channel](https://join.slack.com/t/openfl/shared_invite/zt-ovzbohvn-T5fApk05~YS_iZhjJ5yaTw); - Opening [Issues](https://github.com/securefederatedai/openfl/issues) and [discussion topics](https://github.com/securefederatedai/openfl/discussions) in our GitHub; - Participation in [Community Meetings](https://github.com/securefederatedai/openfl#support). @@ -53,14 +53,12 @@ Maintainers’ responsibilities: - Participate in discussions through Slack, GitHub or community meetings; - Answer the questions and provide reasonable assistance to users and contributors. -See the list of Maintainers [here](https://github.com/securefederatedai/openfl/MAINTAINERS.md). There is no limit on the maximum number of maintainers. - See calendar of the public maintainers meetings [here](https://wiki.lfaidata.foundation/pages/viewpage.action?pageId=70648254). ### Technical Steering Committee The Technical Steering Committee (TSC) is the main decision-making authority of the OpenFL project. The TSC defines the strategic objective of the project, makes business & legal decisions, as well as high-level technical decisions. The TSC consists of elected members. The election takes place every year by the end of the first quarter (Q1) of the year* , but changes in the TSC may be made during the year based on the project needs and the decision by current TSC members. -The current list of TSC members is [here](https://github.com/securefederatedai/openfl/TSC). The number of TSC members can be increased, but up to a reasonable size (no more than 9 people). The minimum size of the TSC should not be less than 3 people. +The current list of TSC members is [here](https://github.com/securefederatedai/openfl/blob/develop/TSC.md). The number of TSC members can be increased, but up to a reasonable size (no more than 9 people). The minimum size of the TSC should not be less than 3 people. \* For 2023 there will be no elections, TSC members and Chair are defined by the founding organizations. @@ -84,7 +82,7 @@ The TSC members are responsible for all business, legal and technical oversight - Coordinate any *marketing events*, or communications regarding the project. #### TSC Chair -The Technical Steering Committee has a Chair. The current TSC Chair is listed [here](https://github.com/securefederatedai/openfl/TSC). The election of a new Chair takes place every year (by the end of Q1 of the year). +The Technical Steering Committee has a Chair. The current TSC Chair is listed [here](https://github.com/securefederatedai/openfl/blob/develop/TSC.md). The election of a new Chair takes place every year (by the end of Q1 of the year). TSC Chair’s responsibilities: - Serve as the primary *communication contact* between OpenFL and the [LF AI & Data Foundation](https://lfaidata.foundation/); diff --git a/MAINTAINERS.md b/MAINTAINERS.md deleted file mode 100644 index 5e1e5c277c..0000000000 --- a/MAINTAINERS.md +++ /dev/null @@ -1,10 +0,0 @@ -# OpenFL Maintainers (alphabetical order) - -Mansi Sharma; - -Manuel Santana Castolo; - -Omar Montoya Chavez; - -Patrick Foley; - diff --git a/ROADMAP.md b/ROADMAP.md index eac554d56b..8f9b960233 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -44,7 +44,7 @@ The interactive API was originally designed to be a high-level API for OpenFL, b ### 1.4 Consolidating interfaces Today we support three interfaces: TaskRunner, native Python API, and interactive API. These are all distinct APIs, and are not particularly interoperable. -By the time we reach OpenFL 2.0, our intention is to deprecate the original native [Python API](https://openfl.readthedocs.io/en/latest/source/workflow/running_the_federation.notebook.html) used for simulations, +By the time we reach OpenFL 2.0, our intention is to deprecate the original native [Python API](https://openfl.readthedocs.io/en/latest/get_started/examples.html#python-native-api) used for simulations, bring consistency to the remaining interfaces with a high level, middle level, and low level API that are **fully interoperable**. This will result in being able to use the interface you're most comfortable with for a simulation, single experiment, or experiment session (with the director / envoy infrastructure). @@ -59,7 +59,7 @@ This causes community fragmentation and distracts from some of the bigger proble ## Upcoming OpenFL releases ### OpenFL 1.6 (Q4 2023) -1. Use the OpenFL Workflow Interface on distributed infrastructure with the [FederatedRuntime](https://openfl.readthedocs.io/en/latest/workflow_interface.html#runtimes-future-plans) +1. Use the OpenFL Workflow Interface on distributed infrastructure with the [FederatedRuntime](https://openfl.readthedocs.io/en/latest/about/features_index/workflowinterface.html#runtimes-future-plans) 2. LLM Support 3. New use cases enabled by custom workflows * Standard ML Models (i.e. Tree-based algorithms) diff --git a/docs/structurizer_dsl/README.md b/docs/structurizer_dsl/README.md index dbe0df364f..bbea100759 100644 --- a/docs/structurizer_dsl/README.md +++ b/docs/structurizer_dsl/README.md @@ -5,7 +5,7 @@ https://github.com/structurizr/dsl/blob/master/docs/language-reference.md#
Article: https://dev.to/simonbrown/getting-started-with-the-structurizr-cli-10c2
Git: -https://github.com/structurizr/cli/blob/master/docs/export.md
+https://github.com/structurizr/cli/blob/master/README.md
2. Using Structurizer CLI with Docker:
https://github.com/aidmax/structurizr-cli-docker