Update doc for visual tree masters update#2660
Conversation
marcelwgn
left a comment
There was a problem hiding this comment.
Maybe we could have both situations covered in this doc instead of just showing the "external contributor" workflow, since the two workflows seem different enough to point that out.
|
Yes, this is my reasoning why I did not yet delete the old images. Since I don't know who exactly has the permission to online download the visual tree masters I will defer to the WinUI team here. (For example, if only the WinUI team has permission to download them online, a case can be made that documenting this interally then would be enough since the info would be of little to no use for the community contributors. If, however, folks external to the WinUI team can also have these permissions then this case should be covered in the documentation.) |
Thanks for doing this, I think it makes sense to keep both. The internal path is available to any Microsoft employee so there would be a number for 1st party customer teams that could appreciate that documentation. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
In that case I will add a section for MS employees (using the previous images) and another section for external contributors (using the new images introduced with this PR). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
as per #2725 we are changing Master to VerificationFile and should probably update the terminology here as well. |
|
@Felix-Dev I think this is ready to go in once its merged with @chingucoding change that went in yesterday. |
|
@chingucoding @StephenLPeters Am I correct when I assume the folder in the downloadable There's also this image which needs to be updated then: https://github.com/microsoft/microsoft-ui-xaml/blob/master/docs/images/masters_folder.png |
Yes I think that that would be the new folder name. |
|
The UI has changed since that screenshot was taken =/ I've put images for how you get there from an employee perspective. @Felix-Dev if you don't want your name in the doc picture let me know and I'll find a different PR to take it from. |
|
@StephenLPeters Thanks for sharing the updated screenshots. No, as far as I'm concerned, you don't have to find a different screenshot. At most I will edit out my name and replace it with [PR author] as done initially in this PR. That said...I don't think I have an issue with my github handle listed there. Will include the new images in this PR soon! Edit 2: Nevermind. |
|
I'm not yet done with updating this PR. |
|
@StephenLPeters Done. Please take a look. Edit: Also had to update the download steps for external contributors as they now also need to open the LinksToHelixTestFiles.html file. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
@Felix-Dev can you merge master once more to pick up the heap limit fix keith checked in? |
|
@StephenLPeters Done. |
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
Description
The given developer documentation for updating the visual tree masters is not showing the correct steps in case the WinUI contributor does not have permissions to view the Azure Pipelines artifact content online. This PR updates the images accordingly.
Note: I have kept the original images describing how to specifically download the new visual tree masters in Azure Pipelines directly (but removed them from the documentation for now) as I'm not entirely sure who exactly has these online download permissions (just the WinUI team or even more folks)? If required, I will put them into the developer guide again. If they are no longer needed, I will gladly remove them.
How Has This Been Tested?
Visually (see screenshots).
Screenshots:
Old:
New: