Fix typo and language around Github auth (#227)

Author: findjigar

website/docs/DEFAULT_GITHUB_FLOW.md

@@ -3,7 +3,7 @@ sidebar_position: 3
 title: Default GitHub Workflow
 ---
 
-# Default GitHub Flow
+# Default GitHub Workflow
 
 If you are hosting your repos in GitHub and can use GitHub Actions for CI, the Default GitHub Flow is the simplest way to start publishing Kotlin builds for iOS.
 
@@ -100,6 +100,8 @@ Note: this config is only for SPM publishing. To understand how to integrate an
 
 `cocoapods("[some git repo].git")` is only needed if you plan to publish for CocoaPods. You will need the spec repo mentioned above, properly configured for deployment. See  [COCOAPODS_GITHUB_PODSPEC](cocoapods/03_COCOAPODS_GITHUB_PODSPEC.md) for details on getting the podspec repo configured.
 
+> Be sure to save the deploy key created for later use.
+
 `versionPrefix` is optional. By default, KMMBridge takes the version from Gradle and uses that as a prefix to generate the iOS published versions. Versioning strategy differs depending on how you intend to work and publish. See [Version Managers](general/CONFIGURATION_OVERVIEW#version-managers) for more detail.
 
 
@@ -132,7 +134,7 @@ jobs:
       PODSPEC_SSH_KEY: ${{ secrets.PODSPEC_SSH_KEY }}
 ```
 
-You need to pass the ssh key configured earlier.
+You need to pass the ssh key configured earlier. See [Create Deploy Keys](cocoapods/COCOAPODS_GITHUB_PODSPEC/#create-deploy-keys)
 
 There are actually 2 versions of the workflow script. The other file, `faktorybuild.yml`, performs all operations in the same branch it's run on. `faktorybuildbranches.yml` creates a temporary branch to run builds. This is generally better, as the build process involves git operations which can overwrite files and possibly cause conflicts.
 
@@ -152,11 +154,7 @@ When that run is complete, you should see a green result. If not, please reach o
 
 ## iOS Dev Machine Config
 
-If you're using the github packages for artifact hosting via `addGithubPackagesRepository()`, accessing the artifacts requires authentication even for public repos. You'll need to tell the local machine how to access the private file. You can do this either by editing the `~/.netrc` file, or by adding the info to your local keychain.
-
-:::note
-These steps are needed for any private artifact hosting, but won't be necessary if your artifacts are hosted somewhere publicly accessible.
-:::
+If you're using the github packages for artifact hosting via `addGithubPackagesRepository()`, accessing the artifacts requires authentication. You can do this either by editing the `~/.netrc` file, or by adding the info to your local keychain.
 
 First, get a personal access token from GitHub. Make sure it has at least `repo` and `write:packages` permissions. You can add an expiration, but if you do, you'll need to remember to create a new one later...
 

website/docs/IOS_DEV_SETUP.md

@@ -11,7 +11,7 @@ For developers editing Kotlin, you will want to test locally-built Kotlin code d
 
 ## Private Artifacts
 
-If you are hosting artifacts somewhere private, you'll need to add auth info for that to work. See [the section here](DEFAULT_GITHUB_FLOW.md#private-repos).
+If you are hosting artifacts somewhere private, you'll need to add auth info for that to work. See [the section here](DEFAULT_GITHUB_FLOW.md#ios-dev-machine-config).
 
 *You must do this before attempting to integrate dependency managers!!!*
 

website/docs/artifacts/MAVEN_REPO_ARTIFACTS.md

@@ -20,7 +20,7 @@ Each repo type has it's own unique setup, but essentially we need:
 2. A username that can publish to the repo
 3. A password/token for that user
 
-See specific guidance for Github Packages, JetBrains Space, and Artifactory.
+See specific guidance for [Github Packages](#github-packages), [JetBrains Space](SPACE_ARTIFACTS.md), and [Artifactory](ARTIFACTORY_ARTIFACTS.md).
 
 The standard Gradle publishing config looks like the following.
 
@@ -86,7 +86,7 @@ For different repos you'll need to change the machine to point at the server whe
 
 The Maven publishing adds a special artifact to the "standard" Gradle publishing config, specically for KMMBridge. We're publishing the Xcode Framework XCFramework zip file as it's own Gradle/Maven artifact. If you run `./gradlew publish`, it'll attempt to publish KMMBridge along with any other configured publish targets.
 
-If you do intend to publish everything, you'll likely want to disable the automatically incrementing verison support that KMMBridge provides, and use the standard Gradle publishing version management.
+If you do intend to publish everything, you'll likely want to disable the automatically incrementing version support that KMMBridge provides, and use the standard Gradle publishing version management.
 
 If you want to use the version from Gradle, use the following configuration:
 

website/docs/cocoapods/01_IOS_COCOAPODS.md

@@ -4,7 +4,7 @@ You'll need an Xcode project with CocoaPods set up. That means you'll have a `Po
 
 ## Artifact Authentication
 
-For artifacts that are kept in private storage, you may need to add authentication information so your `~/.netrc` file or your Mac's Keychain Access. See [the section here](../DEFAULT_GITHUB_FLOW.md#private-repos) for a description of how to set up private file access.
+For artifacts that are kept in private storage, you may need to add authentication information so your `~/.netrc` file or your Mac's Keychain Access. See [the section here](../DEFAULT_GITHUB_FLOW.md#ios-dev-machine-config) for a description of how to set up private file access.
 
 ## Add Podspec Repo
 

website/docs/general/CONFIGURATION_OVERVIEW.md

@@ -30,7 +30,7 @@ Artifact Managers handle uploading the binary and generate the url that will be
 
 ### [Maven Repository Artifacts](../artifacts/MAVEN_REPO_ARTIFACTS)
 
-This is the simplest to configure and currently the recommended best way to publish your binaries. If you are using GitHub, you can publish to Github Packages easily with our integration tools. For a complete introduction and overview of how to configure your project with this manager, see [Default GitHub Flow](../DEFAULT_GITHUB_FLOW.md).
+This is the simplest to configure and currently the recommended best way to publish your binaries. If you are using GitHub, you can publish to Github Packages easily with our integration tools. For a complete introduction and overview of how to configure your project with this manager, see [Default GitHub WorkFlow](../DEFAULT_GITHUB_FLOW.md).
 
 ### [S3 Public Artifacts](../artifacts/S3_PUBLIC_ARTIFACTS.md)
 

website/docs/index.md

@@ -24,7 +24,7 @@ link="https://form.typeform.com/to/MJTpmm#hubspot_utk=xxxxx&hubspot_page_name=xx
 
 If you are using GitHub for source control, and are OK with using GitHub Actions to build and GitHub releases for published artifacts, we have a simple setup flow you can use. It is the easiest default to start from.
 
-See [DEFAULT_GITHUB_FLOW](DEFAULT_GITHUB_FLOW.md) for setup instructions.
+See [DEFAULT_GITHUB_WORKFLOW](DEFAULT_GITHUB_FLOW.md) for setup instructions.
 
 ## KMMBridge Kick Start
 

website/docs/spm/01_IOS_SPM.md

@@ -106,11 +106,9 @@ targets.withType<KotlinNativeTarget> {
 }
 ```
 
-You can check out [build.gradle in this test](https://github.com/touchlab/KmmBridgeIntegrationTest-SPMWithoutCommit/blob/main/shared/build.gradle.kts) as an example.
-
 ## Artifact Authentication
 
-For artifacts that are kept in private storage, you may need to add authentication information so your `~/.netrc` file or your Mac's Keychain Access. See [the section here](../DEFAULT_GITHUB_FLOW.md#private-repos) for a description of how to set up private file access.
+For artifacts that are kept in private storage, you may need to add authentication information so your `~/.netrc` file or your Mac's Keychain Access. See [the section here](../DEFAULT_GITHUB_FLOW.md#ios-dev-machine-config) for a description of how to set up private file access.
 
 :::caution