feat: New API reference docs index page (#2021)

Co-authored-by: Sichan Yoo <[email protected]>

Author: sichanyoo

AWSSDKSwiftCLI/Sources/AWSCLIUtils/FileManager+Utils.swift

@@ -68,6 +68,7 @@ public extension FileManager {
             .contentsOfDirectory(atPath: "Sources/Core")
             .sorted()
             .filter { $0 != "AWSSDKForSwift" } // Ignore documentation module
+            .filter { $0 != "SDKForSwift" } // Ignore new documentation module
             .filter { !$0.hasPrefix(".") }
     }
 

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Commands/AWSSDKSwiftCLI/Subcommands/GenerateDocIndex.swift

@@ -23,11 +23,26 @@ struct GenerateDocIndexCommand: ParsableCommand {
     func run() throws {
         try FileManager.default.changeWorkingDirectory(repoPath)
         let contents = try generateDocIndexContents()
-        try saveDocIndex(contents)
+        let docIndexFileName = "Sources/Core/AWSSDKForSwift/Documentation.docc/AWSSDKForSwift.md"
+        try saveDocIndex(contents, docIndexFileName)
+        // New doc index page for internal build hosted docs.
+        let newDocIndexFileName = "Sources/Core/SDKForSwift/Documentation.docc/SDKForSwift.md"
+        try saveDocIndex(convertToNewFormat(contents), newDocIndexFileName)
     }
 
     // MARK: - Helpers
 
+    /// Converts old format relative links to new format
+    func convertToNewFormat(_ content: String) -> String {
+        return content.replacingOccurrences(
+            of: "../../../../../swift/api/",
+            with: "../../../../../sdk-for-swift/latest/api/"
+        ).replacingOccurrences(
+            of: "/latest)",
+            with: ")"
+        )
+    }
+
     /// Returns the contents of the generated doc index.
     /// This determines the versions of the dependencies and the list of services to include and then generates the doc index with those values.
     ///
@@ -50,15 +65,14 @@ struct GenerateDocIndexCommand: ParsableCommand {
     /// If no file exists, then this will create a new file. Otherwise, this will overwrite the existing file.
     ///
     /// - Parameter contents: The contents of the doc index.
-    func saveDocIndex(_ contents: String) throws {
-        let docIndexFileName = "Sources/Core/AWSSDKForSwift/Documentation.docc/AWSSDKForSwift.md"
-        log("Saving doc index to \(docIndexFileName)...")
+    func saveDocIndex(_ contents: String, _ destination: String) throws {
+        log("Saving doc index to \(destination)...")
         try contents.write(
-            toFile: docIndexFileName,
+            toFile: destination,
             atomically: true,
             encoding: .utf8
         )
-        log("Successfully saved doc index to \(docIndexFileName)")
+        log("Successfully saved doc index to \(destination)")
     }
 
     /// Returns the list of services to include in the doc index.

AWSSDKSwiftCLI/Sources/AWSSDKSwiftCLI/Resources/Package.Base.txt

@@ -116,6 +116,11 @@ private var runtimeTargets: [Target] {
             path: "Sources/Core/AWSSDKForSwift",
             exclude: ["Documentation.docc/AWSSDKForSwift.md"]
         ),
+        .target(
+            name: "SDKForSwift",
+            path: "Sources/Core/SDKForSwift",
+            exclude: ["Documentation.docc/SDKForSwift.md"]
+        ),
         .target(
             name: "AWSClientRuntime",
             dependencies: [

Package.swift

@@ -560,6 +560,11 @@ private var runtimeTargets: [Target] {
             path: "Sources/Core/AWSSDKForSwift",
             exclude: ["Documentation.docc/AWSSDKForSwift.md"]
         ),
+        .target(
+            name: "SDKForSwift",
+            path: "Sources/Core/SDKForSwift",
+            exclude: ["Documentation.docc/SDKForSwift.md"]
+        ),
         .target(
             name: "AWSClientRuntime",
             dependencies: [