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.

Sign up for GitHub

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

Propose creation of project community resources #42

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
09af80b
Proposes the creation of a project landing page
Jan 6, 2020
a50408b
Address comments
Jan 10, 2020
a521e1f
Spelling
Jan 10, 2020
5f3e462
Clarifies how to differentiate this landing page vs buildpacks.io. Ad…
Jan 15, 2020
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
53 changes: 53 additions & 0 deletions text/0000-landing-page.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# 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

People interested in 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/buildpacks` with high level information about the project including key personel, governance, guidelines for contributions, meeting schedules, etc.
zmackie marked this conversation as resolved.
Show resolved Hide resolved

**Outcomes**
zmackie marked this conversation as resolved.
Show resolved Hide resolved
[outcomes]: #outcomes

- New contributors feel welcomed.
- A new contributor or user of the project can easily find what they want, join the slack, WG meetings, and immediately contribute pull-requests, RFCs, and issues.

# 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 use it or 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/buildpacks`.
zmackie marked this conversation as resolved.
Show resolved Hide resolved
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 repos
- Project and community overview, including key personel, governance structures, link to slack, calendar links, and links to a contribution guide (this document is likely sufficiently detailed as to necessitate a seperate document beloew)
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
Copy link
Contributor Author

@zmackie zmackie Jan 6, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

It might be useful to include an section on "When should I open an RFC?", with examples or heuristics as well as the default disposition (ie start with an issue or a PR and that can be upgraded to an RFC if deemed necessary or vice-versa). I realize that the RFC RFC sort of touches on this but it seems a little vaguely specficied at the moment
Something like:

**RFC**
- Add new field to `buildpack.toml`
- Create new repo in the project

**No RFC**
- Bug in pack
- Modify language in logging headers

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

# 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

# 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 publicall discoverable? Who moderates the zoom?
Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, and someone nominated by Core team. It should be the responsibility of a single person (for consistency and commitment) with occasional substitution as needs arrive. It should also not be forever, but something that can be passed on after some period of time.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Agree with this.

zmackie marked this conversation as resolved.
Show resolved Hide resolved