Skip to content

Commit 638ac33

Browse files
Rebasing to new baseline OSS policies (#376)
* repo restructuring * changes based upon first round of feedback * Updating reference from Chef Software Inc (as owner) to Progress Software Corporation. * Minor grammatical updates; linking to Apache 2.0 official license page; changing reference from "project owners" to advisors. * Cleanup; clarifications pf physical and digital spaces; updating some terms with respect to Decider and Community Organizers. * typos * General cleanup. * Attempting to fix formatting with the bullet list for Outside Contributors status * Minor cleanup * formatting * Might have been a header tag problem... nothing below Alums appears in the page's TOC. Fixing. * Cleanup and formatting * Adding a paragraph to explain that OSS licenses, in general, do NOT convey any rights over trademarks or logo marks. * Adding a section stating that the trademark guidelines apply regardless of whether the downstream distriution is commercialized or offered for free use. * Cleanup and formatting * Minor formatting typo * Cleanup and cross-links * Fix formatting inconsistencies * Putting "real" placeholder on the page. * Fleshing out community meetings and CAC; fixing headers to TOC consistency; other cleanup. * Adding date and time for CAC meetings. * Very minor cleanup * minor cleanup * Removed or updated the header to proper MKdocs format; removed the header from "ready" pages * open-core policy * changed phil to jaymzh --------- Co-authored-by: Jeff Strauss <[email protected]>
1 parent d967cc5 commit 638ac33

File tree

79 files changed

+2367
-2141
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

79 files changed

+2367
-2141
lines changed

.github/workflows/publish.yml

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
name: Publish docs via GitHub Pages
2+
on:
3+
push:
4+
branches:
5+
- draft
6+
# change to 'main' when ready to publish
7+
8+
jobs:
9+
build:
10+
name: Deploy docs
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout master
14+
uses: actions/checkout@v1
15+
16+
- name: Deploy docs
17+
uses: mhausenblas/mkdocs-deploy-gh-pages@master
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
20+
CONFIG_FILE: mkdocs.yml
21+
#EXTRA_PACKAGES: build-base
22+
# GITHUB_DOMAIN: github.myenterprise.com
23+
REQUIREMENTS: /requirements.txt

CONTRIBUTING.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

Makefile

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,20 @@
22

33
spellcheck:
44
cspell **/*.md *.md
5+
6+
install:
7+
python3 -m venv venv && \
8+
source ./venv/bin/activate && \
9+
pip3 install mkdocs && \
10+
pip3 install mkdocs-same-dir && \
11+
pip3 install mkdocs-techdocs-core && \
12+
pip3 install mkdocs-material && \
13+
pip3 install mkdocs-print-site-plugin
14+
15+
build:
16+
source ./venv/bin/activate && \
17+
mkdocs build
18+
19+
run:
20+
source ./venv/bin/activate && \
21+
mkdocs serve

README.md

Lines changed: 21 additions & 101 deletions
Original file line numberDiff line numberDiff line change
@@ -1,118 +1,38 @@
1-
> [!WARNING]
2-
> This page in the Chef Open Source Software Practices repository is currently undergoing content review.
1+
!!! warning
2+
This page in the Chef Open Source Software Practices repository is currently undergoing content review.
33

4-
- **[Project State](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md): Active**
5-
- **Issues [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md): 7 days**
6-
- **Pull Request [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md): 7 days**
74

8-
# Chef Software Open Source Communities
5+
# Progress Chef Communities
6+
Welcome to the Progress Chef Open Source community!
97

10-
Welcome to the Chef Software Open Source communities!
11-
12-
This is a starting point for contributing to all of Chef's software and a wonderful spot for information on how to join in on the fun.
13-
14-
Looking for something specific? Check out our [Table of Contents](#table-of-contents).
15-
16-
To learn more about each of our project's structure and organization, please refer to [Governance](./governance.md).
17-
18-
We are currently rolling out these processes to all of Chef's Open Source projects in stages and will be iterating as we go - we would love you to [contribute](./CONTRIBUTING.md)!
19-
20-
## Inspiration
21-
22-
The practices in this repo are inspired by [Adam Jacob's book on Free and Sustainable Open Source Communities](https://sfosc.org/). Although we are inspired by it, this repo is not a full implementation of the practices described in that book. However, this is only the first iteration of this repo. We expect this repo to continue to evolve and grow as we learn. We may integrate more of Adam's book into this repo in the future.
8+
This is your home for contributing to Progress Chef’s ecosystem. Whether you're improving a Chef Infra resource, improving documentation, crafting an InSpec control, extending Cookstyle, or building a new plugin — you’re in the right place.
239

2410
## How We're Organized
11+
Progress Software (the company) produces a range of Chef infrastructure automation products, such as **Chef Infra**, **Chef InSpec**, **Chef Habitat**, and the supporting ecosystem. These products are released and managed under Progress Chef’s **[Open Core](./policies/open-core.md)** model.
2512

26-
Chef Software (the company) produces many products such as Chef Infra, Chef InSpec, Chef Habitat, and Chef Automate. Each of these products is fully open source and comprised of one or more open source projects. For instance, the Chef Infra product is comprised of chef, ohai, various mixlib projects, and other interdependent libraries. The project and/or sub-project scope is defined in the README.md file in each individual project's GitHub repository.
13+
All Progress Chef Open Source projects are released and under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). These open source projects serve as the shared foundation for our global community, while advanced features and platform capabilities are part of the Chef 360 commercial offerings.
2714

28-
All Chef projects operate under governance determined by the Chef OSS Practices Committee. These policies are documented under [Governance](./governance.md); however, *Teams* can have their own [policy for contribution](./repo-management/project-required-setup.md#CONTRIBUTING.md), communication standards, etc. so long as those policies meet the base governance policy.
15+
Many of the Progress Chef products includes one or more open source [projects](./projects/README.md) — for example, the Chef Infra product is comprised of `chef`, `ohai`, various `mixlib` libraries, and other interdependent tools.
2916

30-
We decide on the long term plan for projects through [Project planning](./contributors/guide/project-planning.md) and our [triage and prioritization](./contributors/guide/#issues-management-or-triage.md) processes.
31-
32-
## Communicating With Us
17+
All open source projects operate under and are governed by the policies outlined in our [Governance](./policies/governance.md) document.
3318

34-
The [communication](./communication/README.md) page lists communications channels such as chat, GitHub issues, mailing lists, conferences, etc.
19+
We decide on long-term plans and direction through structured [Project Planning](./contributors/guide/project-planning.md) and our [Triage and Prioritization](./contributors/guide/README.md#issues-management-or-triage) processes.
3520

36-
For more detailed information, check the README.md in a project's repository.
21+
## Join Us in Building the Future
22+
Whether you're a long-time contributor or a first-time user, we invite you to help shape the future of infrastructure automation. We are only as strong as the community around it — and we’re committed to making Chef's ecosystem one that is worth building together.
3723

38-
## Getting Started Contributing
24+
### Getting Started Contributing
25+
1. Browse the [Projects List](./projects/README.md) to find something you care about.
26+
2. Read the relevant CONTRIBUTING guide for that project (see project for details).
27+
3. Learn how to [find something to work on](./contributors/guide/README.md#find-something-to-work-on).
28+
4. Learn how to [open a pull request](./contributors/guide/README.md#open-a-pull-request).
3929

40-
A first step towards contributing is to pick from the [list of Chef Software Projects](./projects-list.md).
41-
42-
Once you've selected a project to contribute to, be sure to read the team's [contribution guide](./CONTRIBUTING.md). That guide will provide information on issues in need of contributors, team meetings schedules, and Slack channels / mailing lists where project discussions take place.
43-
44-
The [Contributor Guide](./contributors/guide/README.md) provides detailed instructions on how to get your code accepted to Chef Software projects, including:
45-
46-
1. How to [file an issue](./contributors/guide/README.md#file-an-issue)
47-
2. How to [find something to work on](./contributors/guide/README.md#find-something-to-work-on)
48-
3. How to [open a pull request](./contributors/guide/README.md#open-a-pull-request)
49-
50-
## Creating a New Chef Open Source Project
51-
52-
Creating a new project? Check out the [repo management](./repo-management/README.md) documentation for information on how to set your project up.
30+
Visit the [Contributor Guide](./contributors/guide/README.md) for help filing issues, opening PRs, and more.
5331

5432
## Project Membership
5533

56-
We encourage all contributors to become project members. We aim to grow an active, healthy community of contributors, reviewers, and project owners. Learn about requirements and perks of membership in our [Project Membership](./project-membership.md) page.
57-
58-
## Table of Contents
59-
60-
- [README](./README.md)
61-
- [Contributing](./CONTRIBUTING.md)
62-
- [Project Membership](./project-membership.md)
63-
- [Projects List](./projects-list.md)
64-
- [Governance](./governance.md)
65-
- [Developer Certificate of Origin](./DCO.md)
34+
We encourage all contributors to become project members. We aim to grow an active, healthy community of contributors, reviewers, and advisors. Learn about the requirements and perks of membership on our [Project Membership](./policies/project-membership.md) page.
6635

67-
### Code of Conduct
68-
69-
- [Physical and Virtual Spaces Code of Conduct](./CODE_OF_CONDUCT.md)
70-
71-
### Contributors
72-
73-
- [Contributor Licenses through the Entitlement Program](./contributors/contributor-entitlement-program.md)
74-
75-
### Distributions
76-
77-
- [Distribution Guidelines](./distributions/distribution-guidelines.md)
78-
- [Distribution List](./distributions/distribution-list.md)
79-
80-
### Guide
81-
82-
- [README](./contributors/guide/README.md)
83-
- [Collaborative Development](./contributors/guide/collaborative-dev.md)
84-
- [Community Expectations](./contributors/guide/community-expectations.md)
85-
- [Contributor Cheatsheet](./contributors/guide/contributor-cheatsheet.md)
86-
- [Design Proposals](./contributors/guide/design-proposals.md)
87-
- [Help Wanted](./contributors/guide/help-wanted.md)
88-
- [Project Planning](./contributors/guide/project-planning.md)
89-
- [Pull Requests](./contributors/guide/pull-requests.md)
90-
- [Ways to Contribute](./contributors/guide/ways-to-contribute.md)
91-
92-
### Communication
93-
94-
- [README](./communication/README.md)
95-
- [Community Meetings](./communication/community-meetings.md)
96-
- [Decider](./communication/decider.md)
97-
- [Triage](./communication/triage.md)
98-
- [Project End of Life](./communication/project-eol.md)
99-
- [Video Conferencing](./communication/video-conferencing.md)
100-
- [Support Boundaries](./communication/support-boundaries.md)
101-
- [Saying No](./communication/saying-no.md)
102-
- [Communication FAQ](./communication/communication-faq.md)
103-
104-
### Repo Management
105-
106-
- [README](./repo-management/README.md)
107-
- [Project Setup](./repo-management/project-required-setup.md)
108-
- [Repo States](./repo-management/repo-states.md)
109-
- [GitHub Labels](./repo-management/github-labels.md)
110-
111-
### Guilds
112-
113-
- [README](./guilds/README.md)
114-
115-
### Checklists
36+
## Communicating With Us
11637

117-
- [Managing Pull Requests](./checklists/managing-pull-requests.md)
118-
- [New Projects](./checklists/new-project.md)
38+
The [communication](./communication/README.md) page lists communications channels such as chat, GitHub issues, mailing lists, conferences, etc.

checklists/managing-pull-requests.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
> [!WARNING]
2-
> This page in the Chef Open Source Software Practices repository is currently undergoing content review.
1+
!!! warning
2+
This page in the Chef Open Source Software Practices repository is currently undergoing content review.
33

44
# Managing Pull Requests
55

checklists/new-project.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,28 @@
1-
> [!WARNING]
2-
> This page in the Chef Open Source Software Practices repository is currently undergoing content review.
1+
!!! warning
2+
This page in the Chef Open Source Software Practices repository is currently undergoing content review.
33

44
# New Project Checklist
5-
65
* Repository configuration
76
* Description
87
* Github topics
98
* Repository labels
109
* Disable projects/wiki if unused
10+
1111
* Documentation
1212
* README
1313
* Local installation setup instructions
1414
* Development and Testing process
1515
* Design Documentation
1616
* Style guide
17+
1718
* Additional files
18-
* CODE_OF_CONDUCT.md
19+
* code-of-conduct.md
1920
* CONTRIBUTING.md
2021
* LICENSE
2122
* TEAMS.md
2223
* .github/CODEOWNERS
2324
* .github/ISSUE_TEMPLATE.md
2425
* .github/PULL_REQUEST_TEMPLATE.md
26+
2527
* Other tasks
2628
* Slack integration (`/github` command)

0 commit comments

Comments
 (0)