Skip to content

Commit

Permalink
Fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
theletterf committed Jun 13, 2024
1 parent 6e16f18 commit db24032
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 59 deletions.
Original file line number Diff line number Diff line change
@@ -1,62 +1,9 @@
---
title: Issues and announcements
description: How to report a bug, a security issue, or a potential improvement.
title: Announcements
description: Create announcements or banners for special events.
weight: 50
---

If you notice an error or want to suggest improvements to existing content, open
an issue.

1. Click the **Create documentation issue** link on any document. This redirects
you to a GitHub issue page prepopulated with some headers.
2. Describe the issue or suggestion for improvement. Provide as many details as
you can.
3. Click **Submit new issue**.

After submitting, check in on your issue occasionally or turn on GitHub
notifications. It might take a few days until maintainers and approvers respond.
Reviewers and other community members might ask questions before they can take
action on your issue.

## Suggesting new content or features

If you have an idea for new content or a feature, but you aren't sure where it
should go, you can still file an issue. You can also report bugs and security
vulnerabilities.

1. Go to
[GitHub](https://github.com/open-telemetry/opentelemetry.io/issues/new/) and
select **New issue** inside the **Issues** tab.

1. Select the type of issue that best applies to your request or doubt.

1. Fill out the template.

1. Submit the issue.

### How to file great issues

Keep the following in mind when filing an issue:

- Provide a clear issue description. Describe what specifically is missing, out
of date, wrong, or needs improvement.
- Explain the specific impact the issue has on users.
- Limit the scope of a given issue to a reasonable unit of work. For problems
with a large scope, break them down into smaller issues. For example, "Fix the
security docs" is too broad, but "Add details to the 'Restricting network
access' topic" is specific enough to be actionable.
- Search the existing issues to see if there's anything related or similar to
the new issue.
- If the new issue relates to another issue or pull request, refer to it either
by its full URL or by the issue or pull request number prefixed with a `#`
character. For example, `Introduced by #987654`.
- Follow the
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
Respect your fellow contributors. For example, "The docs are terrible" is not
helpful or polite feedback.

## Announcement management

An announcement is a _regular Hugo page_ contained under the `announcements`
section of a locale. This means that we leverage Hugo's builtin handling of page
dates (future or expired), internationalization, and more, to automatically show
Expand Down
56 changes: 56 additions & 0 deletions content/en/docs/contributing/issues.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: Reporting an issue
description: How to report a bug, a security issue, or a potential improvement.
weight: 50
---

If you notice an error or want to suggest improvements to existing content, open
an issue.

1. Click the **Create documentation issue** link on any document. This redirects
you to a GitHub issue page prepopulated with some headers.

Check warning on line 11 in content/en/docs/contributing/issues.md

View workflow job for this annotation

GitHub Actions / SPELLING check

Unknown word (prepopulated)
2. Describe the issue or suggestion for improvement. Provide as many details as
you can.
3. Click **Submit new issue**.

After submitting, check in on your issue occasionally or turn on GitHub
notifications. It might take a few days until maintainers and approvers respond.
Reviewers and other community members might ask questions before they can take
action on your issue.

## Suggesting new content or features

If you have an idea for new content or a feature, but you aren't sure where it
should go, you can still file an issue. You can also report bugs and security
vulnerabilities.

1. Go to
[GitHub](https://github.com/open-telemetry/opentelemetry.io/issues/new/) and
select **New issue** inside the **Issues** tab.

1. Select the type of issue that best applies to your request or doubt.

1. Fill out the template.

1. Submit the issue.

### How to file great issues

Keep the following in mind when filing an issue:

- Provide a clear issue description. Describe what specifically is missing, out
of date, wrong, or needs improvement.
- Explain the specific impact the issue has on users.
- Limit the scope of a given issue to a reasonable unit of work. For problems
with a large scope, break them down into smaller issues. For example, "Fix the
security docs" is too broad, but "Add details to the 'Restricting network
access' topic" is specific enough to be actionable.
- Search the existing issues to see if there's anything related or similar to
the new issue.
- If the new issue relates to another issue or pull request, refer to it either
by its full URL or by the issue or pull request number prefixed with a `#`
character. For example, `Introduced by #987654`.
- Follow the
[Code of Conduct](https://github.com/open-telemetry/community/blob/main/code-of-conduct.md).
Respect your fellow contributors. For example, "The docs are terrible" is not
helpful or polite feedback.
2 changes: 1 addition & 1 deletion content/en/docs/contributing/new-content.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Add new content
description: Learn how to add new content using GitHub UI or a local fork.
weight: 10
weight: 2
---

To contribute new content pages or improve existing content pages, open a pull
Expand Down
5 changes: 2 additions & 3 deletions content/en/docs/contributing/requirements.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Requirements
description:
To contribute, you need to be familiar with the following techs and tools.
weight: 10
weight: 1
---

To contribute, you need to be familiar with the following techs and tools:
Expand All @@ -20,8 +20,7 @@ locally, see [Development](/docs/contributing/development).
All OpenTelemetry contributors must read the
[Contributor guide](https://github.com/open-telemetry/community/blob/main/CONTRIBUTING.md)
and
[sign the Contributor License Agreement (CLA)](https://docs.linuxfoundation.org/lfx/easycla/contributors)
.
[sign the Contributor License Agreement (CLA)](https://docs.linuxfoundation.org/lfx/easycla/contributors).

Pull requests from contributors who haven't signed the CLA fail the automated
tests. The name and email you provide must match those found in your
Expand Down

0 comments on commit db24032

Please sign in to comment.