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

Restructure & add pre-built examples #4043

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

ellahathaway
Copy link
Member

@ellahathaway ellahathaway commented Jan 25, 2024

Related to #3358 (comment)

This PR aims to improve the readability and usability of the pre-built elimination document. It accomplishes the following:

  • Improve the document's readability and usability by providing clear, step-by-step instructions on how to handle new dependencies and pre-builts in the source-build process.
  • The document now explicitly lists the possible actions that a developer might need to take, such as updating versions of certain packages, modifying Version.Details.xml and Versions.Props files, and adding new packages to the source-build-reference-packages or source-build-externals repositories.
  • Each action is explained in detail, with specific examples given. This makes it easier for developers to understand what they need to do and how to do it.
  • The document also provides links to additional resources, such as the source-build-reference-packages and source-build-externals repositories, which can provide further information and context.
  • The document mentions the importance of comparing against SourceBuildPrebuiltBaseline.xml file.
  • Splits important information into separate paragraphs and sections to effectively point readers to key information and allow readers to quickly identify what they need to do.

These formatting changes, along with the content updates, make the document more user-friendly and accessible to developers of different experience levels.

Copy link

I couldn't figure out the best area label to add to this PR. If you have write-permissions please help me learn by adding exactly one area label.

@mthalman
Copy link
Member

@ViktorHofer - I've added you as a review as you encounter prebuilts fairly often. It'd be good to get your perspective since the intention is that you'd be able to follow these instructions to resolve such issues on your own.

@ViktorHofer
Copy link
Member

Don't have time to review right now but will take a look over the weekend or on Monday.

Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Copy link
Member

@MichaelSimons MichaelSimons left a comment

Choose a reason for hiding this comment

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

Ella, Thanks for improving this documentation!

Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Outdated Show resolved Hide resolved
Documentation/eliminating-pre-builts.md Show resolved Hide resolved
@ellahathaway
Copy link
Member Author

@ViktorHofer - Requesting review since I've now updated 'new-dependencies.md' As Matt mentioned in a previous comment, your perspective is important since we intend for readers to be able to follow the instructions and resolve issues on their own. Thanks in advance!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants