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

feat: [es] Create /docs/contributing/new-content.md #5270

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
286225b
fix: :bug: remove markdown list enumerator to display content in merm…
TineoC Sep 30, 2024
d76b1da
docs: :memo: create add new content page in spanish
TineoC Sep 30, 2024
d7cd84f
chore: :memo: capitalize link declarations
TineoC Sep 30, 2024
25636ca
OTel .NET Auto - typo fixes propagators -> exporters (#5269)
Kielek Sep 30, 2024
d787c50
OTel Arrow blog drive-by copyedits (#5268)
chalin Sep 30, 2024
41f6fd5
Contributing: improved guidance for quick-fixers, mentees, and more (…
chalin Sep 30, 2024
b018e75
Merge branch 'main' into docs/es/contributing-new-content
TineoC Sep 30, 2024
06c5930
Apply suggestions from code review
TineoC Sep 30, 2024
ff9c04a
chore: replace empaqueta to compila
TineoC Sep 30, 2024
99cf51c
Merge branch 'main' into docs/es/contributing-new-content
TineoC Sep 30, 2024
b9d61b2
Revert "fix: :bug: remove markdown list enumerator to display content…
TineoC Sep 30, 2024
8a653c2
Apply suggestions from code review
TineoC Sep 30, 2024
ec0561b
docs: :memo: rename new content docs to pull-requests.md
TineoC Sep 30, 2024
616a294
Merge branch 'main' into docs/es/contributing-new-content
TineoC Sep 30, 2024
4e7d1fb
Update pull-requests.md
theletterf Oct 1, 2024
cfb4a46
Merge branch 'main' into docs/es/contributing-new-content
theletterf Oct 1, 2024
241e6df
Merge branch 'main' into docs/es/contributing-new-content
TineoC Oct 1, 2024
68b0c17
Revert "Merge branch 'main' into docs/es/contributing-new-content"
TineoC Oct 1, 2024
4e42f60
Update content/es/docs/contributing/pull-requests.md
theletterf Oct 1, 2024
af6c6ba
Update content/es/docs/contributing/pull-requests.md
theletterf Oct 1, 2024
eeaa0b4
Results from /fix:format
opentelemetrybot Oct 1, 2024
50b579b
Add hash
theletterf Oct 1, 2024
03ce062
Results from /fix:refcache
opentelemetrybot Oct 1, 2024
ca62e22
feat: [es] Create docs/kubernetes/collector/components.md (#5263)
falconcr Oct 1, 2024
25759b5
fix: :bug: remove markdown list enumerator to display content in merm…
TineoC Sep 30, 2024
e3cd5d2
Contributing: improved guidance for quick-fixers, mentees, and more (…
chalin Sep 30, 2024
329ce4f
Merge branch 'main' into docs/es/contributing-new-content
TineoC Oct 1, 2024
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
1 change: 0 additions & 1 deletion .htmltest.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ IgnoreDirs:
- zh/docs/contributing/pr-checks
IgnoreInternalURLs: # list of paths
IgnoreURLs: # list of regexs of paths or URLs to be ignored
- ^/api$
- ^((/..)?/docs/languages/\w+|\.\.)/(api|examples|registry)/$
- ^(/..)?/docs/collector/registry/$
- ^(/..)?/docs/languages/net/(metrics-api|traces-api)/
Expand Down
15 changes: 15 additions & 0 deletions content/en/api-docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: API Documentation
linkTitle: Docs
---

{{% blocks/section color="white" %}}

## {{% param title %}}

Below you will find links to all the API references available for the different
implementations of the OpenTelemetry API & SDK

{{% apidocs %}}

{{% /blocks/section %}}
8 changes: 0 additions & 8 deletions content/en/api.md

This file was deleted.

42 changes: 0 additions & 42 deletions content/en/docs/contributing/issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,50 +5,8 @@ description:
improvement.
weight: 10
cSpell:ignore: prepopulated
_issues: https://github.com/open-telemetry/opentelemetry.io/issues
_issue: https://github.com/open-telemetry/opentelemetry.io/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3A
---

## Fixing an existing issue

One of the best ways to help make OTel docs better is to fix an existing issue.

1. Browse through the list of [issues]({{% param _issues %}}).
2. Select an issue that you would like to work on, ideally one that you can fix
in a short amount of time.

<!-- prettier-ignore -->
<a name="first-issue"></a>
{{% alert title="First time contributing? " %}}

Select an issue with the following labels:

- [Good first issue]
- [Help wanted]

<!-- prettier-ignore -->
> **NOTE**: we **_do not_ assign issues** to those who
> have not already made contributions to the [OpenTelemetry
> organization][org].
{.mt-3}

<!-- prettier-ignore -->
[good first issue]: {{% param _issue %}}%22good+first+issue%22
[help wanted]: {{% param _issue %}}%3A%22help+wanted%22
[org]: https://github.com/open-telemetry

{{% /alert %}}

3. Read through the issue comments, if any.
4. Ask maintainers if this issue is still relevant, and ask any questions you
need for clarification by posting comments over the issue.
5. Share your intention to work on the issue by adding add a comment to this
effect.
6. Work on fixing the issue. Let maintainers know if you run into any problems.
7. When ready, [submit your work through a pull request](../pull-requests) (PR).

## Reporting an issue

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

Expand Down
20 changes: 10 additions & 10 deletions content/en/docs/contributing/pull-requests.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,14 +68,14 @@ A([fa:fa-user New<br>Contributor]) --- id1[(open-telemetry/opentelemetry.io<br>G
subgraph tasks[Changes using GitHub]
direction TB
0[ ] -.-
1[1. Edit this page] --> 2[2. Use GitHub markdown<br>editor to make changes]
2 --> 3[3. fill in Propose file change]
1[Edit this page] --> 2[Use GitHub markdown<br>editor to make changes]
2 --> 3[fill in Propose file change]

end
subgraph tasks2[ ]
direction TB
4[4. select Propose file change] --> 5[5. select Create pull request] --> 6[6. fill in Open a pull request]
6 --> 7[7. select Create pull request]
4[select Propose file change] --> 5[select Create pull request] --> 6[fill in Open a pull request]
6 --> 7[select Create pull request]
end

id1 --> tasks --> tasks2
Expand Down Expand Up @@ -289,15 +289,15 @@ Figure 4 shows the steps to open a PR from your fork to
flowchart LR
subgraph first[ ]
direction TB
1[1. Go to opentelemetry.io repository] --> 2[2. Select New Pull Request]
2 --> 3[3. Select compare across forks]
3 --> 4[4. Select your fork from<br>head repository drop-down menu]
1[Go to opentelemetry.io repository] --> 2[Select New Pull Request]
2 --> 3[Select compare across forks]
3 --> 4[Select your fork from<br>head repository drop-down menu]
end
subgraph second [ ]
direction TB
5[5. Select your branch from<br>the compare drop-down menu] --> 6[6. Select Create Pull Request]
6 --> 7[7. Add a description<br>to your PR]
7 --> 8[8. Select Create pull request]
5[Select your branch from<br>the compare drop-down menu] --> 6[Select Create Pull Request]
6 --> 7[Add a description<br>to your PR]
7 --> 8[Select Create pull request]
end

first --> second
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/languages/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,9 +48,9 @@ references are available:

{{% apidocs %}}

{{% alert title="Note" color="info" %}}
{{% alert title="Tip" color="info" %}}

The list above is aliased to [`/api`](/api).
You can find a list of available API references at </api-docs>.

{{% /alert %}}

Expand Down
Loading
Loading