diff --git a/process/start_project.md b/process/start_project.md index d2450860..4962afc3 100644 --- a/process/start_project.md +++ b/process/start_project.md @@ -37,7 +37,7 @@ Shared R&D with a broad ecosystem means bringing more contributors and maintaine ### Drive broad industry awareness with the press and analysts. -Your project will get broad motion picture, visual effects, tech, and open source exposure through our large audience, extensive media outreach partnerships with publications such as Linux.com and TFiR, and key partners. +Your project will get broad industry and open source exposure through our large audience, extensive media outreach partnerships with publications such as Linux.com and TFiR, and key partners. - Your project will be featured on both the [{{ site.foundation_name }}]({{ site.website_url }}) and the [Linux Foundation](https://www.linuxfoundation.org/projects) websites, as well as the [{{ site.foundation_name }} Landscape](https://l.lfenergy.org) - Always available guest blog post(s) on the [{{ site.foundation_name }} blog]({{ site.blog_url }}) on project updates. @@ -97,7 +97,7 @@ The “LF Way”, which is aligned with how {{ site.foundation_name }} operates, The project must: - Use an approved [OSI open-source license](https://opensource.org/licenses). -- Be supported by a [TAC member]({{ site.tac_member_list.url }}). +- Be supported by a [TAC member]({{ site.tac_member_list_url }}). - Allow neutral ownership of project assets such as a trademark, domain, or GitHub account (the community can define and manage rules). - Technical "do-ocracy" and separation of business governance from technical governance (we're flexible on the model) are clearly documented (which we can help you establish). - Allow anyone to participate in the technical community, whether or not a financial member or supporter of the project. @@ -106,13 +106,13 @@ Often projects are new open-source projects, but that isn’t a requirement - ex ### Project Preparation Checklist -- Prepare draft mission and scope statement. -- Identify internal teams within the mission and scope. -- Identify developers internally -- Analyze code for identification of licenses, license quality, and project dependencies -- Assess the potential universe of project participants. Identify ecosystem constituents and concerns of each. -- Identify any trademarks leveraged by the project (these will be owned by the LF neutrally) -- Outline infrastructure, marketing any other requirements needed for the project. +- Prepare draft mission and scope statement. +- Identify internal teams within the mission and scope. +- Identify developers internally +- Analyze code for identification of licenses, license quality, and project dependencies +- Assess the potential universe of project participants. Identify ecosystem constituents and concerns of each. +- Identify any trademarks leveraged by the project (these will be owned by the LF neutrally) +- Outline infrastructure, marketing any other requirements needed for the project. - Complete the [project proposal](/process/proposal_template) and submit it to the TAC for consideration The {{ site.foundation_name }} staff is happy to engage and advise during this process - let us know how we can help! @@ -133,9 +133,9 @@ Proposed projects will have a 20-minute presentation timeslot at an upcoming TAC * If a project is new, it’s often helpful to share the vision for the project, the anticipated structure, and benefits. * If the project is an existing open-source project proposed to join ASWF, it is often helpful to schedule a project walkthrough for the community to understand better the project, including the architecture, structure, and how to get started using the project. This often helps review progress more efficiently. * How does this submission support the [{{ site.foundation_name }} Mission and Vision statements]( {{ site.mission_statement_url }})? -* Does the project have any users? +* Does the project have any users? * How do you plan to attract users if accepted? -* How many committers will you have upfront, and from which companies? +* How many committers will you have upfront, and from which companies? * How do you plan to attract committers and contributors if accepted? * Demo and/or walk-through of the project diff --git a/process/tsc_faq.md b/process/tsc_faq.md index 650d501d..2d2ee981 100644 --- a/process/tsc_faq.md +++ b/process/tsc_faq.md @@ -20,7 +20,7 @@ The Technical Steering Committee (TSC) is the leadership of the project. This co Typically, the TSC comprises the primary committers or maintainers in a project. To start, there may be an appointed list, but over time, more individuals may join the TSC according to the policies the TSC set for adding new members. Regardless, TSC meetings are generally open to anyone interested unless there are sensitive issues to discuss, necessitating a private meeting. -[LFX Project Control Center] is a tool for managing project committees and roles within a project. Each project will be set up in that tool with a voting committee named 'Technical Steering Committee (TSC)' notating the project chairperson and all voting members. Project chairpersons, in addition to the Linux Foundation staff supporting the project, will have access to manage this. +[LFX Project Control Center] is a tool for managing project committees and roles within a project. Each project will be set up in that tool with a voting committee named 'Technical Steering Committee (TSC)' notating the project chairperson and all voting members. Project chairpersons, in addition to the Linux Foundation staff supporting the project, will have access to manage this. Additionally, each project has a [GitHub Team][GitHub Teams Docs] set up which will provide ['Maintain' permission]((https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role)) for each project maintainer. Generally, the LF staff will have this set up for each project; after that, the project is expected to maintain any changes. @@ -98,11 +98,11 @@ The TSC Chairperson should share an agenda at least 24 hours before the meeting ### Q: Is a TSC member required to have their employer be a member of the {{ site.foundation_name }}? -A: No - All technical community work, such as projects and working groups, is open to anyone to participate and not bound by membership in the {{ site.foundation_name }}. +A: No - All technical community work, such as projects and working groups, is open to anyone to participate and not bound by membership in the {{ site.foundation_name }}. ### Q: Does a person lose their membership in a TSC if they leave or change employers? -A: No - TSC membership is bound to an individual, not an organization. If a change of employment for a TSC member results in a key contributing organization lacking TSC representation, the TSC may invite a new TSC member affiliated with that organization, provided that person meets any requirements for TSC membership. +A: No - TSC membership is bound to an individual, not an organization. If a change of employment for a TSC member results in a key contributing organization lacking TSC representation, the TSC may invite a new TSC member affiliated with that organization, provided that person meets any requirements for TSC membership. ### Q: Does an individual serving on the TSC represent themselves, the project, and/or their employer? @@ -134,6 +134,6 @@ Just like TSC Meetings, subgroup meetings must be open to anyone interested in p [Technical Leads Mailing List]: https://lists.aswf.io/g/technical-project-leads [LFX Project Control Center]: https://projectadmin.lfx.linuxfoundation.org/ [Service Desk]: https://servicedesk.aswf.io -[LFX PCC Meeting Management Docs]: https://docs.linuxfoundation.org/lfx/project-control-center-pre-release/it-services-for-a-project/meetings -[LFX PCC Committee Management Docs]: https://docs.linuxfoundation.org/lfx/project-control-center-pre-release/setup-services-for-a-project/committees-setup-for-a-project +[LFX PCC Meeting Management Docs]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings +[LFX PCC Committee Management Docs]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/committees [GitHub Teams Docs]: https://docs.github.com/en/organizations/organizing-members-into-teams/about-teams diff --git a/projects_with_bestpractices.md b/projects_with_bestpractices.md index 682a5c47..dc8edf58 100644 --- a/projects_with_bestpractices.md +++ b/projects_with_bestpractices.md @@ -10,9 +10,9 @@ layout: minimal {%- if project['Level'] == 'active' -%}
- 
diff --git a/resources.md b/resources.md
index f8cedc3b..71eeae01 100644
--- a/resources.md
+++ b/resources.md
@@ -7,7 +7,7 @@ nav_order: 60
If you are new to open source, or have some experience in open source and looking to grow your knowledge, the following resources are recommended to help grow your open source skills.
- LF Training Courses ( free to audit )
- - Open Source Best Practices
+ - Open Source Best Practices
- [A Beginner’s Guide to Open Source Software Development (LFD102)](https://training.linuxfoundation.org/training/beginners-guide-open-source-software-development/)
- [Inclusive Open Source Community Orientation (LFC102)](https://training.linuxfoundation.org/training/inclusive-open-source-community-orientation-lfc102/)
- [Inclusive Strategies for Open Source (LFC103)](https://training.linuxfoundation.org/training/inclusive-strategies-for-open-source-lfc103/)
@@ -20,13 +20,15 @@ If you are new to open source, or have some experience in open source and lookin
- [Secure Software Development: Implementation (LFD105x)](https://training.linuxfoundation.org/training/secure-software-development-implementation-lfd105/)
- [Developing Secure Software (LFD121)](https://training.linuxfoundation.org/training/developing-secure-software-lfd121/)
- [Understanding the OWASP® Top 10 Security Threats (SKF100)](https://training.linuxfoundation.org/training/owasp-top-ten-security-threats-skf100/)
+ - [OpenSSF Guide to implementing a coordinated vulnerability disclosure process for open source projects
+](https://github.com/ossf/oss-vulnerability-guide/blob/main/maintainer-guide.md)
- Documentation
- [Open Source Technical Documentation Essentials (LFC111)](https://training.linuxfoundation.org/training/open-source-technical-documentation-essentials-lfc111/)
- [Creating Effective Documentation for Developers (LFC112)](https://training.linuxfoundation.org/training/creating-effective-documentation-for-developers-lfc112/)
- Standards Development
- [GitHub for Open Standards Development (LFD140)](https://training.linuxfoundation.org/training/github-for-open-standards-development-lfd140/)
- [Leading High-Performance Working Group Meetings (LFC120)](https://training.linuxfoundation.org/training/leading-high-performance-working-group-meetings-lfc120/)
-- [GitHub for Developers](https://githubtraining.github.io/training-manual/#/01_getting_ready_for_class)
+- [GitHub for Developers](https://githubtraining.github.io/training-manual)
- [Open Source Guides from GitHub](https://opensource.guide/)
- [Open Source License Best Practices - Quick Reference Guide](https://www.linuxfoundation.org/licensebestpractices)
diff --git a/tools/collaboration.md b/tools/collaboration.md
index 4961c52d..18217c54 100644
--- a/tools/collaboration.md
+++ b/tools/collaboration.md
@@ -9,9 +9,9 @@ parent: Tools
This document outlines the communications tools available for {{ site.foundation_name }} hosted projects and working groups.
-{{ site.foundation_name }} leverages the tools provided by the LFX Project Control Center (PCC) to maintain committee member lists, schedule meetings, configure mailing lists, and make community meetings publicly available.
+{{ site.foundation_name }} leverages the tools provided by the LFX Project Control Center (PCC) to maintain committee member lists, schedule meetings, configure mailing lists, and make community meetings publicly available.
-PCC is a tool built and maintained by the Linux Foundation for use by the {{ site.foundation_name }} and its hosted projects and working groups. Access to PCC for hosted projects and working groups, including management of meetings and committees, can be granted by submitting a support request [here][pcc access request instructions]. It is recommended that, at a minimum, the TSC Chairperson have access to PCC; it may also be beneficial to have a second person with access in case the TSC Chairperson is unavailable and the project needs to reschedule a meeting.
+PCC is a tool built and maintained by the Linux Foundation for use by the {{ site.foundation_name }} and its hosted projects and working groups. Access to PCC for hosted projects and working groups, including management of meetings and committees, can be granted by submitting a support request [here][pcc access request instructions]. It is recommended that, at a minimum, the TSC Chairperson have access to PCC; it may also be beneficial to have a second person with access in case the TSC Chairperson is unavailable and the project needs to reschedule a meeting.
The specific abilities the person with access to PCC has for managing project settings include:
@@ -93,7 +93,7 @@ If the meeting is not set to be recorded, you can enable recording on the fly by
Each hosted project and working group has a Public Calendar that can be directly pointed to or embedded in an existing web page. Instructions for getting the link for the hosted project or working group Public Calendar can be found [here][access to public calendar link instructions]. Note that the LF Staff sets up a subdomain forward if the project has a primary domain setup using the format `https://calendar.DOMAINNAME`.
-All public meetings for hosted projects and working groups are posted on the [Community Calendar].
+All public meetings for hosted projects and working groups are posted on the [Community Calendar].
Meetings that an individual is directly invited to can be found in the 'Meetings' section of that individual's LFX Individual Dashboard; instructions can be found [here][individual dashboard meetings instructions]
@@ -106,14 +106,14 @@ To help individuals not be inundated with calendar overload, try to follow these
- Ensure the meeting description includes an agenda or a link to the agenda.
[Community Calendar]: {{ site.calendar_url }}
-[cancel meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings#delete-meetings
+[cancel meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings/delete-meetings
[access to public calendar link instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings
[individual dashboard meetings instructions]: https://docs.linuxfoundation.org/lfx/my-profile/meetings
-[create meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings#scheduling-a-meeting
-[change meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings#manage-meetings
+[create meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings/scheduling-a-meeting
+[change meeting instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings/manage-meetings
[pcc access request instructions]: https://jira.linuxfoundation.org/plugins/servlet/desk/portal/4/create/358
-[add individuals to committee instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/committees#adding-members-to-a-committee
-[remove individuals from committee instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/committees#deleting-a-member-from-a-committee
+[add individuals to committee instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/committees/adding-members-to-a-committee
+[remove individuals from committee instructions]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/committees/deleting-a-member-from-a-committee
[email meeting participants PCC]: https://docs.linuxfoundation.org/lfx/project-control-center/v2-latest-version/collaborations/meetings
[zoom meeting recording instructions]: https://support.zoom.com/hc/en/article?id=zm_kb&sysparm_article=KB0059856
[find host key]: https://docs.linuxfoundation.org/lfx/my-profile/meetings/find-your-host-key
diff --git a/tools/github.md b/tools/github.md
index c57f0ee9..697d9b88 100644
--- a/tools/github.md
+++ b/tools/github.md
@@ -7,7 +7,7 @@ parent: Tools
* TOC
{:toc}
-{{ site.foundation_name }} projects generally use GitHub for code hosting and issue management. GitHub organizations for hosted projects are owned and administered by the Linux Foundation staff, including the Linux Foundation release engineering team, to ensure the sustainability of the infrastructure.
+{{ site.foundation_name }} projects generally use GitHub for code hosting and issue management. GitHub organizations for hosted projects are owned and administered by the Linux Foundation staff, including the Linux Foundation release engineering team, to ensure the sustainability of the infrastructure.
This document outlines project policies and procedures using GitHub for code hosting. In addition, the Linux Foundation release engineering team maintains [documentation](https://docs.releng.linuxfoundation.org/en/latest/) on its services, policies, and procedures.
@@ -20,8 +20,8 @@ When a new project or repository is to be added, please [submit a request](https
If adding the new project or repository will include a significant contribution, requesting a code license scan is highly recommended before bringing the code in. This scan will look for and will provide recommendations (or, in some cases, required prior remediation) for:
- The presence of third-party licenses (OSI-approved or otherwise) that might be considered incompatible with the project's license
-- Presence of headers with the project's designated license(s) and preferred copyright notices in project files (refer to the [License Specification in the Contribution Guidelines](/process/contribution_guidelines.md#license-specification) for more information)
-- Any other best practices guidance
+- Presence of headers with the project's designated license(s) and preferred copyright notices in project files (refer to the [License Specification in the Contribution Guidelines]({% link process/contribution_guidelines.md %}#license-specification) for more information)
+- Any other best practices guidance
Projects can [submit a request]({{ site.helpdesk_url }}) to facilitate the process. Typically code license scans are a quick turnaround, but that might take longer for more significant code bases.
@@ -37,11 +37,11 @@ If a project anticipates having multiple repositories, the {{ site.foundation_na
There are two strategies for migrating the code to a hosted project repository.
-- The best practice is for the {{ site.foundation_name }} staff to provision a new repository, where the new code can be contributed to as a pull request.
-- If preserving the commit history is important, the repository can be transferred using the [GitHub transfer repository](https://docs.github.com/en/github/administering-a-repositoriesitory/transferring-a-repositoriesitory) process. If doing this, before the transfer, you must add a commit to the repositories providing a DCO signoff for all previous commits. The easiest way is to check in a file called `past-dco-signoff.txt` with the contents below...
+- The best practice is for the {{ site.foundation_name }} staff to provision a new repository, where the new code can be contributed to as a pull request.
+- If preserving the commit history is important, the repository can be transferred using the [GitHub transfer repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/transferring-a-repository) process. If doing this, before the transfer, you must add a commit to the repositories providing a DCO signoff for all previous commits. The easiest way is to check in a file called `past-dco-signoff.txt` with the contents below...
```
-I, Contributed By
{{ project['Contributed By'] }}
Chairperson(s)
{{ project['Chair'] }}