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.

Sign up for GitHub

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

Jump to bottom

Support moniker specific folders for readmes (and incoming service overviews) #1233

Merged
5 commits merged into from
Dec 3, 2020
Merged

Support moniker specific folders for readmes (and incoming service overviews) #1233

5 commits merged into from
Dec 3, 2020

Conversation

scbedd
Copy link
Member

@scbedd scbedd commented Dec 1, 2020 •
edited
Loading

Current.

<doc repo root>/
   docs-ref-services/
      storage-blob-readme.md
      storage-blob-readme-pre.md

New

<doc repo root>/
   docs-ref-services/
      latest/
         storage-blob-readme.md
      preview/
         storage-blob-readme.md

This is enabled by docfx updates that change our publishing to pull from the different folders but write to the same URL PATH.

The outcome of this + the SyncToC update + other updates to release configs is that we will be able to swap between monikers as expected!

@scbedd scbedd requested a review from a team as a code owner December 1, 2020 02:08
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
js - template
net - template
python - template
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

mitchdenny
mitchdenny approved these changes Dec 1, 2020
View reviewed changes
Copy link
Contributor

@mitchdenny mitchdenny left a comment

Choose a reason for hiding this comment

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

Only one minor comment.

eng/common/scripts/update-docs-metadata.ps1 Outdated Show resolved Hide resolved
weshaggard
weshaggard reviewed Dec 2, 2020
View reviewed changes
eng/common/scripts/update-docs-metadata.ps1 Outdated
$rdSuffix = "-pre"
}

$readmeName = "$($packageInfo.PackageId.Replace('azure-','').Replace('Azure.', '').Replace('@azure/', '').ToLower())-readme$rdSuffix.md"
Copy link
Member

Choose a reason for hiding this comment

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

orthogonal but something to be aware of... for open telemetry some of the things now have @microsoft scope instead of @Azure in the names (see https://github.com/Azure/azure-sdk-for-js/pull/12458/files). Eventually you might need to handle those as package names as well.

Copy link
Member Author

Choose a reason for hiding this comment

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

Nah man. It's an easy fix. Will definitely get that in here too.

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not happy with my easy fix. Ugly as hell.

Copy link
Member

Choose a reason for hiding this comment

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

Was the ugly fix part of this PR? I don't see any handling of this or at least didn't understand how it was handled in this PR.

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
js - template
net - template
python - template
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@scbedd
reformatted parameter arguments to both update-docs scripts. added pa…
b1fbac2 
…rameter requirements and renamed CIRepository to DocRepoLocation which is a lot clearer.
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
js - template
net - template
python - template
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
js - template
net - template
python - template
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

@pakrym pakrym mentioned this pull request Dec 2, 2020
Closed
@azure-sdk
Copy link
Collaborator

The following pipelines have been queued for testing:
java - template
js - template
net - template
python - template
You can sign off on the approval gate to test the release stage of each pipeline.
See eng/common workflow

This was referenced Dec 3, 2020
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
Merged
@ghost
Copy link

ghost commented Dec 3, 2020

Hello @azure-sdk!

Because this pull request has the auto-merge label, I will be glad to assist with helping to merge this pull request once all check-in policies pass.

p.s. you can customize the way I help with merging this pull request, such as holding this pull request until a specific person approves. Simply @mention me (@msftbot) and give me an instruction to get started! Learn more here.

@ghost ghost merged commit 52e4f2f into Azure:master Dec 3, 2020
sima-zhu pushed a commit to sima-zhu/azure-sdk-tools that referenced this pull request Dec 3, 2020
@ahsonkhan
Add preview 5 release date to the changelog. (Azure#1233)
37d84c7
This pull request was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sima-zhu sima-zhu sima-zhu left review comments

@weshaggard weshaggard weshaggard left review comments

@mitchdenny mitchdenny mitchdenny approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@scbedd @azure-sdk @mitchdenny @weshaggard @sima-zhu