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

Make a note for pip3 installations #1825

Closed
wants to merge 1 commit into from

Conversation

marcosflobo
Copy link
Contributor

@marcosflobo marcosflobo commented May 7, 2021

In case some users have python3-pip installed, the commands to install the opentelemetry-api & opentelemetry-sdk is pip3 instead of pip

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • Test A

Does This PR Require a Contrib Repo Change?

Answer the following question based on these examples of changes that would require a Contrib Repo Change:

  • The OTel specification has changed which prompted this PR to update the method interfaces of opentelemetry-api/ or opentelemetry-sdk/

  • The method interfaces of test/util have changed

  • Scripts in scripts/ that were copied over to the Contrib repo have changed

  • Configuration files that were copied over to the Contrib repo have changed (when consistency between repositories is applicable) such as in

    • pyproject.toml
    • isort.cfg
    • .flake8
  • When a new .github/CODEOWNER is added

  • Major changes to project information, such as in:

    • README.md
    • CONTRIBUTING.md
  • Yes. - Link to PR:

  • No.

Checklist:

  • Followed the style guidelines of this project
  • Changelogs have been updated
  • Unit tests have been added
  • Documentation has been updated

In case some users have python3-pip installed, the commands to install the opentelemetry-api & opentelemetry-sdk is `pip3` instead of `pip`
@marcosflobo marcosflobo requested review from a team, owais and srikanthccv and removed request for a team May 7, 2021 14:43
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented May 7, 2021

CLA Signed

The committers are authorized under a signed CLA.

Copy link
Contributor

@owais owais left a comment

Choose a reason for hiding this comment

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

I don't think libraries should be educating people about package managers in general. User systems can be vastly different from a standard python installation and it'd be impractical to document for every scenario.

This change seems to be pretty harmless though so approving.

May be we can add a pitfalls or FAQ page to the documentation to mention all such edge cases when they come up.

@srikanthccv
Copy link
Member

srikanthccv commented May 7, 2021

We have pip install ... in almost all the places across repo/docs and I believe regular user is knowledgeable enough to know and change the command themselves. pitfalls or FAQ page sounds like a good option to me.

@lzchen
Copy link
Contributor

lzchen commented May 10, 2021

@owais @lonewolf3739
If we are going with the pitfalls/FAQ page then we probably shouldn't be moving forward with this change then correct? Otherwise we should include this excerpt in everywhere we are using pip install...

@srikanthccv
Copy link
Member

@owais @lonewolf3739
If we are going with the pitfalls/FAQ page then we probably shouldn't be moving forward with this change then correct? Otherwise we should include this excerpt in everywhere we are using pip install...

Yes

@lzchen
Copy link
Contributor

lzchen commented May 10, 2021

@marcosflobo
Does the above conversation make sense?

@ocelotl
Copy link
Contributor

ocelotl commented May 25, 2021

I appreciate the intention of this PR, but I agree that package installation details are outside the scope of this particular documentation. I suggest we close this PR.

@lzchen
Copy link
Contributor

lzchen commented May 26, 2021

Closing in favor of #1875

@lzchen lzchen closed this May 26, 2021
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.

5 participants