Revise website community content to be more beginner-friendly (#5348)

* Clean up contribution docs

* Move 'contributing' to 'community' to encourage lurkers as well as active participants. Also, increase content on 'community' landing page

* Update additional redirect

* Fix trailing newline and accidental backup file inclusion

* Address @psschwei feedback

* Fix typo in link

* fix typo

Co-authored-by: Paul Schweigert <paul@paulschweigert.com>

* Construct a grammatical sentence

Co-authored-by: Paul Schweigert <paul@paulschweigert.com>

* Address @psschwei feedback, thanks\!

Co-authored-by: Ashleigh Brennan <abrennan@redhat.com>
Co-authored-by: Paul Schweigert <paul@paulschweigert.com>
This commit is contained in:
Evan Anderson 2023-01-25 15:16:41 -08:00 committed by GitHub
parent fb4e05a482
commit af5f5fb75c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 159 additions and 83 deletions

View File

@ -21,7 +21,7 @@ If your changes should also be in the most recent release, use [/cherrypick](htt
for example, "/cherrypick release-1.2" for Prow to generate a PR for the `release-1.2` branch.
For all resources for contributing to the Knative documentation, see the
[Knative contributor's guide](help/contributing/README.md).
[Knative contributor's guide](contribute-to-docs/README.md).
-->

View File

@ -101,9 +101,9 @@ title = "Knative"
<div class="mb-4 h1">
<i class="fab fa-github"></i>
</div>
<h4>Contributions welcome</h4>
<p><a href="./contributing/">
<button type="button" class="btn btn-secondary" style="width:150px; margin-top: 12px;">Contribute</button>
<h4>Join the Community</h4>
<p><a href="./community/">
<button type="button" class="btn btn-secondary" style="width:150px; margin-top: 12px;">Community</button>
</a>
</p>
<p>Want to join the fun on Github? New users are always welcome!</p>

View File

@ -293,10 +293,10 @@ nav:
- Reference:
- Security: reference/security/README.md
- Release notes: reference/relnotes/README.md
- Contributing:
- Welcome to the Knative community: contributing/README.md
- Contribute to Knative: contributing/contributing.md
- About the community: contributing/about.md
- Community:
- How To Get Involved: community/README.md
- Contribute to Knative: community/contributing.md
- Community Rules and Practices: community/governance.md
- About:
- Testimonials: about/testimonials.md
- Case studies:

View File

@ -1,6 +1,7 @@
plugins:
redirects:
redirect_maps:
contributing/about.md: contributing/README.md
eventing/broker/kafka-broker/kafka-configmap.md: eventing/configuration/kafka-channel-configuration.md
eventing/broker/create-mtbroker.md: eventing/brokers/create-mtbroker.md
eventing/broker/example-mtbroker.md: eventing/brokers/broker-developer-config-options.md
@ -14,9 +15,10 @@ plugins:
reference/client/README.md: client/README.md
reference/api/eventing-api.md: eventing/reference/eventing-api.md
reference/api/serving-api.md: serving/reference/serving-api.md
community/contributing.md: contributing/contributing.md
community/about.md: contributing/about.md
community/README.md: contributing/README.md
community/about.md: community/governance.md
contributing/contributing.md: community/contributing.md
contributing/about.md: community/governance.md
contributing/README.md: community/README.md
eventing/getting-started.md: getting-started/getting-started-eventing.md
admin/collecting-logs/README.md: serving/observability/logging/collecting-logs.md
admin/collecting-metrics/README.md: serving/observability/metrics/collecting-metrics.md
@ -72,7 +74,7 @@ plugins:
community/contributing/trademark-committee.md: https://github.com/knative/community/blob/main/TRADEMARK-COMMITTEE.md
community/contributing/values.md: https://github.com/knative/community/blob/main/VALUES.md
community/contributing/working-groups/working-groups.md: https://github.com/knative/community/blob/main/working-groups
community/meetup.md: contributing/contributing.md
community/meetup.md: community/README.md
community/samples.md: https://github.com/knative/docs/tree/main/code-samples/community
concepts/overview.md: index.md
developer/concepts/duck-typing.md: concepts/duck-typing.md

132
docs/community/README.md Normal file
View File

@ -0,0 +1,132 @@
# How to Get Involved
<!-- TODO: what is community, what are the touchpoints -->
The Knative community consists of three different audiences:
![Diagram of Knative audiences: users, developers, operators, and contributors](images/knative-audience.svg)
* **Developers** write serverless and event-driven applications using the
constructs surfaced by Knative. They build containers and applications which
leverage the concepts exposed by Knative to deliver services to end users and
systems.
* **Operators** build and maintain Kubernetes platforms where Knative is
installed. They also manage the default settings for Knative on those
clusters.
* [**Contributors**](./contributing.md) are the authors of the Knative
components; they contribute and review source code, run the community
meetings, document and publicize the project, and otherwise keep the project
running.
Knative components are intended to operate well stand-alone, or integrated into
a larger platform offering by either an internal systems team or a cloud
provider. You can see a [list of organizations that have adopted Knative in our
community repo](https://github.com/knative/community/tree/main/ADOPTERS.MD).
## Questions
For the fastest response, you can ask questions on the [`#general`, `#serving`,
`#eventing`, or `#functions` channels of the Knative
Slack](https://slack.knative.dev/).
We also have a [Stack Overflow topic,
`knative`](https://stackoverflow.com/questions/tagged/knative) (as well as
`knative-serving`, `knative-eventing`, and `knative-functions`), and the
[knative-users](https://groups.google.com/forum/#!forum/knative-users) mailing
list if you prefer those formats.
## Bug Reports and Feature Requests
Knative is composed of many different components. We use GitHub Issues to track
bug reports and feature requests. While it's most helpful if you know the
specific component that the bug is happening in, we understand that it can be
difficult to tell sometimes. A clear bug report in the wrong component is much
better than a partial report in the right component, so feel free to file your issue in one of these three main repositories if you're not sure:
* [Serving](https://github.com/knative/serving/issues/new?template=bug-report.md)
* [Eventing](https://github.com/knative/eventing/issues/new?template=bug.md)
* [Functions](https://github.com/knative/func/issues/new)
A good bug report should include:
- What you were trying to do, and what happened
- What version of Knative and Kubernetes you are using (if using a cloud provider, indicate which one)
- Relevant resource yaml, HTTP requests, or log lines
## Community Meetups
This virtual event is designed for end users, a space for our community to meet,
get to know each other, and learn about uses and applications of Knative.
Catch up with past community meetups on our [YouTube channel](https://www.youtube.com/playlist?list=PLQjzPfIiEQLLyCyLBKLlwDLfE_A-P7nyg).
Stay tuned for new events by subscribing to the
[calendar](https://calendar.google.com/calendar/embed?src=knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com&ctz=America%2FLos_Angeles) ([iCal export file](https://calendar.google.com/calendar/ical/knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com/public/basic.ics))
and following us on [Twitter](https://twitter.com/KnativeProject).
## Communication Channels
Much of the community meets on [the Knative Slack](https://slack.knative.dev/).
We also have user
([`knative-users@googlegroups.com`](https://groups.google.com/forum/#!forum/knative-users))
and developer
([`knative-dev@googlegroups.com`](https://groups.google.com/forum/#!forum/knative-dev))
mailing lists for discussions, and for access to documents in the shared Google
Drive. Access to `knative-users@` is automatically approved; access to
`knative-dev@` is handled via a lightweight approval process -- it helps if you
provide a one-sentence description when requesting access.
We also use GitHub Issues and [GitHub
projects](https://github.com/orgs/knative/projects) for tracking longer-term
efforts, including each working group's roadmap, and the backlog for oversight
committees like the Technical Oversight Committee and the Steering Committee.
Feature design is generally done via Google Docs stored in a [shared Google
Drive](https://drive.google.com/drive/folders/0AM-QGZJ-HUA8Uk9PVA). Due to
limitations of shared drives, the default access control is that all documents
are *readable* by `knative-users@` and *commentable* and *editable* by
`knative-dev@`. Documents generally cannot be deleted without special
intervention.
## Meetings
Knative schedules all meetings on a [shared Google
calendar](https://calendar.google.com/calendar/embed?src=knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com). Working
group leads and TOC/Steering members should have permissions to add events,
including one-off events for coordination if needed.
<iframe src="https://calendar.google.com/calendar/embed?src=knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com" style="border: 0" width="800" height="600" frameborder="0" scrolling="no"></iframe>
If you're using Google Calendar, the above should work. If you're using some
other system (Apple Calendar or Outlook, for example), [here is an iCal export
of the community
calendar](https://calendar.google.com/calendar/ical/knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com/public/basic.ics).
- [Follow these directions to import into Outlook Web](https://support.office.com/en-us/article/import-or-subscribe-to-a-calendar-in-outlook-on-the-web-503ffaf6-7b86-44fe-8dd6-8099d95f38df)
- [Follow these directions for desktop Outlook](https://support.office.com/en-us/article/See-your-Google-Calendar-in-Outlook-C1DAB514-0AD4-4811-824A-7D02C5E77126)
- [Follow the import directions to import into Apple Calendar](https://support.apple.com/guide/calendar/import-or-export-calendars-icl1023/mac)
## Getting More Involved as a Contributor
If you're interested in becoming a Knative contributor, you'll want to check out
our [contributor page](./contributing.md). **Contributing is not an
expectation** -- everyone who uses Knative, talks about it, lurks on a mailing
list, or engages with the ideas is part of our community! If you _do_ want to
get more deeply involved, you'll find that contributing to open source can be a
great career booster as well as
## Governance
Knative is part of the CNCF, and is governed by those rules, including the CNCF
Code of Conduct. Beyond that, we have a [page about our governance
rules](./governance.md).
## Code of Conduct
Knative follows the [CNCF Code of
Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
Reports of code of conduct violations may be sent to
code-of-conduct@knative.team or conduct@cncf.io.

View File

@ -7,13 +7,13 @@ Here are a few ways to get involved.
If you want to contribute to Knative, you must do the following:
- Before you can make a contribution, you must sign the CNCF [EasyCLA](https://easycla.lfx.linuxfoundation.org/) using the same email address you used to register for Github. For more information, see [Contributor license agreements](https://github.com/knative/community/blob/main/CONTRIBUTING.md#contributor-license-agreements).
- Before you can make a contribution, you must sign the CNCF [EasyCLA](https://easycla.lfx.linuxfoundation.org/) using the same email address you use for `git commit`s. For more information, see [Contributor license agreements](https://github.com/knative/community/blob/main/CONTRIBUTING.md#contributor-license-agreements).
- Read the [Knative contributor guide](https://github.com/knative/community/blob/main/CONTRIBUTING.md).
- Read the [Code of conduct](https://github.com/knative/community/blob/main/CODE-OF-CONDUCT.md).
For more information about how the Knative community is run, see [About the Knative community](about.md).
For more information about how the Knative community is run, see [About the Knative community](governance.md).
## Contribute to the code
@ -65,7 +65,6 @@ Share your samples with the community.
- [Link existing code samples](../samples/README.md#external-code-samples):
Link to your Knative samples that live on another site.
## Learn and connect
Using or want to use Knative? Have any questions? Find out more here:
@ -85,20 +84,14 @@ or Eventing and chat with other project developers. See also the [Knative Slack
- [Stack Overflow questions](https://stackoverflow.com/questions/tagged/*knative*):
Knative tagged questions and curated answers.
## Community Meetup
### Community Meetups
This virtual event is designed for end users, a space for our community to meet,
get to know each other, and learn about uses and applications of Knative.
New to Knative or built something cool? Share your impressions by
presenting at the Knative Community Meetup! [Use this form to sign
up to present.](https://docs.google.com/forms/d/1EQ2Ckxva5S9bM8ePARmgnsV6fneQFSE7DnrqdBS0mXI/viewform)
Catch up with past community meetups on our [YouTube channel](https://www.youtube.com/playlist?list=PLQjzPfIiEQLLyCyLBKLlwDLfE_A-P7nyg).
Stay tuned for new events by subscribing to the
[calendar](https://calendar.google.com/calendar/embed?src=knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com&ctz=America%2FLos_Angeles) ([iCal export file](https://calendar.google.com/calendar/ical/knative.team_9q83bg07qs5b9rrslp5jor4l6s%40group.calendar.google.com/public/basic.ics))
and following us on [Twitter](https://twitter.com/KnativeProject).
## More ways to get involved
Even if theres not an issue opened for it, we can always use more testing throughout the platform. Similarly, we can always use more docs, richer docs, insightful docs. Or maybe a cool blog post? And if youre a web developer, we could use your help in spiffing up our public-facing web site.
[Bug reports](https://github.com/knative/serving/issues/new) and friction logs
from new developers are especially welcome.

View File

@ -1,8 +1,10 @@
# About the community
# Community Rules and Practices
This page provides links to documents for common Knative community practices and
a description of Knative's audience.
While the project was started by Google, it has received contributions from [over 200 companies](https://knative.devstats.cncf.io/d/21/prs-authors-companies-table) and is now governed by the [CNCF](https://cncf.io/).
## Community values
This section links to documents about our values.
@ -17,9 +19,9 @@ the goals and values we hold as a team.
This section links to documents about how the Knative community is governed.
Knative has public and recorded monthly community meetings.
Each project has one or more working groups driving the project, and Knative has
a single technical oversight committee monitoring the overall project.
Knative has public and recorded monthly community meetings. Each component has
one or more working groups driving the effort, and Knative has a single
technical oversight committee monitoring the overall project.
- [Governance](https://github.com/knative/community/blob/main/GOVERNANCE.md):
the Knative governance framework.

View File

Before

Width:  |  Height:  |  Size: 64 KiB

After

Width:  |  Height:  |  Size: 64 KiB

View File

Before

Width:  |  Height:  |  Size: 19 KiB

After

Width:  |  Height:  |  Size: 19 KiB

View File

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 50 KiB

View File

Before

Width:  |  Height:  |  Size: 720 KiB

After

Width:  |  Height:  |  Size: 720 KiB

View File

Before

Width:  |  Height:  |  Size: 14 KiB

After

Width:  |  Height:  |  Size: 14 KiB

View File

Before

Width:  |  Height:  |  Size: 166 KiB

After

Width:  |  Height:  |  Size: 166 KiB

View File

Before

Width:  |  Height:  |  Size: 15 KiB

After

Width:  |  Height:  |  Size: 15 KiB

View File

@ -1,9 +0,0 @@
# Welcome to the Knative community
Knative is an open source project that anyone in the community can use, improve, and enjoy.
We'd love you to join us!
In this section:
- [Contribute to Knative](contributing.md): helpful tips for how to get started contributing to Knative.
- [About the Knative community](about.md): information about the Knative community and how it's run.

View File

@ -262,51 +262,7 @@
</a>
</div>
<div class="col">
<a href="{{ 'about/case-studies/puppet/' | url }}">
<div class="logo">
<img class="puppet" src="images/case-studies/puppet.png" alt="" draggable="false" />
</div>
<hr>
<p class="normal-text">
"I'm a strong believer in
working with open-source
vendors. We've made
contributions to numerous
projects, including Tekton,
Knative, Ambassador, and
gVisor --All of which we depend
on to make our product
functional."<br><br>
—Noah Fontes,<br>
Senior Principal Software Engineer for<br>Puppet
</p>
</a>
</div>
</div>
</div>
</section>
<section class="cncf-notice-container">
<h3>Knative is a <a href="https://www.cncf.io/">Cloud Native Computing Foundation</a> incubation project</h3>
<img class="cncf-logo" src="images/home-images/cncf-color.png" alt="" draggable="false" />
</section>
<section class="whats-next-container">
<div class="md-grid md-typeset">
<h1>What's Next?</h1>
<div class="component-flex">
<div class="pane">
<a href="https://slack.knative.dev" title="Slack Link">
<div class="twemoji">
{% include ".icons/fontawesome/brands/slack.svg" %}
</div>
<h2>Talk to us on Slack</h2>
<p class="normal-text">Interested in learning more, speaking to other contributors, or finding answers?</p>
</a>
</div>
<div class="pane">
<a href="./community/contributing/" title="Contributing Link">
<a href="{{ 'community/contributing' | url }}" title="Contributing Link">
<div class="twemoji">
{% include ".icons/fontawesome/brands/github.svg" %}
</div>