-
Notifications
You must be signed in to change notification settings - Fork 1.5k
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
Add opentelemetry.io docs #2839
Conversation
Codecov Report
@@ 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.
|
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
@austinlparker please address the comment. |
This PR was marked stale due to lack of activity. It will be closed in 7 days. |
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>
The link check is never gonna work on this, is there a way to ignore it for files in this path? |
@austinlparker it doesn't look like markdown-link-check supports ignoring files, just links on specific lines or in specific blocks of markdown.
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 |
@austinlparker Is the docs content in this PR copied from https://github.com/open-telemetry/opentelemetry.io/tree/main/content/en/docs/collector ? 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 ? |
Yeah, it's whatever was there when I made the PR.
Yes, if it's desired. |
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 |
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. |
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}} |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
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).
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).