Fix typo in publicly available docs about manifest branch #2332
Conversation
adamency
requested review from
fedepaol,
russellb,
gclawes and
oribon
as code owners
adamency
force-pushed
the
patch-1
branch
2 times, most recently
from
8ee8fbe
to
a604e4f
Compare
|
Added DCO |
|
Hi @adamency, It looks like you still don't pass the DCO check, please see: |
The branch published on the website is actually v0.14 but `_index.md` is using the same text as in the `main` branch misleading warning against using the displayed manifests. Signed-off-by: Benjamin Habié <adamency+github@protonmail.com>
|
@cyclinder My apologies, the DCO is correctly passing now :) |
| @@ -75,7 +75,7 @@ If you want to deploy MetalLB using the [experimental FRR-K8s mode]({{% relref " | |||
| kubectl apply -f https://raw.githubusercontent.com/metallb/metallb/v0.14.3/config/manifests/metallb-frr-k8s.yaml | |||
| ``` | |||
|
|
|||
| Please do note that these manifests deploy MetalLB from the main development branch. We highly encourage cloud operators to deploy a stable released version of MetalLB on production environments! | |||
| These manifests deploy MetalLB from a release branch. Indeed, we highly encourage cloud operators to deploy a stable released version of MetalLB (instead of manifests from the main branch) on production environments! | |||
There was a problem hiding this comment.
Sorry I finally got here. I think the right approach is just to remove this part as a whole, and it should be reomved from the main branch as it is the master where we generate all the versioned release notes using this script
Line 707 in 25f1bbc
There was a problem hiding this comment.
Hi @fedepaol, so do you mean to remove the line 78 entirely ?
There was a problem hiding this comment.
Yep, as it sounds like a legacy bit from where we were not replacing main with the right tag after a release.
|
This PR has been automatically marked as stale because it has been open 30 days
|
The branch published on the website is actually v0.14 but
_index.mdis using the same text as in themainbranch misleading warning against using the displayed manifests.Is this a BUG FIX or a FEATURE ?:
/kind documentation
What this PR does / why we need it:
The branch published on the website is actually v0.14 but
_index.mdis using the same text as in themainbranch misleading warning against using the displayed manifests.Special notes for your reviewer:
Release note: