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

Investigate how we generate support information and dependencies for install docs #15537

Open
mthalman opened this issue Oct 29, 2019 · 7 comments
Assignees
Labels
doc-bug Problem with the content; needs to be fixed [org][type][category] dotnet-fundamentals/svc install/subsvc okr-health okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.

Comments

@mthalman
Copy link
Member

mthalman commented Oct 29, 2019

Type of issue

Other (describe below)

Description

The documentation at https://github.com/dotnet/docs/blob/master/docs/core/linux-prerequisites.md has a section on Linux distribution dependencies. The packages that are listed here don't line up with the packages that are specified in the packaging runtime deps.

UPDATE (adegeo):

This page was rewritten at some point, and the prerequisites were moved to the individual distro pages. However, this issue still persists. With dotnet/core#9412 this information may be in a json file we can automate to generate a list of prereqs.

Page URL

https://learn.microsoft.com/en-us/dotnet/core/install/linux

Content source URL

https://github.com/dotnet/docs/blob/main/docs/core/install/linux.md

Document Version Independent Id

1850602d-6b92-1449-c8bd-116e36fc0f26

Article author

@adegeo


Associated WorkItem - 308662

@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Oct 29, 2019
@mairaw mairaw added rerun-labels and removed ⌚ Not Triaged Not triaged labels Oct 29, 2019
@mairaw mairaw added doc-bug Problem with the content; needs to be fixed [org][type][category] and removed ⌚ Not Triaged Not triaged labels Oct 29, 2019
@mairaw
Copy link
Contributor

mairaw commented Oct 29, 2019

Thanks for your feedback @mthalman.
@leecow Can you please take a look at this issue for Linux prereqs?

@mairaw mairaw added the P1 label Oct 29, 2019
@leecow
Copy link
Member

leecow commented Oct 31, 2019

The problem is that while packagename* works when the dependency is expressed in a deb, doing the same from a bash script or directly with the package manager does not work (that I can tell anyway).

For example, attempting apt-get install libicu* will literally install every package that starts wtih "libicu".

I'm all for it if there's a way to express this in the docs to simplify things a bit.

@mthalman
Copy link
Member Author

The problem is that while packagename* works when the dependency is expressed in a deb, doing the same from a bash script or directly with the package manager does not work (that I can tell anyway).

For example, attempting apt-get install libicu* will literally install every package that starts wtih "libicu".

I'm all for it if there's a way to express this in the docs to simplify things a bit.

The * wasn't meant to be the literal value used in a shell command; it was merely meant to indicate multiple versions (https://github.com/dotnet/core-setup/blob/fd3b3421d7b901aaac28ad34e63b6480f88973d3/src/pkg/packaging/deb/package.targets#L327).

@mthalman
Copy link
Member Author

mthalman commented Jan 2, 2020

This issue is somewhat related to https://github.com/dotnet/coreclr/issues/26303. In an ideal world, we'd have one master list of native dependencies. Documentation could be updated programatically by reading from this master list.

@dotnet-bot
Copy link
Contributor

This issue has been closed as part of the issue backlog grooming process outlined in #22351.

That automated process may have closed some issues that should be addressed. If you think this is one of them, reopen it with a comment explaining why. Tag the @dotnet/docs team for visibility.

@dotnet-bot dotnet-bot added the won't fix Issues that were closed as part of automated backlog grooming label Jan 25, 2021
@mthalman
Copy link
Member Author

Reopening because this is still relevant. There is a larger effort to better manage the descriptions of native dependencies at dotnet/core#5651.

@mthalman mthalman reopened this Jan 25, 2021
@sharwell sharwell removed the won't fix Issues that were closed as part of automated backlog grooming label Jan 25, 2021
@gewarren gewarren added Pri1 High priority, do before Pri2 and Pri3 and removed P1 Pri2 labels Jan 29, 2021
@ghost ghost added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Sep 8, 2022
@dotnet-bot dotnet-bot added the ⌚ Not Triaged Not triaged label Jul 22, 2024
@adegeo adegeo self-assigned this Sep 5, 2024
@adegeo
Copy link
Contributor

adegeo commented Sep 5, 2024

Revisit later in the year due to dotnet/core#9412

@adegeo adegeo closed this as completed Sep 5, 2024
@adegeo adegeo reopened this Sep 5, 2024
@dotnet-bot dotnet-bot added ⌚ Not Triaged Not triaged and removed ⌚ Not Triaged Not triaged labels Sep 5, 2024
@adegeo adegeo added the 🗺️ reQUEST Triggers an issue to be imported into Quest. label Sep 5, 2024
@dotnet-bot dotnet-bot removed the ⌚ Not Triaged Not triaged label Sep 5, 2024
@sequestor sequestor bot added 📌 seQUESTered Identifies that an issue has been imported into Quest. and removed 🗺️ reQUEST Triggers an issue to be imported into Quest. labels Sep 6, 2024
@adegeo adegeo changed the title Resolve discrepancies with dependency libraries between docs and code Investigate how we generate support information and dependencies for install docs Sep 6, 2024
@adegeo adegeo moved this from 🔖 Ready to Slipped in dotnet/docs November 2024 sprint Dec 3, 2024
@dotnetrepoman dotnetrepoman bot added 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. and removed 🗺️ mapQUEST Only used as a way to mark an issue as updated for quest. RepoMan should instantly remove it. labels Dec 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc-bug Problem with the content; needs to be fixed [org][type][category] dotnet-fundamentals/svc install/subsvc okr-health okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. Pri1 High priority, do before Pri2 and Pri3 📌 seQUESTered Identifies that an issue has been imported into Quest.
Projects
Status: 🔖 Ready
Status: Slipped
Development

No branches or pull requests

10 participants