Skip to content

Commit

Permalink
Merge branch 'main' into svrnm-patch-4
Browse files Browse the repository at this point in the history
  • Loading branch information
trask authored Aug 14, 2024
2 parents 73cb3a8 + 60b0585 commit 1859742
Show file tree
Hide file tree
Showing 27 changed files with 968 additions and 634 deletions.
26 changes: 26 additions & 0 deletions .cspell.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ ignoreRegExpList:
words:
- Collibra
- DASD
- Docu
- datadog
- devex
- dynatrace
- easycla
- eiffel
Expand All @@ -28,6 +30,23 @@ words:
- gitter
- grafana
- Hostmetrics
- hostmetricsreceiver
- jemmic
- keptn
- kubecon
- liatrio
- lightstep
- logz
- maintainership
- observiq
- opentelemetry
- opentelemetrybot
- otel
- otep
- otlp
- passcodes
- proto
- pytest
- isovalent
- labs
- Liudmila
Expand Down Expand Up @@ -88,7 +107,14 @@ words:
- frzifus
- gbbr
- gitter
- gitdm
- henrikrexed
- heptio
- hongalex
- horovits
- jackjia
- jaglowski
- javaagent
- jemmic
- juraci
- kaiyan-sheng
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/membership.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ e.g. (at)example_user

### Requirements

- [ ] I have reviewed the community membership guidelines (https://github.com/open-telemetry/community/blob/main/community-membership.md)
- [ ] I have reviewed the community membership guidelines (https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md)
- [ ] I have enabled 2FA on my GitHub account. See https://github.com/settings/security
- [ ] I have subscribed to the [Slack channel](https://cloud-native.slack.com/archives/CJFCJHG4Q) (use https://slack.cncf.io/ to get an invite)
- [ ] I am actively contributing to 1 or more OpenTelemetry subprojects
Expand Down
4 changes: 4 additions & 0 deletions .github/repository-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@ settings](../docs/how-to-configure-new-repository.md#repository-settings).

* Required number of approvals before merging: `2`
* Require conversation resolution before merging: :heavy_check_mark:
* Status checks that are required:
* EasyCLA
* spelling-check
* table-check

### `**/**`

Expand Down
2 changes: 1 addition & 1 deletion CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
#####################################################
#
# Learn about membership in OpenTelemetry community:
# https://github.com/open-telemetry/community/blob/master/community-membership.md
# https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md
#
#
# Learn about CODEOWNERS file format:
Expand Down
93 changes: 50 additions & 43 deletions README.md

Large diffs are not rendered by default.

10 changes: 10 additions & 0 deletions assets.md
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,16 @@ The OpenTelemetry Bot addresses two common issues:

[Personal Access Token]: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

### Slack

The slack user [`OpenTelemetry Admin`](https://cloud-native.slack.com/archives/D07EGBA9V6E) is community owned and can be
used for self-servicing slack (e.g. as Channel Manager to rename spaces).

- Owners: [@open-telemetry/governance-committee](https://github.com/orgs/open-telemetry/teams/governance-committee)
(To login, go to <https://cloud-native.slack.com/>, click Sign In With Google and login as <[email protected]>.
Click `Cancel` when you are asked to open slack in the app, and wait for the link `use Slack in your browser` to be
available and use that.)

## Security

The SIG Security has access to the following tools, with GC and TC members welcome to request access to them as well.
Expand Down
2 changes: 1 addition & 1 deletion community-members.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Members of the Technical Committee are the maintainers of
[Project specs](https://github.com/open-telemetry/opentelemetry-specification)
and [Proto definitions](https://github.com/open-telemetry/opentelemetry-proto).

[Specification sponsors](./community-membership.md#specification-sponsor) are
[Specification sponsors](./guides/contributor/membership.md#specification-sponsor) are
trusted collaborators of the Technical Committee on Project specs and related
repositories:

Expand Down
372 changes: 2 additions & 370 deletions community-membership.md

Large diffs are not rendered by default.

26 changes: 18 additions & 8 deletions docs/how-to-handle-public-calendar.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,11 @@ This way anyone who wants to receive up-to-date invites can join one of those gr
(see [Inviting attendees](#inviting-attendees) below).

## Steps

To create or edit a meeting, you need to have access to the Public OpenTelemetry calendar (a shared Google calendar) and you must add a Zoom meeting link.

### Gaining Calendar Permissions

All SIG maintainers can get access to edit the public OpenTelemetry calendar
by submitting a request to join the google group
[[email protected]](https://groups.google.com/a/opentelemetry.io/g/calendar-edit-permission).
Expand All @@ -35,12 +37,15 @@ Please keep the membership of this group up to date and accurate.

### Create the meeting

:warning: The meeting must initially be created by the [email protected] account,
:warning: The meeting must initially be created by the <[email protected]> account,
otherwise synchronization to external calendars via the `calendar-*@opentelemetry.io` groups may not work.

The following details need to be set properly:

- Title
- Timeslot (make sure to use the correct time zone - Pacific Time - as the dates for switching DST differs between countries)
- Timeslot, with the right timezone set:
- All meeting hours between 2pm and 1am UTC are in Pacific Time (PT), with Daylight Saving Time.
- All meeting hours between 2am and 1pm UTC in UTC+8, without Daylight Saving Time.
- Recurrence pattern (usually weekly or bi-weekly)
- Location (see below for the Zoom links)
- Description
Expand All @@ -55,6 +60,7 @@ The following details need to be set properly:
- See guest list: yes

### Adding a Zoom link to a meeting

Open an issue in the community repository, requesting a new Zoom link.
By requesting a new Zoom link that is only associated with a single meeting series, the meeting recordings
can be associated with a meeting name.
Expand All @@ -64,6 +70,7 @@ You can see which Zoom account any potentially conflicting meetings are using in
(Note: posting the URLs publicly on GitHub leads to Zoom bombing by random bots).

#### Zoom link generation process

_This is the process that the person responding to Zoom link creation issues will follow. The instructions under this heading are for project admins (Governance Committee members) who have access to OpenTelemetry's Zoom account credentials._

1. View the OpenTelemetry meeting calendar, and find your desired time slot, along with the meetings that occur immediately before, during, and after it.
Expand All @@ -73,22 +80,25 @@ _This is the process that the person responding to Zoom link creation issues wil
5. Copy the newly generated unique Zoom link and paste it into the calendar event's description and location.

### Inviting attendees

All meetings should invite a publicly joinable google group `[email protected]` which is specific to the meeting series.
The google group should be set up as follows:

* Who can search for group: Anyone on the web
* Who can join group: Anyone can join
* Who can view conversations: Group members
* Who can post: Group members
* Who can view members: Group managers
- Who can search for group: Anyone on the web
- Who can join group: Anyone can join
- Who can view conversations: Group members
- Who can post: Group members
- Who can view members: Group managers

This allows anyone to subscribe to this specific meeting series by joining that google group.
Please open a community issue to request the creation of a `[email protected]` google group.

### Update the meetings overview

All recurring meetings are listed in the [Community repo's README](../README.md#special-interest-groups), make sure to add/update the respective entry there.

## Zoom bombing prevention

All meetings are created by Zoom with randomized passcodes, which are embedded into the shared calendar links.
All members of [email protected] have access to [this document](https://docs.google.com/document/d/1gt9ctxKGPrM_XTINqLgkSxYypdrczHkt2znjwgBU4UU/edit#)
All members of <[email protected]> have access to [this document](https://docs.google.com/document/d/1gt9ctxKGPrM_XTINqLgkSxYypdrczHkt2znjwgBU4UU/edit#)
listing the host keys for our meetings and explaining how to deal with inappropriate behavior in Zoom.
53 changes: 53 additions & 0 deletions docs/how-to-setup-new-slack-channel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# How we setup new Slack channels

## Naming

Most channels have a name pattern like `#otel-*`. We recommend that pattern
for consistency.

## Channel Settings

The following channel settings help users to understand what a channel is
for and how to quickly access common resources.

### Topic

Describe in a few words what the purpose of this channel is. Assume that end users might not be aware that
`#otel-foo` is the channel of the OpenTelemetry Foo SIG, or what this SIG is doing. A few examples:

- `Discussion of the Java implementation of OpenTelemetry, including the javaagent and instrumentation`
- `Discussion of the OpenTelemetry specification`
- `OpenTelemetry semantic conventions in the security domain`
- `OpenTelemetry Contributor Experience SIG: Improving the experience for those who contribute to OpenTelemetry`

### Description

If the topic field does not provide enough space to write out what your channel is about, you can provide
a more detailed description, otherwise leave it empty.

### Channel Manager

Make sure that all maintainers of your SIG are set as [Channel Managers](https://slack.com/help/articles/8328303095443-Understand-Channel-Managers-in-Slack).
The person who creates the channel, will be a Channel Manager by default and can invite the maintainers.

Do also make the [`OpenTelemetry Admin`](https://cloud-native.slack.com/archives/D07EGBA9V6E) user a Channel Manager.
[The Governance Committee manages this shared account](../assets.md#slack).

### Bookmarks

If the channel is for a specific SIG add bookmarks for the following resources:

- Meeting Notes (Google Docs, `https://docs.google.com/document/d/<id>`)
- Project Board (GitHub, `https://github.com/orgs/open-telemetry/projects/<id>`)
- Get Meeting Invites (Google group for calendar invites, `https://groups.google.com/a/opentelemetry.io/g/calendar-<name>`)
- Issue Tracker (GitHub, `https://github.com/open-telemetry/<reponame>/issues`)

Feel free to add any other link you think is helpful for users to interact with
your SIG, or links that help your triagers, approvers and maintainers for quick access.

### Workflows

You can add workflows to your channel, e.g.

- A reminder for an upcoming SIG meeting
- A welcome message to new users
2 changes: 1 addition & 1 deletion elections/2021/governance-committee-candidates.md
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ Ilan Rabinovitch leads the community and product teams at Datadog. He spends his
- Github: [punya](https://github.com/punya)


I’ve participated in the OpenTelemetry community for the past year, especially the Go and Collector SIGs. In addition to writing code, I help clarify contentious designs and onboard new contributors. As a [triager](../../community-membership.md#triager) for the collector repository, I help our busy maintainers and contributors to use their time efficiently.
I’ve participated in the OpenTelemetry community for the past year, especially the Go and Collector SIGs. In addition to writing code, I help clarify contentious designs and onboard new contributors. As a [triager](../../guides/contributor/membership.md#triager) for the collector repository, I help our busy maintainers and contributors to use their time efficiently.

Before getting involved in telemetry, I led teams at small-to-midsize companies that were shipping products and figuring out observability for the first time. I’d like to use the perspective I gained from that experience to advocate for simple designs that are easy for newcomers and small teams to adopt.

Expand Down
10 changes: 10 additions & 0 deletions guides/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# OpenTelemetry Guidebooks

This directory contains a collection of guides meant for contributors,
maintainers, and community members. These guides are meant to help you get
started, answer common questions, and provide best practices for being a part of
the OpenTelemetry community. These should be considered a living resource, and
everyone is welcome to contribute to them!

- [Contributor Guide](./contributor/README.md)
- [Maintainer Guide](./maintainer/README.md)
88 changes: 88 additions & 0 deletions guides/contributor/CLA.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
# The Contributor License Agreement

The [Cloud Native Computing Foundation](https://www.cncf.io) (CNCF) defines
the legal status of the contributed code in two different types of _Contributor License Agreements_
(CLAs), [individual contributors](https://github.com/cncf/cla/blob/main/individual-cla.pdf) and [corporations](https://github.com/cncf/cla/blob/main/corporate-cla.pdf).

OpenTelemetry can only accept original source code from CLA signatories.

It is important to read and understand this legal agreement.

## How do I sign?

After creating your first Pull Request, the linux-foundation-easycla bot will respond with information regarding your CLA status along with a link to sign the CLA.

<img width="1065" alt="EasyCLA bot" src="https://user-images.githubusercontent.com/69111235/152226443-f6fe61ee-0e92-46c5-b6ea-c0deb718a585.png">

#### 1. If you are signing up as a corporate contributor, ensure that you have linked your corporate email address to your GitHub profile (it doesn't have to be your primary email address for GitHub) or else it can lead to issues with the CLA system.

For more information, please see [Adding an email address to your GitHub account](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-user-account/managing-email-preferences/adding-an-email-address-to-your-github-account).

#### 2. Authorize EasyCLA to read some of your GitHub information

<img width="554" alt="GitHub EasyCLA Authorization" src="https://user-images.githubusercontent.com/69111235/152228712-7d22f9d0-9f3c-4226-9ee0-bacba4b47725.png">

- Click on the **Please click here to be authorized** link to navigate to the GitHub Authorize Linux Foundation: EasyCLA page.
- Then click **Authorize LF-Engineering** to give the Linux Foundation read-only access to list the email addresses associated with your GitHub account.

#### 3. Select from the two types of contributor

<img width="1407" alt="EasyCLA" src="https://user-images.githubusercontent.com/69111235/152224818-1246453a-b086-4a57-9d14-c10d62ad438f.png">


After authorizing EasyCLA, you will be redirected to a page to identify which type of contributor you are.
Select the most appropriate option:
* Individual Contributor: You are contributing as yourself, and not as part of another organization.
* Corporate Contributor: You are contributing on behalf of your employer or other organization.

#### 4. Sign the CLA

Once you select the type of contributor, proceed to Sign the CLA and follow the instructions to complete the signing process through DocuSign.

After you have filled out the information, Click "Finish" and you will be redirected back to your Pull Request.

#### 5. Look for an email indicating successful signup.

> Hello,
>
> This is a notification email from EasyCLA regarding the project Cloud Native Computing > Foundation (CNCF).
>
> The CLA has now been signed. You can download the signed CLA as a PDF here.
>
> If you need help or have questions about EasyCLA, you can read the documentation or reach out to us for support.
>
> Thanks,
> EasyCLA Support Team


#### 6. Validate your CLA

Once you are redirected back to your GitHub Pull Request, reply with a comment `/easycla` to update the CLA status of your PR,
if the bot hasn't picked up the change automatically yet.


## Changing your Affiliation

If you've changed employers and still contribute to OpenTelemetry, your affiliation
needs to be updated. The Cloud Native Computing Foundation uses [gitdm](https://github.com/cncf/gitdm)
to track who is contributing and from where. Create a pull request on the [gitdm](https://github.com/cncf/gitdm)
repository with a change to the corresponding developer affiliation text file.
Your entry should look similar to this:

```
Jorge O. Castro*: jorge!heptio.com, jorge!ubuntu.com, jorge.castro!gmail.com
Heptio
Canonical until 2017-03-31
```

In addition, be sure to update your affiliation on [OpenProfile](https://openprofile.dev).

## Troubleshooting

If you encounter any problems signing the CLA and need further assistance, log a ticket by clicking on the link 'please submit a support request ticket' from the EasyCLA bot's response. Someone from the CNCF will respond to your ticket to help.

Should you have any issues using the LF Support Site, send a message to the
backup email support address <[email protected]>

[Linux Foundation Support Site]: https://support.linuxfoundation.org/
Loading

0 comments on commit 1859742

Please sign in to comment.