Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Propose creation of project community resources #42

Closed
wants to merge 4 commits into from
Closed
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 58 additions & 0 deletions text/0000-landing-page.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Meta
[meta]: #meta
- Name: Create a community landing page
- Start Date: 1-6-2020
- CNB Pull Request: (leave blank)
- CNB Issue: (leave blank)
- Supersedes: (put "N/A" unless this replaces an existing RFC, then link to that RFC)

# Summary
[summary]: #summary

Prospective contributors to the project don't have a central place to go for information. This RFC proposes the creation of a community or "landing page" repo at `buildpacks/community` with high level information about the project including key personnel, governance, guidelines for contributions, meeting schedules, etc.

# Outcomes
[outcomes]: #outcomes

- New contributors feel welcomed.
- A new contributor can easily find information they want about the project, can join the slack and WG meetings, and can quickly contribute pull-requests, RFCs, and issues.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's been pointed out before that publicly publishing the zoom WG meeting details could be problematic as we currently have no way of moderating anybody with the link participating.


# Motivation
[motivation]: #motivation

A major part of the success of the CNB project will necessitate growing contributors beyond the current core. As new people learn about the project and want to contribute, we need a friendly central landing place where all the information _about_ the project is housed.

# What it is
[what-it-is]: #what-it-is

This RFC proposes the creation of a project landing page that will be house at `buildpacks/community`.
It will have a central `README.md` that included the following information and links to documents that provide more details if and when that's necessary:

- Purpose of the project and high level overview including some canonical talk from YouTube, etc
- Technical overview, including guides to the various components of the projects and links to their respective repositories
- Project and community overview, including key personnel, governance structures (links to `GOVERNANCE.md`), link to slack, calendar links, and links to a contribution guide (this document is likely sufficiently detailed as to necessitate a separate document below)
zmackie marked this conversation as resolved.
Show resolved Hide resolved
- `CONTRIBUTING.md` which details the RFC process and various other pieces of information about how to get started contributing to the project
zmackie marked this conversation as resolved.
Show resolved Hide resolved
- Ecosystem overview with links to various platforms, builders, adoptions, etc. to give a sense of the scope of the community beyond the immediate CNB project
zmackie marked this conversation as resolved.
Show resolved Hide resolved
- `GOVERNANCE.md` which thoroughly lays out how the project runs from a governance standpoint


Any current information from /~https://github.com/buildpacks/resources will get ported over and that repo will be retired.

# Alternatives
[alternatives]: #alternatives

- Keep doing what we're doing
zmackie marked this conversation as resolved.
Show resolved Hide resolved
zmackie marked this conversation as resolved.
Show resolved Hide resolved
- Add a "contributing" section to `buildpacks.io`

# Prior Art
[prior-art]: #prior-art

- /~https://github.com/ipfs/ipfs (landing page for IPFS project)
zmackie marked this conversation as resolved.
Show resolved Hide resolved
- /~https://github.com/desktop/desktop (central repo for github desktop but has community information on there)


# Unresolved Questions
[unresolved-questions]: #unresolved-questions

- Should this include some sort of roadmap? This would ideally give people a sense of where they can start to chip in
- Should we host our WG meetings out of the CNCF calendar so they're more publicly discoverable? Who moderates the Zoom?