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

New publishing infrastructure documentation #4556

Merged
merged 14 commits into from
Jan 15, 2020
Merged

New publishing infrastructure documentation #4556

merged 14 commits into from
Jan 15, 2020

Conversation

JohnTortugo
Copy link
Contributor

Closes: #3599

Removed documentation about the old infrastructure and updated documentation about YAML Stages based publishing.

@JohnTortugo JohnTortugo self-assigned this Dec 19, 2019
@markwilkie
Copy link
Member

Super happy this exists!

@riarenas
Copy link
Member

Aside from my comment about the differences section, this LGTM. Let's get someone else from the team that isn't involved in the infra to take a look with fresh eyes. That usually catches places where we have made assumptions that new people onboarding might not understand.

@markwilkie
Copy link
Member

Thanks @JohnTortugo !

A few high level comments:

  • Would it make sense to have the first section be "Here's what to do if you're a normal repo"? One would hope that this would be sufficient for most folks.
  • What if the deprecated stuff was moved to a seperate doc? In a few months, folks won't even remember that there was a "before". But a link to "here's how it used to work" would be good, especially given servicing.
  • Perhaps structure the rest of the doc w/ the same content, but in more of a reference style. Meaning, imagining that somebody is wondering how to do "x", what what "y" parameter means. I think most of it is there, but perhaps some additional organization.

Regardless, this looks quite complete. Thanks Cesar!

@JohnTortugo
Copy link
Contributor Author

Thanks @JohnTortugo !

A few high level comments:

  • Would it make sense to have the first section be "Here's what to do if you're a normal repo"? One would hope that this would be sufficient for most folks.
  • What if the deprecated stuff was moved to a seperate doc? In a few months, folks won't even remember that there was a "before". But a link to "here's how it used to work" would be good, especially given servicing.
  • Perhaps structure the rest of the doc w/ the same content, but in more of a reference style. Meaning, imagining that somebody is wondering how to do "x", what what "y" parameter means. I think most of it is there, but perhaps some additional organization.

Regardless, this looks quite complete. Thanks Cesar!

I think those are all good suggestions Mark. I changed the text to incorporate them. Thanks!

@JohnTortugo
Copy link
Contributor Author

@riarenas @markwilkie - I think the doc is in much better shape now. Thanks for the suggestions.

@jcagme @adiaaida @garath @sunandabalu @mjanecke @MattGal @jonfortescue - PTAL if you have some time. I could benefit from a reviewer not so familiar with the work done.

@sunandabalu
Copy link
Member

FAQ section is very helpful 👍

Copy link
Member

@missymessa missymessa left a comment

Choose a reason for hiding this comment

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

Looks good. Like the FAQ section, and the tutorial appears to be fairly easy for someone to set up. Nice work :)

JohnTortugo and others added 2 commits January 7, 2020 10:10
Co-Authored-By: Ricardo Arenas <riarenas@microsoft.com>
Co-Authored-By: Ricardo Arenas <riarenas@microsoft.com>
@JohnTortugo
Copy link
Contributor Author

@markwilkie are you good to merge this?

@riarenas
Copy link
Member

riarenas commented Jan 8, 2020

I just realized there's something we should probably add to this doc: A description of the purpose for each of the artifact types that we use: PackageArtifacts, BlobArtifacts, PdbArtifacts etc.

@JohnTortugo
Copy link
Contributor Author

I just realized there's something we should probably add to this doc: A description of the purpose for each of the artifact types that we use: PackageArtifacts, BlobArtifacts, PdbArtifacts etc.

Done.

@markwilkie - can you please merge this? I don't have permission to do it.

@markwilkie markwilkie merged commit 6655dd0 into dotnet:master Jan 15, 2020
@JohnTortugo JohnTortugo deleted the PublishingDocs branch January 15, 2020 05:06
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.

Publishing documentation
6 participants