From 29b8f979f87a2a07938946159bd2e827405258a2 Mon Sep 17 00:00:00 2001 From: Carlos O'Donell Date: Wed, 28 Feb 2024 10:03:36 -0500 Subject: Provide top-level description of CTI, TAC, and Governance. Remove build/ tree and add to .gitignore. Includes FAQ section. Signed-off-by: Carlos O'Donell --- source/conf.py | 3 ++- source/faq/index.rst | 76 ++++++++++++++++++++++++++++++++++++++++++++++++++++ source/gov/index.rst | 33 +++++++++++++++++++++++ source/index.rst | 72 ++++++++++++++++++++++++++++++++++++++++++------- source/tac/index.rst | 35 ++++++++++++++++++++++++ 5 files changed, 208 insertions(+), 11 deletions(-) create mode 100644 source/faq/index.rst create mode 100644 source/gov/index.rst create mode 100644 source/tac/index.rst (limited to 'source') diff --git a/source/conf.py b/source/conf.py index 2f612ab..c132d06 100644 --- a/source/conf.py +++ b/source/conf.py @@ -7,7 +7,7 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'Core Toolchain Infrastructure Project' -copyright = '2024, CTI TAC' +copyright = '2024, Core Toolchain Infrastructure Project' author = 'CTI TAC' # -- General configuration --------------------------------------------------- @@ -24,5 +24,6 @@ exclude_patterns = [] # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output # 2024-02-12: codonell: Use Piccolo Theme (https://github.com/piccolo-orm/piccolo_theme) +html_title = "Core Toolchain Infrastructure Project" html_theme = 'piccolo_theme' html_static_path = ['_static'] diff --git a/source/faq/index.rst b/source/faq/index.rst new file mode 100644 index 0000000..1107cea --- /dev/null +++ b/source/faq/index.rst @@ -0,0 +1,76 @@ +.. index:: + single: FAQ + +FAQ +=== + +You have questions we have answers! + +* Q: How does this project relate to the GNU Project or the Free Software + Foundation (FSF)? + + * A: Many of the GNU Toolchain components are a part of the GNU + Project, and contribute to the development of the GNU system. + The FSF supports the GNU Project, and in turn supports the GNU + Toolchain. The GNU Toolchain community works with the FSF via a + working together fund (https://www.fsf.org/working-together/fund) + to support the development of the GNU Toolchain directly. + The Core Toolchain Infrastructure project is distinct from the + GNU Project and the FSF. + +* Q: How does this project relate to the GCC Compile Farm Project + (https://gcc.gnu.org/wiki/CompileFarm)? + + * A: The GCC Compiler Farm is a unique resource for the GNU Toolchain + and provides interactive systems for developers to manually test on + a wide variety of hardware and software configurations. This is not + exactly the same set of requirements that the community might have + for securing a supply chain, or using modern CI/CD workflows. + +* Q: How will the composition of the Core Toolchain infrastructure project + reflect the communities it supports? + + * A: Members of the GNU Toolchain community will always be invited to + become members of the technical advisory cuncil for the project. + +* Q: What is the composition of the project steering committee? + + * A: The project steering committee will be composed of sponsoring + members of the Linux Foundation and members of the GNU Toolchain + community. + +* Q: What does the project TAC do? + + * A: The TAC takes input from the GNU Toolchain community and works + with the members to, implement, and resolve prioritized requirements. + +* Q: Is the GNU Toolchain development model going to change? + + * A: No. The aim of the project is to provide additional infrastructure + for the community that is being made available to support the + GNU Toolchain. All development changes will always be driven by the + community. + +* Q: Is Sourceware (https://sourceware.org/) going to be deprecated? + + * A: The GNU Toolchain Infrastructure project is distinct from Sourceware. + The intent is to move critical infrastructure from Sourceware to the + Core Toolchain Infrastructure project to provide paid services. + +* Q: Who can use the new infrastructure? + + * A: That depends on the requirements given by the GNU Toolchain community. + The requirements from the community are input to the steering committee, + and so the answer depends largely on exactly what was the intended purpose. + +* Q: What can the new infrastructure be used for? + + * A: That depends on the requirements given by the GNU Toolchain community. + The requirements from the community are input to the steering committee, + and so the answer depends largely on exactly what was the intended purpose. + +----------------- + +* :ref:`genindex` + +* :ref:`search` diff --git a/source/gov/index.rst b/source/gov/index.rst new file mode 100644 index 0000000..3a20f57 --- /dev/null +++ b/source/gov/index.rst @@ -0,0 +1,33 @@ +.. index:: + single: Core Toolchain Infrastructure project governance + +CTI Governance +============== + +The Core Toolchain Infrastructure project follows a governance model that +contains a governing board (GB), and a technical advisory council (TAC). + +By default all governing board and technical advisory council meetings are +open the public to attend unless there is an issue that requires +confidentiality e.g. security. + +The role of the TAC is to work with the GNU Toolchain community to prioritze +and refine requirments so they can be implemented to support the community. + +The TAC has a seat on the GB, and must vote one of their members to attend +GB meetings. The GB is fiscally accountable for the spending of funds and +acts as oversight to approve prioritized projects that are presented by the +TAC. + +Sponsors to the Core Toolchain Infrastructure project are entitled to one +GB set and one TAC seat. + +The intial TAC bootstrap included 3 community members and was expanded to +10 members. Membership in the TAC requires GB approval. + +----------------- + +* :ref:`genindex` + +* :ref:`search` + diff --git a/source/index.rst b/source/index.rst index 5f56b16..991f5a9 100644 --- a/source/index.rst +++ b/source/index.rst @@ -1,20 +1,72 @@ -.. Core Toolchain Infrastructure Project documentation master file, created by - sphinx-quickstart on Mon Feb 12 10:53:15 2024. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. +.. Core Toolchain Infrastructure Project -Welcome to Core Toolchain Infrastructure Project's documentation! -================================================================= +.. index:: + single: Core Toolchain Infrastructure Project (Homepage) + +Core Toolchain Infrastructure Project +===================================== + +**The Core Toolchain Infrastructure (CTI) Project's mission is to support +the GNU Toolchain community with secure infrastructure and state of the art +services required to support the community’s development efforts to be a +trusted foundation in a secure supply chain.** .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: + gov/index + tac/index + faq/index + +The Core Toolchain Infrastructure (CTI) project is hosted and supported by the +`Open Secure Software Foundation (OpenSSF) `_, +the `Linux Foundation (LF) `_ and its members. +The primary sponsor is the OpenSSF. The IT service provider is the LF IT core +projects team. CTI uses only free and open source software (FOSS) to provide +these services and aims to comply with `GNU Ethical Repository hosting criteria +`_ category B or +"Good enough to recommend." + +The development of the GNU Toolchain is a part of the +`GNU Project `_, supported by the +`FSF `_ and a worldwide community of developers and +corporate sponsors. The GNU Toolchain aims to develop the toolchain +used in the GNU/Linux system and Linux distributions built with +the GNU Toolchain. + +The GNU Toolchain development effort uses an open development environment +and supports many other platforms in order to foster a world-class +optimizing compiler, assembler, linker, debugger, C Library, language +runtimes and utilities. +The CTI Project aims to support the GNU Toolchain to attract a larger +community of developers; to ensure that GNU Toolchain and the GNU system +work on multiple architectures and diverse environments; and to more +thoroughly test, extend and enhance the features of the GNU Toolchain. -Indices and tables -================== +The CTI project continues to move forward the goal of creating a long-term +sustainable set of secure and state of the art services and infrastructure +for the GNU Toolchain and related packages. + +Some of the major goals include: + + * Financial continuity planning. + * Developer continuity planning. + * Governance continuity planning. + * Security policy planning. + +The GNU Toolchain community should be making consistent forward progress +to improve infrastructure and cybersecurity positions. Showing progress +is important for the ecosystem to trust us as a secure and critical part +of the software supply chain. We should not wait until there are +cybersecurity regulations that are beyond our ability to comply with as +the FOSS ecosystem of tooling and infrastructure. Projects of similar +scope and importance have been deploying significant resources for the +use of the development community. + +----------------- * :ref:`genindex` -* :ref:`modindex` + * :ref:`search` diff --git a/source/tac/index.rst b/source/tac/index.rst new file mode 100644 index 0000000..3fb75b8 --- /dev/null +++ b/source/tac/index.rst @@ -0,0 +1,35 @@ +.. index:: + single: Core Toolchain Infrastructure Technical Advisory Council + +CTI TAC +======= + +The Core Toolchain Infrastructure Technical Advisory Council is +currently made up of the following community member (alphabetical): + +* Carlos O'Donell +* David Edelsohn +* Frank Ch. Eigler +* Jeff Law +* Joel Brobecker +* Jose Marchesi +* Joseph Myers +* Nick Clifton +* Siddhesh Poyarekar +* Simon Marchi + +The current CTI TAC has representatives from GNU Maintainers for gcc, +binutils, glibc and gdb. + +We wish to extend a heartfelt thank you to our previous CTI TAC members: + +* Martin Liška +* Chris Faylor + +You can reach the CTI TAC by emailing `cti-tac@lists.linuxfoundation.org `_. + +----------------- + +* :ref:`genindex` + +* :ref:`search` -- cgit 1.2.3-korg