Skip to content

Update information #1070

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

Merged
Netyyyy merged 3 commits into from
Dec 27, 2024
Merged

Update information #1070

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdc593e
update information
Netyyyy Dec 27, 2024
25f5f67
Update spring-cloud-azure-markdown-appdendix-generator/src/main/java/…
Netyyyy Dec 27, 2024
48f3aca
update comment
Netyyyy Dec 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 47 additions & 3 deletions ...zure-markdown-appdendix-generator/src/main/java/com/azure/spring/cloud/internal/Main.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,40 @@ private int getMaxLength(Stream<String> stringStream) {
return stringStream.map(String::trim).mapToInt(String::length).max().orElse(0);
}

/**
* To reduce variance, use the same description width as the current document.
*/
private int getDescriptionColumnWidth(String outputFile, Stream<String> stringStream) {
Map<String, Integer> DES_WIDTH = new HashMap<>();
DES_WIDTH.put("configuration-properties-azure-active-directory.md", 641);
DES_WIDTH.put("configuration-properties-azure-active-directory-b2c.md", 470);
DES_WIDTH.put("configuration-properties-azure-service-bus.md", 194);
DES_WIDTH.put("configuration-properties-azure-service-bus-jms.md", 446);
return DES_WIDTH.getOrDefault(outputFile.substring(outputFile.lastIndexOf("/") + 1),
getMaxLength(stringStream));
}

private String getServiceName(String outputFile) {
HashMap<String, String> DES_WIDTH = new HashMap<>();
DES_WIDTH.put("configuration-properties-all.md", "Spring Cloud Azure");
DES_WIDTH.put("configuration-properties-azure-active-directory.md", "Microsoft Entra");
DES_WIDTH.put("configuration-properties-azure-active-directory-b2c.md", "Azure Active Directory B2C");
DES_WIDTH.put("configuration-properties-azure-app-configuration.md", "Azure App Configuration");
DES_WIDTH.put("configuration-properties-azure-cosmos-db.md", "Azure Cosmos DB");
DES_WIDTH.put("configuration-properties-azure-event-hubs.md", "Azure Event Hubs");
DES_WIDTH.put("configuration-properties-azure-key-vault.md", "Azure Key Vault");
DES_WIDTH.put("configuration-properties-azure-key-vault-certificates.md", "Azure Key Vault Certificates");
DES_WIDTH.put("configuration-properties-azure-key-vault-secrets.md", "Azure Key Vault Secrets");
DES_WIDTH.put("configuration-properties-azure-service-bus.md", "Azure Service Bus");
DES_WIDTH.put("configuration-properties-azure-service-bus-jms.md", "Azure Service Bus JMS");
DES_WIDTH.put("configuration-properties-azure-storage.md", "Azure Storage");
DES_WIDTH.put("configuration-properties-azure-storage-blob.md", "Azure Storage Blob");
DES_WIDTH.put("configuration-properties-azure-storage-file-share.md", "Azure Storage File Share");
DES_WIDTH.put("configuration-properties-azure-storage-queue.md", "Azure Storage Queue");
DES_WIDTH.put("configuration-properties-global.md", "Spring Cloud Azure Global");
return DES_WIDTH.getOrDefault(outputFile.substring(outputFile.lastIndexOf("/") + 1), null);
}

/**
* Generate properties markdown files.
* @param outputFile the output file
Expand All @@ -289,21 +323,31 @@ private int getMaxLength(Stream<String> stringStream) {
*/
private void generatePropertiesFile(String outputFile, TreeMap<String, String> descriptions, String date) {
int nameColumnWidth = getMaxLength(descriptions.keySet().stream());
int descriptionColumnWidth = getMaxLength(descriptions.values().stream());
int descriptionColumnWidth = getDescriptionColumnWidth(outputFile, descriptions.values().stream());
Path path = Paths.get(outputFile);
String serviceName = getServiceName(outputFile);
try (BufferedWriter writer = Files.newBufferedWriter(path, StandardCharsets.UTF_8)) {
writer.write("---");
writer.newLine();
writer.write(String.format("title: %s configuration properties", serviceName));
writer.newLine();
writer.write(String.format("description: This reference doc contains all %s configuration properties.",
serviceName));
writer.newLine();
writer.write("author: KarlErickson");
writer.newLine();
writer.write("ms.author: v-yonghuiye");
writer.write("ms.author: hangwan");
writer.newLine();
writer.write("ms.date: " + date);
writer.newLine();
writer.write("ms.topic: reference");
writer.newLine();
writer.write("ms.custom: devx-track-java, spring-cloud-azure, devx-track-extended-java");
writer.newLine();
writer.write("---");
writer.newLine();
writer.newLine();
writer.write("## " + generateTitleName(outputFile) + " properties");
writer.write(String.format("# %s configuration properties", serviceName));
writer.newLine();
writer.newLine();
writer.write("> [!div class=\"mx-tdBreakAll\"]");
Expand Down