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

Add opentelemetry.io docs #2839

Merged
merged 10 commits into from
May 19, 2021

Conversation

austinlparker
Copy link
Member

Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector).

@austinlparker austinlparker requested a review from a team March 29, 2021 16:49
@codecov
Copy link

codecov bot commented Mar 29, 2021

Codecov Report

Merging #2839 (be47882) into main (39e0adc) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #2839   +/-   ##
=======================================
  Coverage   91.76%   91.76%           
=======================================
  Files         281      281           
  Lines       15149    15149           
=======================================
  Hits        13902    13902           
  Misses        853      853           
  Partials      394      394           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 39e0adc...be47882. Read the comment docs.

@github-actions
Copy link
Contributor

github-actions bot commented Apr 7, 2021

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@github-actions
Copy link
Contributor

This PR was marked stale due to lack of activity. It will be closed in 7 days.

@tigrannajaryan
Copy link
Member

@austinlparker please address the comment.

@github-actions
Copy link
Contributor

github-actions bot commented May 7, 2021

This PR was marked stale due to lack of activity. It will be closed in 7 days.

austinlparker and others added 5 commits May 12, 2021 11:45
Co-authored-by: shelby spees <shelby@honeycomb.io>
Co-authored-by: shelby spees <shelby@honeycomb.io>
Co-authored-by: shelby spees <shelby@honeycomb.io>
Co-authored-by: shelby spees <shelby@honeycomb.io>
Co-authored-by: shelby spees <shelby@honeycomb.io>
@austinlparker
Copy link
Member Author

The link check is never gonna work on this, is there a way to ignore it for files in this path?

@shelbyspees
Copy link
Contributor

@austinlparker it doesn't look like markdown-link-check supports ignoring files, just links on specific lines or in specific blocks of markdown.

<!-- markdown-link-check-disable --> and <!-- markdown-link-check-enable-->: Use these to disable links for all links appearing between these comments.

I don't love that option since it adds noise to the source files. It doesn't look like we currently use markdown-link-check in the main docs repo, but if we decide to in the future we'd have to deal with any disable/enable comments we add in here.

There's also an open issue to add an exclude parameter to the GitHub action config: gaurav-nelson/github-action-markdown-link-check#38. It looks like the maintainer wants to add it, but I'm not sure about their timeline for that.

@tigrannajaryan tigrannajaryan self-assigned this May 12, 2021
@tigrannajaryan
Copy link
Member

@austinlparker
Copy link
Member Author

@austinlparker Is the docs content in this PR copied from https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector ?

Yeah, it's whatever was there when I made the PR.

Do you also plan to add the update-docs job in a later PR like we have for Java https://github.com/open-telemetry/opentelemetry-java/blob/main/.github/workflows/docs-update.yml ?

Yes, if it's desired.

@austinlparker
Copy link
Member Author

I went ahead and pushed the update script in this PR as well, can be removed if desired.

@tigrannajaryan
Copy link
Member

I went ahead and pushed the update script in this PR as well, can be removed if desired.

Thanks.

What's the plan with the failing link checks? Will you add <!-- markdown-link-check-disable --> annotations or you are looking for some other solution?

@austinlparker
Copy link
Member Author

I'll add the annotations for now, I was hoping someone had a better idea on ignoring the path but this should at least unblock things for now.

@austinlparker
Copy link
Member Author

I guess bounce the checks when the GitHub Actions incident is resolved?

uses: actions/checkout@v2.3.4
- name: make-pr
env:
API_TOKEN_GITHUB: ${{secrets.DOC_UPDATE_TOKEN}}
Copy link
Member

Choose a reason for hiding this comment

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

I assume once this PR is merged we will need to add the token, right? Let's do it after it is merged and do a test run of the workflow to see how it works.

Copy link
Member

Choose a reason for hiding this comment

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

@austinlparker can you please add the token and let's see how the docs-update works.

@tigrannajaryan tigrannajaryan merged commit 57f8e26 into open-telemetry:main May 19, 2021
dashpole pushed a commit to dashpole/opentelemetry-collector that referenced this pull request Jun 14, 2021
Per open-telemetry/opentelemetry.io#472, we're mirroring the docs content on the website to each SIG. When a release occurs and these docs are updated, please make an issue or PR mirroring them to their appropriate location in the website repo (https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants