Skip to content

Replace community doc URLs and project names (Storage, Networking, Upgrades)#80

Merged
jillian-maroket merged 7 commits into
rancher:mainfrom
jillian-maroket:links-productdocs3
Jun 17, 2025
Merged

Replace community doc URLs and project names (Storage, Networking, Upgrades)#80
jillian-maroket merged 7 commits into
rancher:mainfrom
jillian-maroket:links-productdocs3

Conversation

@jillian-maroket

@jillian-maroket jillian-maroket commented Jun 12, 2025

Copy link
Copy Markdown
Contributor

Related issue: #77

Scope: v1.3, v1.4, v1.5, v1.6

  • networking/best-practices.adoc
  • storage/longhorn-v2-data-engine.adoc
  • storage/storageclass.adoc
  • storage/volumes/edit-volume.adoc
  • storage/longhorn-v2-data-engine.adoc
  • upgrades/troubleshooting.adoc
  • upgrades/upgrades.adoc

Changes:

  • Replace community doc URLs with product doc URLs
  • Replace community project names with product name variables
  • Standardize capitalization of component names (Note: Component names that include "Harvester" and "Longhorn" will not be rebranded for now. I need more guidance from the PM group.)

Signed-off-by: Jillian <jillian.maroket@suse.com>
Signed-off-by: Jillian <jillian.maroket@suse.com>
Signed-off-by: Jillian <jillian.maroket@suse.com>
…ices file

Signed-off-by: Jillian <jillian.maroket@suse.com>
@jillian-maroket jillian-maroket self-assigned this Jun 12, 2025
@jillian-maroket jillian-maroket requested a review from a team as a code owner June 12, 2025 08:00
Signed-off-by: Jillian <jillian.maroket@suse.com>
Signed-off-by: Jillian <jillian.maroket@suse.com>
image::storageclass/create_storageclasses_migratable.png[]

=== Customize Tab
**Allow Volume Expansion**

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Is this intentional? Seems this part should be a Reclaim Policy?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@pmkovar Thanks for reviewing and for catching that error. I don't know what caused it. This is old content that I have not touched since joining the company.

Instead of just fixing this error, I decided to restructure the section altogether to address issues that I had flagged in a previous audit. I'll apply the same changes to the community doc later on.

@jhkrug jhkrug left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

One tiny observation.

I'm approving as the PR seems to mainly be about parameterization, which is great.

[NOTE]
====
{harvester-product-name} sets the https://longhorn.io/docs/1.7.2/v2-data-engine/features/node-disk-support/[Longhorn disk driver] to `auto` so that NVMe disks use the SPDK NVMe bdev driver, which provides the best performance and also supports advanced operations such as trim (also known as discard).
{harvester-product-name} sets the https://documentation.suse.com/cloudnative/storage/1.8.0/en/longhorn-system/v2-data-engine/features/node-disk-support.html[Longhorn Disk Driver] to `auto` so that NVMe disks use the SPDK NVMe bdev driver, which provides the best performance and also supports advanced operations such as trim (also known as discard).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This caught my eye. This PR is mostly about parameterization, so maybe that 'Longhorn' in the []?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@jhkrug Thanks for reviewing. I have not rebranded Longhorn components anywhere in the doc. I'll do another round of parameterization PRs once I hear back from the PM group.

Signed-off-by: Jillian <jillian.maroket@suse.com>
@jillian-maroket jillian-maroket merged commit f706e7d into rancher:main Jun 17, 2025
2 checks passed
@jillian-maroket jillian-maroket deleted the links-productdocs3 branch June 20, 2025 09:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants