Skip to content

Commit e224a4d

Browse files
DonnerbartDonnerbart
committed
Fix broken documentation links
Signed-off-by: David Sondermann <david.sondermann@hivemq.com>
1 parent cf6c505 commit e224a4d

File tree

3 files changed

+40
-35
lines changed

3 files changed

+40
-35
lines changed

‎frontend/src/components/page/Footer.tsx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -76,19 +76,19 @@ const Footer: React.FC<FooterProps> = ({ history, visible, ...props }) => (
7676
<h4 className="oh-footer__contents-right__links__list__header">NETWORK</h4>
7777
<ExternalLink
7878
className="oh-footer__contents-right__links__list__link"
79-
href={documentationLinks.hubTwitter}
80-
text="Twitter"
79+
href={documentationLinks.socialHubX}
80+
text="X (Twitter)"
8181

8282
/>
8383
<ExternalLink
8484
className="oh-footer__contents-right__links__list__link"
85-
href={documentationLinks.hubYoutube}
85+
href={documentationLinks.socialHubYoutube}
8686
text="YouTube"
8787

8888
/>
8989
<ExternalLink
9090
className="oh-footer__contents-right__links__list__link"
91-
href={documentationLinks.operatorsFramework}
91+
href={documentationLinks.operatorsFrameworkRepo}
9292
text="GitHub"
9393

9494
/>
@@ -100,7 +100,7 @@ const Footer: React.FC<FooterProps> = ({ history, visible, ...props }) => (
100100
/>
101101
<ExternalLink
102102
className="oh-footer__contents-right__links__list__link"
103-
href={documentationLinks.kubernetesSlack}
103+
href={documentationLinks.socialKubernetesSlack}
104104
text="Join us on Slack"
105105

106106
/>

‎frontend/src/pages/documentation/GettingStarted.tsx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { ExternalLink } from '../../components/ExternalLink';
55
import DocumentationPage from '../../components/page/DocumentationPage';
66
// @ts-ignore
77
import maturityDetailsImg from '../../imgs/capability-level-diagram.svg';
8-
import { operatorSdk, gettingStarted, operatorsFramework } from '../../utils/documentationLinks';
8+
import { operatorSdk, gettingStarted, operatorsFrameworkRepo } from '../../utils/documentationLinks';
99
import { InternalLink } from '../../components/InternalLink';
1010
import { History } from 'history';
1111

@@ -116,7 +116,7 @@ const GettingStarted: React.FC<GettingStartedPageProps> = ({ history, ...props }
116116
</p>
117117
<p>
118118
Fortunately there is the <ExternalLink href={operatorSdk} text="operator-sdk" />, part of
119-
the <ExternalLink href={operatorsFramework} text="Operator Framework" />, a community project that
119+
the <ExternalLink href={operatorsFrameworkRepo} text="Operator Framework" />, a community project that
120120
aims at simplifying the whole process of Operator creation to just writing the custom operational logic
121121
inside the control loop.
122122
</p>

‎frontend/src/utils/documentationLinks.ts

Lines changed: 33 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,42 @@
1-
export const operatorsFramework = 'https://github.com/k8s-operatorhub';
2-
export const operatorsRepo = `${operatorsFramework}/community-operators`;
1+
export const gettingStarted = `https://operatorframework.io`;
2+
export const sdkQuickstartBundle = `https://sdk.operatorframework.io/docs/olm-integration/quickstart-bundle/`;
3+
export const manageOperatorWithOlm = `https://olm.operatorframework.io`;
4+
export const introBlog = `https://www.redhat.com/en/blog/introducing-operators-putting-operational-knowledge-into-software`;
5+
export const privacyPolicy = `https://www.redhat.com/en/about/privacy-policy`;
6+
export const semanticVersioning = `https://semver.org/`;
7+
export const socialHubX = `https://x.com/operatorhubio`;
8+
export const socialHubYoutube = 'https://www.youtube.com/watch?v=yzPvPJLxCl8&list=PLaR6Rq6Z4Iqcuu758T4YX6KRa1158v3Rb';
9+
export const socialKubernetesSlack = `https://kubernetes.slack.com/messages/kubernetes-operators`;
10+
311
export const operatorsDocumentation = `https://k8s-operatorhub.github.io/community-operators`
4-
export const contributions = `${operatorsRepo}/tree/main/operators`;
12+
export const operatorsRepo = `https://github.com/k8s-operatorhub/community-operators`;
13+
export const operatorsFrameworkRepo = 'https://github.com/operator-framework';
14+
515
export const operatorsRepoBeforePR = `${operatorsDocumentation}/contributing-prerequisites`;
616
export const operatorsRepoRequirements = `${operatorsDocumentation}/packaging-operator`;
7-
export const operatorSdk = `${operatorsFramework}/operator-sdk`;
8-
export const sdkQuickstartBundle = `https://sdk.operatorframework.io/docs/olm-integration/quickstart-bundle/`;
9-
export const operatorCourier = `${operatorsFramework}/operator-courier`;
10-
export const operatorScorecard = `${operatorSdk}/blob/master/doc/test-framework/scorecard.md`;
11-
export const operatorBundle = `${operatorsRepo}#adding-your-operator`;
12-
export const olm = `${operatorsFramework}/operator-lifecycle-manager`;
13-
export const gettingStarted = `https://operatorframework.io`;
14-
export const operatorRegistry = `${operatorsFramework}/operator-registry`;
15-
export const bundleAnnotations = `${operatorsFramework}/operator-registry/blob/master/docs/design/operator-bundle.md#bundle-annotations`;
16-
export const bundleDockerfile = `${operatorsFramework}/operator-registry/blob/master/docs/design/operator-bundle.md#bundle-dockerfile`;
17+
export const operatorBundle = `${operatorsDocumentation}#add-your-operator`;
1718
export const manualTestingOnKubernetes = `${operatorsDocumentation}/operator-test-suite`;
1819
export const operatorMetadataValidation = `${operatorsDocumentation}/testing-operators`;
19-
export const prometheusOperator = `${contributions}/prometheus`;
20-
export const prometheusOperatorVersion = `${contributions}/prometheus/0.22.2`;
21-
export const olmArchitecture = `${olm}/blob/master/doc/design/architecture.md`;
2220
export const buildYourCSV = `${operatorsDocumentation}/packaging-operator`;
2321
export const createPackageManifest = `${operatorsDocumentation}/packaging-operator`;
24-
export const semanticVersioning = `https://semver.org/`;
25-
export const createBundle = `${operatorsRepo}/blob/master/docs/contributing.md#create-a-release-using-the-bundle-format`;
26-
export const packagemanifestToBundle = `${operatorsDocumentation}/packaging-operator`;
27-
export const discoveryCatalogs = `${olm}#discovery-catalogs-and-automated-upgrades`;
28-
export const introBlog = `https://web.archive.org/web/20170129131616/https://coreos.com/blog/introducing-operators.html`;
29-
export const sampleCode = `${operatorsFramework}/operator-sdk/blob/master/testdata/go/v3/memcached-operator/controllers/memcached_controller.go#L51-L137`;
22+
export const createBundle = `${operatorsDocumentation}/packaging-operator/#package-your-operator`;
23+
export const packagemanifestToBundle = `${operatorsDocumentation}/packaging-operator/#moving-from-packagemanifest-to-bundle-format`;
24+
25+
export const contributions = `${operatorsRepo}/tree/main/operators`;
26+
export const fileAnIssue = `${operatorsRepo}/issues`;
27+
28+
export const operatorCourier = `${operatorsFrameworkRepo}/operator-courier`;
29+
30+
export const operatorRegistry = `${operatorsFrameworkRepo}/operator-registry`;
31+
export const bundleAnnotations = `${operatorRegistry}/blob/master/docs/design/operator-bundle.md#bundle-annotations`;
32+
export const bundleDockerfile = `${operatorRegistry}/blob/master/docs/design/operator-bundle.md#bundle-dockerfile`;
33+
34+
export const operatorSdk = `${operatorsFrameworkRepo}/operator-sdk`;
35+
export const operatorScorecard = `${operatorSdk}/blob/master/doc/test-framework/scorecard.md`;
3036
export const capabilityLevelModelDiagram = `${operatorSdk}/blob/master/doc/images/operator-capability-level.png`;
31-
export const manageOperatorWithOlm = `https://olm.operatorframework.io`;
37+
export const sampleCode = `${operatorSdk}/tree/master/testdata/go/v4/memcached-operator/internal/controller/memcached_controller.go#L81-L283`;
38+
39+
export const olm = `${operatorsFrameworkRepo}/operator-lifecycle-manager`;
40+
export const olmArchitecture = `${olm}/blob/master/doc/design/architecture.md`;
3241
export const operatorGroupDesign = `${olm}/blob/master/doc/design/architecture.md#operator-group-design`;
33-
export const privacyPolicy = `https://www.redhat.com/en/about/privacy-policy`;
34-
export const kubernetesSlack = `https://kubernetes.slack.com/messages/kubernetes-operators`;
35-
export const hubTwitter = `https://twitter.com/operatorhubio`;
36-
export const hubYoutube = 'https://www.youtube.com/watch?v=yzPvPJLxCl8&list=PLaR6Rq6Z4Iqcuu758T4YX6KRa1158v3Rb';
37-
export const fileAnIssue = `${operatorsRepo}/issues`;
42+
export const discoveryCatalogs = `${olm}#discovery-catalogs-and-automated-upgrades`;

0 commit comments

Comments
 (0)