Skip to content

Conversation

@paigecalvert
Copy link
Contributor

@paigecalvert paigecalvert commented Oct 3, 2024

This PR removes the preexisting topic on "how to download air gap bundles" in favor of putting that info directly in the relevant air gap installation topics. The reasoning for this change is because:

  • People are most likely to need information on how to download air gap bundles when they are actually trying to do an air gap install
  • When looking for info on how to download air gap bundles, people will need info about one or two types of bundles in particular, and don't need to see info about all the different air gap bundles. This can cause confusion
  • If you landed on the topic about downloading air gap bundles, you'd be missing a lot of context and likely get confused about what you are supposed to do with the information

The solution was to do the following:

@replicated-ci replicated-ci added type::docs Improvements or additions to documentation type::feature labels Oct 3, 2024
@netlify
Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for replicated-docs-upgrade ready!

Name Link
🔨 Latest commit eaa623c
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs-upgrade/deploys/67080b56d348ff0008e4d8a0
😎 Deploy Preview https://deploy-preview-2721--replicated-docs-upgrade.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@netlify
Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for replicated-docs ready!

Name Link
🔨 Latest commit eaa623c
🔍 Latest deploy log https://app.netlify.com/sites/replicated-docs/deploys/67080b56d990630008d0ea08
😎 Deploy Preview https://deploy-preview-2721--replicated-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@paigecalvert paigecalvert marked this pull request as ready for review October 4, 2024 19:59
@paigecalvert paigecalvert requested a review from a team as a code owner October 4, 2024 19:59

[View a larger version of this image](/images/release-history-link.png)

1. On the **Release history** page, click **Build** to build the `.airgap` bundle.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ Previously, I was leaning pretty heavily on ".airgap" to talk about the release air gap bundle as opposed to the Admin Console or kURL bundles. Now that the EC bundle also uses the .airgap extension, felt like it would be better to spell out which bundle we are talking about in each case

@paigecalvert paigecalvert requested a review from ajp-io October 4, 2024 20:09
@paigecalvert
Copy link
Contributor Author

Note from convo with Alex this morning:

  • We are going to remove this topic all together in favor of putting the info directly in the air gap installation topics. For example, the info about how to download the air gap bundle for the release will appear as a partial in the existing cluster KOTS and kURL air gap install topics.
  • We also discussed making this information an actual step in the procedure rather than a prereq. This gives more space to provide screenshots/additional info, and makes it harder to miss
  • The reasoning for this decision is that it can be overwhelming to see all the air gap bundle info together on a single topic. And, it's most likely that the only time people need this info is when they are actually getting ready to do an air gap install

@paigecalvert paigecalvert changed the title Add Embedded Cluster info to air gap bundle topic Move air gap bundle info to the relevant install topics Oct 10, 2024
'vendor/releases-share-download-portal',
'vendor/releases-configvalues',
],
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

^ removed this section.

  • releases-download-airgap-bundles was deleted
  • licenses-download was moved to the Customer Licenses section
  • releases-share-download-portal was moved to the Channels and Releases section
  • releases-configvalues was moved to the CLI install section (the only workflow where vendors need it)

@paigecalvert paigecalvert merged commit fc02e3f into main Oct 10, 2024
5 checks passed
@paigecalvert paigecalvert deleted the 113400 branch October 10, 2024 17:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

type::docs Improvements or additions to documentation type::feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants