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

chore: remove getting started and link to documentation. #2493

Merged
merged 3 commits into from
Oct 17, 2021
Merged

chore: remove getting started and link to documentation. #2493

merged 3 commits into from
Oct 17, 2021

Conversation

svrnm
Copy link
Member

@svrnm svrnm commented Sep 23, 2021

Which problem is this PR solving?

As per the SIG discussion yesterday this PR removes the old getting started guide and links to the official documentation at https://opentelemetry.io/docs/js/getting_started/

Short description of the changes

  • Update 2 links in README.md
  • Remove getting-started folder
  • Remove npm scripts for getting-started folder

Note, if you grep for "getting-started", there are a few more references, they all point to a jaeger getting started.

@svrnm svrnm requested a review from a team as a code owner September 23, 2021 13:14
@codecov
Copy link

codecov bot commented Sep 23, 2021

Codecov Report

Merging #2493 (7fe78c9) into main (043067f) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #2493   +/-   ##
=======================================
  Coverage   93.05%   93.05%           
=======================================
  Files         139      139           
  Lines        5172     5172           
  Branches     1110     1110           
=======================================
  Hits         4813     4813           
  Misses        359      359           

@rauno56
Copy link
Member

rauno56 commented Oct 14, 2021

Would you like to rebase this, @svrnm?

@svrnm
Copy link
Member Author

svrnm commented Oct 14, 2021

@rauno56 done.

Copy link
Member

@rauno56 rauno56 left a comment

Choose a reason for hiding this comment

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

I assume the guide(or equivalent info) moved to the website repo, right?

@svrnm
Copy link
Member Author

svrnm commented Oct 14, 2021

Yes exactly. The docs on the website now contain similar information (not exactly the same)

Copy link
Member

@obecny obecny left a comment

Choose a reason for hiding this comment

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

lgtm

@vmarchaud vmarchaud merged commit f2a5624 into open-telemetry:main Oct 17, 2021
@vmarchaud vmarchaud added the document Documentation-related label Oct 17, 2021
MannyPamintuanWorkAccount added a commit to MannyPamintuanWorkAccount/federation that referenced this pull request Dec 13, 2021
This PR does the following,

Updates the link to "Getting Started" to the [most recent link provided in the OTel-JS Repo](https://github.com/open-telemetry/opentelemetry-js/blob/main/README.md?plain=1#L5)

This change in linking is documented in OTel-JS [commit apollographql#2493](open-telemetry/opentelemetry-js#2493)
abernix pushed a commit to apollographql/federation that referenced this pull request Dec 13, 2021
MannyPamintuanWorkAccount added a commit to MannyPamintuanWorkAccount/federation that referenced this pull request Dec 13, 2021
Per @abernix's [great suggestion](apollographql#1302 (review)), this PR does the following,

- Updates the link to "Getting Started" to the [most recent link provided in the OTel-JS Repo](https://github.com/open-telemetry/opentelemetry-js/blob/main/README.md?plain=1#L5)
  - This change in linking is documented in OTel-JS [commit apollographql#2493](open-telemetry/opentelemetry-js#2493)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation-related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants