Move to eng/common docindex reference #17728

sima-zhu · 2020-11-20T17:06:21Z

Several things need to finish before we proceed the PR.

Update docindex.yml in eng/common
Remove useless template and scripts

…into test_doc_index

eng/scripts/Language-Settings.ps1

weshaggard · 2020-11-20T18:29:06Z

eng/common/pipelines/templates/steps/docindex.yml

@@ -49,6 +47,7 @@ jobs:
          targetPath: $(Build.ArtifactStagingDirectory)/docfx_project/_site

      - pwsh: |
+          git commit -am "Save the language updates."


Is the commit only for the mutated files or is it also for the generated files?

Only for mutated files.

weshaggard · 2020-11-20T18:29:24Z

eng/common/pipelines/templates/steps/docindex.yml

@@ -1,7 +1,5 @@
 jobs:
  - job: CreateDocIndex
-    variables:


I assume you plan to make this in the tools repo once you get this working here.

Right, this is a miss when I do testing. Since the docindex is not in master, I haven't done full testing on pipeline. Will test all repo and submit another change in tool repo.

weshaggard · 2020-11-20T19:16:58Z

eng/common/pipelines/templates/steps/docindex.yml

@@ -49,6 +47,7 @@ jobs:
          targetPath: $(Build.ArtifactStagingDirectory)/docfx_project/_site

      - pwsh: |
+          git -c user.name=`"azure-sdk`" -c user.email=`"[email protected]`" commit -am "Save the language updates."


Do they have to be committed? Why not just revert them since you already made a copy of them.

I can go with git reset --hard HEAD

weshaggard · 2020-11-20T21:17:03Z

eng/scripts/Language-Settings.ps1

@@ -3,6 +3,8 @@ $PackageRepository = "Maven"
 $packagePattern = "*.pom"
 $MetadataUri = "https://raw.githubusercontent.com/Azure/azure-sdk/master/_data/releases/latest/java-packages.csv"
 $BlobStorageUrl = "https://azuresdkdocs.blob.core.windows.net/%24web?restype=container&comp=list&prefix=java%2F&delimiter=%2F"
+$IndexHtmlLoc = "index.html"


Is there any case where this isn't index.html, and if there is can we change it?

Originally, .NET points to api/index.html.

https://azuresdkdocs.blob.core.windows.net/$web/dotnet/Azure.AI.TextAnalytics/1.0.0/api/index.html

I can do double check if it can be replaced by index.html

I'd like to have them all be index.hml if possible. This is one of those other inconsistencies that has bothered me and we have to workaround. See https://github.com/Azure/azure-sdk/blob/master/eng/scripts/Update-Release-Versions.ps1#L59 as an example were we had do workaround these being different.

weshaggard · 2020-11-20T21:18:57Z

eng/scripts/Language-Settings.ps1

@@ -3,6 +3,8 @@ $PackageRepository = "Maven"
 $packagePattern = "*.pom"
 $MetadataUri = "https://raw.githubusercontent.com/Azure/azure-sdk/master/_data/releases/latest/java-packages.csv"
 $BlobStorageUrl = "https://azuresdkdocs.blob.core.windows.net/%24web?restype=container&comp=list&prefix=java%2F&delimiter=%2F"
+$IndexHtmlLoc = "index.html"
+$AppTitle = "Azure SDK for Java"


Should we just default this to "Azure SDK for $lang"? If we do that and everything uses index.html by default then that will allow most languages to not have to pass any arguments to the UpdateDocIndexFiles call.

.NET cannot apply this.
$lang = "dotnet"
$AppTitle = "Azure SDK for NET"

https://github.com/Azure/azure-sdk-tools/blob/master/eng/common/docgeneration/Generate-DocIndex.ps1#L152

Don't we have that already? Even if we need to pass in the ".NET" as the lang explicitly in that case we can still do that. However that is still better then needing to pass in "Azure SDK for" in every language.

sima-zhu · 2020-12-02T17:13:22Z

This is a duplicate one for #17906. Close this one.

Dev securityinsights microsoft.security insights 2021 10 01 (Azure#17924) * Adds base for updating Microsoft.SecurityInsights from version stable/2021-04-01 to version 2021-10-01 * Updates readme * Updates API version in new specs and examples * Add AlertRules to microsoft.security insights 2021 10 01 (Azure#15657) * Adds base for updating Microsoft.SecurityInsight's AlertRules from version stable/2020-01-01 to version 2021-10-01 * Updates API version in AlertRules specs and examples * Use common types in AlertRules.json and remove redundant SecurityInsights * Add AlertRules to readme * Copy action examples for alert rules * Add type:object where missing * Align CloudError with rest of the resources in this version * Update readme Co-authored-by: Anat Gilenson <[email protected]> * Use newest common types to align with rest of Azure (Azure#16130) * Use newest common types to align with rest of Azure * Use ErrorResponse instead of CloudError in operations Co-authored-by: Anat Gilenson <[email protected]> * Add AlertRules Stable version to 2021-10-01 (Azure#16268) * Add AlertRules Stable version to 2021-10-01 * Fix missing alignment in common types * prettier fixes * move tactics and severity to common * fix common types file extension * more prettier fixes * Add template version field * prettier * added version to required fields * dummy change to trigger checks again * Add onboarding states to new stable version (Azure#16290) * Add onboarding states to new stable version * Update readme.md * cr fix - remove unused params * Add missing resources 2021 10 01 (Azure#16666) * Add missing resources and examples from 2020-01-01 * Update version in added resources and examples * Use existing common types * Remove unnesessary SecurityInsights.json * Update readme * Use sentinel common types in Incidents and Watchlist * Extract and common IncidentInfo and IncidentSeverity * Extract EntityTypes * Correct double allOf in EntityTypes * update readme * Remove eventGroupingSettings and entityMappings from GetAlertRuleTemplateById example. * rename operations.json Co-authored-by: Anat Gilenson <[email protected]> * Fix analytics templates model (Azure#16689) * add missing properties to scheduled template * prettier fixes * restore templates example after merge * fix templates example after merge and run prettier * Use CloudError instead of ErrorResponse to align with preview versions and our back-end. (Azure#17472) * Automation - Stable Version (Azure#17491) * First * readMe * cloudError * CloudError * schema * prettier * Fix * test * fix identifier * fix description * fix lable * fix lable * ownerInfo * Fix * types * conditionMaxLength Co-authored-by: Roy Reinhorn <[email protected]> * Done (Azure#17728) Co-authored-by: Roy Reinhorn <[email protected]> * Correct 2021 10 01 (Azure#17830) * Remove OperationalInsightsResourceProvider parameter in ThreatIntelligence * Remove OperationalInsightProviderParameter from Watchlist * Align stable operation names with preview * Add missing disciminator property in ThreatIntelligence * Done (Azure#17844) Co-authored-by: Roy Reinhorn <[email protected]> * Align enum names with preview (Azure#17831) * Fix 2021 10 01 validation errors (Azure#17937) * Add x-ms-identifiers to all arrays * Add operations_list example * Add x-ms-identifier in all arrays * Run prettier * Fix spelling error * Add isDataAction to operation schema (Azure#18018) Co-authored-by: Anat Gilenson <[email protected]> Co-authored-by: laithhisham <[email protected]> Co-authored-by: royrein <[email protected]> Co-authored-by: Roy Reinhorn <[email protected]> Co-authored-by: Arthur Ning <[email protected]>

sima-zhu added 2 commits November 20, 2020 08:58

Move to common eng docindex folder

7843c33

Merge branch 'master' of https://github.com/Azure/azure-sdk-for-java …

e317455

…into test_doc_index

sima-zhu requested review from danieljurek, JimSuplizio, mitchdenny and weshaggard as code owners November 20, 2020 17:06

sima-zhu added 3 commits November 20, 2020 09:27

Added some comments

2c95b4d

Remove the global var

85b5cde

More changes to yml

ad91c51

weshaggard reviewed Nov 20, 2020

View reviewed changes

eng/scripts/Language-Settings.ps1 Outdated Show resolved Hide resolved

weshaggard reviewed Nov 20, 2020

View reviewed changes

Added name and email info

39debc4

weshaggard reviewed Nov 20, 2020

View reviewed changes

sima-zhu added 3 commits November 20, 2020 11:48

new changes

af42ec8

force git checkout

577cd6a

change fucntion nme

612de9e

weshaggard reviewed Nov 20, 2020

View reviewed changes

testing on new params

00bbbc6

sima-zhu closed this Dec 2, 2020

sima-zhu deleted the test_doc_index branch December 2, 2020 17:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Move to eng/common docindex reference #17728

Move to eng/common docindex reference #17728

sima-zhu commented Nov 20, 2020 •

edited

Loading

weshaggard Nov 20, 2020

sima-zhu Nov 20, 2020

weshaggard Nov 20, 2020

sima-zhu Nov 20, 2020

weshaggard Nov 20, 2020

sima-zhu Nov 20, 2020

weshaggard Nov 20, 2020

sima-zhu Nov 20, 2020

weshaggard Nov 20, 2020

weshaggard Nov 20, 2020

sima-zhu Nov 20, 2020

weshaggard Nov 20, 2020

sima-zhu commented Dec 2, 2020

Move to eng/common docindex reference #17728

Move to eng/common docindex reference #17728

Conversation

sima-zhu commented Nov 20, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sima-zhu commented Dec 2, 2020

sima-zhu commented Nov 20, 2020 •

edited

Loading