[docs] Reorganize hugo doc site

[anik120]

Description of the change:

This PR reorganizes sdk.operatorframework.io to match the navigation
panel for olm.operatorframework.io, so that both the sites appear
to be part of one operator-framework family.

Motivation for the change:

Checklist

If the pull request includes user-facing changes, extra documentation is required:

• Add a new changelog fragment in changelog/fragments (see changelog/fragments/00-template.yaml)
• Add or update relevant sections of the docs website in website/content/en/docs

[camilamacedo86]

Hi @anik120,

really tks for the contribution. Ask we spoke in the slack. Could we not slit it by section to make the process work easy and fast? E.g ansible, golang an etc

Also, not that it is not passing in the CI. The changes performed here broke the links.

[jmrodri]

Heading font size is much smaller than before and doesn't seem to match the one used on OLM either.
The font from this PR:

The old SDK fonts were much larger:

The OLM fonts seem to be slightly larger compared to the one used in this PR:

[jmrodri]

Core Tasks seems odd to me.

It seems to fit on the OLM side because the steps seem the same. But the SDK has the different types of operators which have their own audiences and presumably a different set of "core tasks".

[jmrodri]

Also, I think Getting Started should be called Installation on both sites since both of the docs just describe how to install SDK or OLM:

• Getting started from PR: https://deploy-preview-3382--operator-sdk.netlify.app/docs/getting-started-/
• OLM Getting Started: https://olm.operatorframework.io/docs/getting-started/
• Installation from current SDK site: https://sdk.operatorframework.io/docs/install-operator-sdk/

[jmrodri]

My main issue is with the Core Tasks menu seems odd for the SDK. The heading font is different size than the one on the OLM site, and I don't like the "Getting Started" nav title since it's really "Installing or Installation" that is being described.

[jmrodri]

I think I know why Core Tasks and Advanced Tasks seem odd. I think it should be Core Topics and Advanced Topics because on the SDK side they really aren't "tasks" per se.

[camilamacedo86]

Hi @anik120,

It still not passing in the CI. We cannot merge without that.

Regards the sanity check

• You changed the CLI docs, however, they are generated automatically via the Makefile target make generate. So, you also need to change its scripts. See the CI issue in https://travis-ci.org/github/operator-framework/operator-sdk/jobs/708135863 and its script in ./hack/generate/cli-doc/gen-cli-doc.sh
• You also need to run make generate locally. Then, the docs should be generated in the new path.
• You can test it locally by running make test-sanity (note that all changes need to be committed because it will do a git diff at the end)

Regards the docs
It has a lot of broken links now. You need to fix the links ref in the docs. See: https://travis-ci.org/github/operator-framework/operator-sdk/jobs/708825906

[anik120]

@camilamacedo86 could you take a look now please. I've fixed most of it, there's a lot of external links that are broken. Not sure if I have to do anything about that in this PR.

[jmrodri]

tons of broken links because of all the churn happening in master with legacy being removed.

 * internally linking to docs/building-operators/golang/legacy/e2e-tests, which does not exist (line 1368) <a href="docs/building-operators/golang/legacy/e2e-tests">Writing E2E Tests</a> - /target/docs/building-operators/golang/legacy/e2e-tests/index.html * External link https://github.com/operator-framework/operator-sdk/blob/master/pkg/test/context.go failed: 404 No error * External link https://github.com/operator-framework/operator-sdk/blob/master/pkg/test/framework.go failed: 404 No error * External link https://github.com/operator-framework/operator-sdk/tree/master/pkg/test/e2eutil failed: 404 No error * internally linking to /docs/cli/legacy-cli/operator-sdk_test_local, which does not exist (line 1562) <a href="/docs/cli/legacy-cli/operator-sdk_test_local">SDK CLI Reference</a> - /target/docs/building-operators/golang/quickstart/index.html * External link https://v0-19-x.sdk.operatorframework.io/docs/building-operators/golang/legacy/quickstart/ failed: 404 No error - /target/docs/building-operators/helm/reference/watches/index.html * internally linking to /docs/helm/building-operators/reference/advanced_features/#passing-environment-variables-to-the-helm-chart, which does not exist (line 1363) <a href="/docs/helm/building-operators/reference/advanced_features/#passing-environment-variables-to-the-helm-chart">Using override values and passing environment variables to the Helm chart</a> * linking to internal hash #passing-environment-variables-to-the-helm-chart that does not exist (line 1363) <a href="/docs/helm/building-operators/reference/advanced_features/#passing-environment-variables-to-the-helm-chart">Using override values and passing environment variables to the Helm chart</a> - /target/docs/cli/operator-sdk_scorecard/index.html * internally linking to ../operator-sdk, which does not exist (line 1376) <a href="../operator-sdk">operator-sdk</a> - /target/docs/contribution-guidelines/release/index.html * internally linking to /docs/upgrade-sdk-version/backport-policy, which does not exist (line 1400) <a href="/docs/upgrade-sdk-version/backport-policy">backport policy</a> * internally linking to docs/installation/install-operator-sdk#prerequisites, which does not exist (line 1365) <a href="docs/installation/install-operator-sdk#prerequisites">prerequisites section</a> * internally linking to docs/installation/install-operator-sdk#prerequisites, which does not exist (line 1367) <a href="docs/installation/install-operator-sdk#prerequisites">prerequisites section</a> * internally linking to docs/installation/install-operator-sdk, which does not exist (line 1489) <a href="docs/installation/install-operator-sdk">installation guide.</a> * linking to internal hash #prerequisites that does not exist (line 1365) <a href="docs/installation/install-operator-sdk#prerequisites">prerequisites section</a> * linking to internal hash #prerequisites that does not exist (line 1367) <a href="docs/installation/install-operator-sdk#prerequisites">prerequisites section</a> - /target/docs/new-cli/operator-sdk_scorecard/index.html * internally linking to ../operator-sdk, which does not exist (line 1378) <a href="../operator-sdk">operator-sdk</a> - /target/docs/olm-integration/generating-a-csv/index.html * internally linking to /docs/advanced-topics/operator-capabilities/, which does not exist (line 1528) <a href="/docs/advanced-topics/operator-capabilities/">Operator maturity model</a> - /target/docs/overview/_overview/index.html * internally linking to /docs/advanced-topics/operator-capabilities/, which does not exist (line 1391) <a href="/docs/advanced-topics/operator-capabilities/">capability level documentation</a> * internally linking to /docs/faq/, which does not exist (line 1395) <a href="/docs/faq/">FAQ</a> - /target/docs/upgrading-sdk-version/v0.1.0-migration-guide/index.html * External link https://v0-19-x.sdk.operatorframework.io/docs/building-operators/golang/legacy/quickstart/#adding-3rd-party-resources-to-your-operator failed: 404 No error * External link https://v0-19-x.sdk.operatorframework.io/docs/building-operators/golang/legacy/quickstart/#build-and-run-the-operator failed: 404 No error * External link https://v0-19-x.sdk.operatorframework.io/docs/building-operators/golang/references/client/ failed: 404 No error 

[jmrodri]

And now there is a conflict so this PR needs a rebase

[anik120]

@camilamacedo86 @jmrodri resolved all the broken links expect for these two and looks like they're broken in main branch too.

[camilamacedo86]

Hi @anik120,

See that it is not passing in the CI because of broken links. However, not that your PR/version is missing docs and it is not accurate. Something probably was wrong in your rebase.

To check the broking links see the error msg:

- /target/docs/cli/operator-sdk_scorecard/index.html * internally linking to ../operator-sdk, which does not exist (line 1194) <a href="../operator-sdk">operator-sdk</a> 

It means that the ../operator-sdk link in /docs/cli/operator-sdk_scorecard/_index.md do not exist. See:

https://github.com/operator-framework/operator-sdk/tree/2b366c4c969d2647fa61ea7b279f9c67e12e60fb/website/content/en/docs/cli

The same for the other scenario:

- /target/docs/new-cli/operator-sdk_scorecard/index.html * internally linking to ../operator-sdk, which does not exist (line 1196) <a href="../operator-sdk">operator-sdk</a> 

It means that the ../operator-sdk link in docs/new-cli/operator-sdk_scorecard/_index.md do not exist.

Also, see that something goes wrong in your rebase:

The scorecard should be a menu with its docs instead that. Also, see that its cli index doc is also in the root when should not. You might need to review the changes made in the script to update the cli docs. See the master branch docs to check how it should be:

[estroz]

Incorrect link:

Suggested change

	[new_CLI]:/docs/cli/new-cli
	[new_CLI]:/docs/new-cli

We might want to wait until #3455 is merged to simplify this PR

[estroz]

Never mind, we can merge #3455 after this one is merged.

[anik120]

@estroz yea that'd be appreciated this PR has been in the works for a week now.
Although, CI job request is still pending for this one.

[estroz]

Suggested change

	[legacy_CLI]:/docs/cli/legacy-cli
	[legacy_CLI]:/docs/cli

[jmrodri]

/lgtm

shows that the changes requested was made

[camilamacedo86]

It shows OK for me 👍
Tks for your commitment with that 🥇
/lgtm