From a33c70b6384cde7fc2285bb44b87eae141e37e40 Mon Sep 17 00:00:00 2001 From: Anik Bhattacharjee Date: Fri, 10 Jul 2020 12:21:41 -0400 Subject: [PATCH] [docs] Reorganize hugo doc site 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. --- CHANGELOG.md | 8 +- hack/generate/cli-doc/gen-cli-doc.go | 4 +- release.sh | 2 +- website/content/en/build/_index.html | 18 ++-- website/content/en/docs/_index.md | 89 ----------------- .../content/en/docs/advanced-topics/_index.md | 7 ++ .../operator-capabilities.md | 2 +- .../docs/advanced-topics/scorecard/_index.md | 6 ++ .../scorecard/custom-tests.md | 2 +- .../scorecard/kuttl-tests.md | 0 .../scorecard/scorecard.md | 2 +- .../en/docs/building-operators/_index.md | 9 ++ .../{ => building-operators}/ansible/OWNERS | 0 .../ansible/_index.md | 5 +- .../ansible/development-tips.md | 2 +- .../ansible/installation.md | 2 +- .../ansible/quickstart.md | 8 +- .../ansible/reference/_index.md | 0 .../ansible/reference/advanced_options.md | 0 .../ansible/reference/apb-migration-guide.md | 0 .../ansible/reference/dependent-watches.md | 0 .../ansible/reference/finalizers.md | 2 +- .../information-flow-ansible-operator.md | 0 .../retroactively-owned-resources.md | 0 .../ansible/reference/scaffolding.md | 0 .../ansible/reference/watches.md | 0 .../ansible/reference/webhooks.md | 0 .../ansible/testing-guide.md | 0 .../docs/building-operators/golang/_index.md | 5 + .../golang/advanced-topics.md | 0 .../golang/crds-scope.md | 2 +- .../golang/installation.md | 2 +- .../golang/operator-scope.md | 2 +- .../golang/project_migration_guide.md | 6 +- .../golang/quickstart.md | 10 +- .../golang/references/_index.md | 0 .../golang/references/client.md | 0 .../golang/references/event-filtering.md | 0 .../golang/references/logging.md | 0 .../golang/references/markers.md | 2 +- .../golang/webhooks.md | 4 +- .../en/docs/building-operators/helm/_index.md | 5 + .../helm/installation.md | 2 +- .../helm/migration.md | 6 +- .../helm/quickstart.md | 4 +- .../helm/reference/_index.md | 0 .../helm/reference/advanced_features.md | 0 .../helm/reference/scaffolding.md | 0 .../helm/reference/watches.md | 2 +- website/content/en/docs/cli/_index.md | 21 +--- .../en/docs/cli/ansible-helm/_index.md | 18 ++++ .../cli/{ => ansible-helm}/operator-sdk.md | 0 .../{ => ansible-helm}/operator-sdk_add.md | 0 .../operator-sdk_add_api.md | 0 .../{ => ansible-helm}/operator-sdk_build.md | 0 .../operator-sdk_completion.md | 0 .../operator-sdk_completion_bash.md | 0 .../operator-sdk_completion_zsh.md | 0 .../{ => ansible-helm}/operator-sdk_new.md | 0 .../{ => ansible-helm}/operator-sdk_olm.md | 0 .../operator-sdk_olm_install.md | 0 .../operator-sdk_olm_status.md | 0 .../operator-sdk_olm_uninstall.md | 0 .../operator-sdk_scorecard.md | 0 .../operator-sdk_version.md | 0 website/content/en/docs/cli/golang/_index.md | 9 ++ .../{new-cli => cli/golang}/operator-sdk.md | 0 .../golang}/operator-sdk_build.md | 0 .../golang}/operator-sdk_bundle.md | 0 .../golang}/operator-sdk_bundle_validate.md | 0 .../golang}/operator-sdk_cleanup.md | 0 .../operator-sdk_cleanup_packagemanifests.md | 0 .../golang}/operator-sdk_completion.md | 0 .../golang}/operator-sdk_completion_bash.md | 0 .../golang}/operator-sdk_completion_zsh.md | 0 .../golang}/operator-sdk_create.md | 0 .../golang}/operator-sdk_create_api.md | 0 .../golang}/operator-sdk_create_webhook.md | 0 .../golang}/operator-sdk_generate.md | 0 .../golang}/operator-sdk_generate_bundle.md | 0 .../operator-sdk_generate_kustomize.md | 0 ...erator-sdk_generate_kustomize_manifests.md | 0 .../operator-sdk_generate_packagemanifests.md | 0 .../golang}/operator-sdk_init.md | 0 .../golang}/operator-sdk_new.md | 0 .../golang}/operator-sdk_olm.md | 0 .../golang}/operator-sdk_olm_install.md | 0 .../golang}/operator-sdk_olm_status.md | 0 .../golang}/operator-sdk_olm_uninstall.md | 0 .../golang}/operator-sdk_run.md | 0 .../operator-sdk_run_packagemanifests.md | 0 .../golang}/operator-sdk_scorecard.md | 0 .../golang}/operator-sdk_version.md | 0 .../en/docs/contribution-guidelines/_index.md | 3 +- .../docs/contribution-guidelines/release.md | 8 +- .../content/en/docs/{faq.md => faqs/faqs.md} | 4 +- website/content/en/docs/golang/_index.md | 4 - website/content/en/docs/helm/_index.md | 4 - .../install-operator-sdk.md | 9 +- website/content/en/docs/migration/_index.md | 4 - website/content/en/docs/new-cli/_index.md | 8 -- .../content/en/docs/olm-integration/_index.md | 3 +- .../en/docs/olm-integration/cli-overview.md | 14 +-- .../docs/olm-integration/generating-a-csv.md | 12 +-- .../docs/olm-integration/quickstart-bundle.md | 8 +- .../quickstart-package-manifests.md | 4 +- .../olm-integration/testing-deployment.md | 4 +- website/content/en/docs/overview/_overview.md | 97 +++++++++++++++++++ website/content/en/docs/scorecard/_index.md | 5 - .../en/docs/upgrading-sdk-version/_index.md | 5 + .../backport-policy.md | 2 +- .../operator-sdk-versioning.md} | 5 +- .../v0.1.0-migration-guide.md | 9 +- .../v0.18.0.md | 4 +- .../v0.19.0.md | 4 +- .../version-upgrade-guide.md | 9 +- website/content/en/faq/_index.md | 9 -- website/layouts/index.html | 6 +- 118 files changed, 272 insertions(+), 240 deletions(-) create mode 100644 website/content/en/docs/advanced-topics/_index.md rename website/content/en/docs/{ => advanced-topics/operator-capabilities}/operator-capabilities.md (99%) create mode 100644 website/content/en/docs/advanced-topics/scorecard/_index.md rename website/content/en/docs/{ => advanced-topics}/scorecard/custom-tests.md (99%) rename website/content/en/docs/{ => advanced-topics}/scorecard/kuttl-tests.md (100%) rename website/content/en/docs/{ => advanced-topics}/scorecard/scorecard.md (99%) create mode 100644 website/content/en/docs/building-operators/_index.md rename website/content/en/docs/{ => building-operators}/ansible/OWNERS (100%) rename website/content/en/docs/{ => building-operators}/ansible/_index.md (55%) rename website/content/en/docs/{ => building-operators}/ansible/development-tips.md (99%) rename website/content/en/docs/{ => building-operators}/ansible/installation.md (93%) rename website/content/en/docs/{ => building-operators}/ansible/quickstart.md (97%) rename website/content/en/docs/{ => building-operators}/ansible/reference/_index.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/advanced_options.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/apb-migration-guide.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/dependent-watches.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/finalizers.md (98%) rename website/content/en/docs/{ => building-operators}/ansible/reference/information-flow-ansible-operator.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/retroactively-owned-resources.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/scaffolding.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/watches.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/reference/webhooks.md (100%) rename website/content/en/docs/{ => building-operators}/ansible/testing-guide.md (100%) create mode 100644 website/content/en/docs/building-operators/golang/_index.md rename website/content/en/docs/{ => building-operators}/golang/advanced-topics.md (100%) rename website/content/en/docs/{ => building-operators}/golang/crds-scope.md (97%) rename website/content/en/docs/{ => building-operators}/golang/installation.md (94%) rename website/content/en/docs/{ => building-operators}/golang/operator-scope.md (99%) rename website/content/en/docs/{ => building-operators}/golang/project_migration_guide.md (97%) rename website/content/en/docs/{ => building-operators}/golang/quickstart.md (98%) rename website/content/en/docs/{ => building-operators}/golang/references/_index.md (100%) rename website/content/en/docs/{ => building-operators}/golang/references/client.md (100%) rename website/content/en/docs/{ => building-operators}/golang/references/event-filtering.md (100%) rename website/content/en/docs/{ => building-operators}/golang/references/logging.md (100%) rename website/content/en/docs/{ => building-operators}/golang/references/markers.md (99%) rename website/content/en/docs/{ => building-operators}/golang/webhooks.md (97%) create mode 100644 website/content/en/docs/building-operators/helm/_index.md rename website/content/en/docs/{ => building-operators}/helm/installation.md (92%) rename website/content/en/docs/{ => building-operators}/helm/migration.md (93%) rename website/content/en/docs/{ => building-operators}/helm/quickstart.md (98%) rename website/content/en/docs/{ => building-operators}/helm/reference/_index.md (100%) rename website/content/en/docs/{ => building-operators}/helm/reference/advanced_features.md (100%) rename website/content/en/docs/{ => building-operators}/helm/reference/scaffolding.md (100%) rename website/content/en/docs/{ => building-operators}/helm/reference/watches.md (89%) create mode 100644 website/content/en/docs/cli/ansible-helm/_index.md rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_add.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_add_api.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_build.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_completion.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_completion_bash.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_completion_zsh.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_new.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_olm.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_olm_install.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_olm_status.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_olm_uninstall.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_scorecard.md (100%) rename website/content/en/docs/cli/{ => ansible-helm}/operator-sdk_version.md (100%) create mode 100644 website/content/en/docs/cli/golang/_index.md rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_build.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_bundle.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_bundle_validate.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_cleanup.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_cleanup_packagemanifests.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_completion.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_completion_bash.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_completion_zsh.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_create.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_create_api.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_create_webhook.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_generate.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_generate_bundle.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_generate_kustomize.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_generate_kustomize_manifests.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_generate_packagemanifests.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_init.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_new.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_olm.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_olm_install.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_olm_status.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_olm_uninstall.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_run.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_run_packagemanifests.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_scorecard.md (100%) rename website/content/en/docs/{new-cli => cli/golang}/operator-sdk_version.md (100%) rename website/content/en/docs/{faq.md => faqs/faqs.md} (98%) delete mode 100644 website/content/en/docs/golang/_index.md delete mode 100644 website/content/en/docs/helm/_index.md rename website/content/en/docs/{ => installation}/install-operator-sdk.md (98%) delete mode 100644 website/content/en/docs/migration/_index.md delete mode 100644 website/content/en/docs/new-cli/_index.md create mode 100644 website/content/en/docs/overview/_overview.md delete mode 100644 website/content/en/docs/scorecard/_index.md create mode 100644 website/content/en/docs/upgrading-sdk-version/_index.md rename website/content/en/docs/{contribution-guidelines => upgrading-sdk-version}/backport-policy.md (98%) rename website/content/en/docs/{versioning.md => upgrading-sdk-version/operator-sdk-versioning.md} (90%) rename website/content/en/docs/{migration => upgrading-sdk-version}/v0.1.0-migration-guide.md (98%) rename website/content/en/docs/{migration => upgrading-sdk-version}/v0.18.0.md (99%) rename website/content/en/docs/{migration => upgrading-sdk-version}/v0.19.0.md (98%) rename website/content/en/docs/{migration => upgrading-sdk-version}/version-upgrade-guide.md (99%) delete mode 100644 website/content/en/faq/_index.md diff --git a/CHANGELOG.md b/CHANGELOG.md index 2f0245c470..e7e0f15c2a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -220,7 +220,7 @@ - The type name `TestCtx` in `pkg/test` has been deprecated and renamed to `Context`. It now exists only as a type alias to maintain backwards compatibility. Users of the e2e framework should migrate to use the new name, `Context`. The `TestCtx` alias will be removed in a future version. ([2549](https://github.com/operator-framework/operator-sdk/pull/2549)) - The additional of the dependency `inotify-tools` on Ansible based-operator images. ([#2586](https://github.com/operator-framework/operator-sdk/pull/2586)) -- **Breaking Change:** The scorecard feature now only supports YAML config files. So, any config file with other extension is deprecated and should be changed for the YAML format. For further information see [`scorecard config file`](./website/content/en/docs/scorecard/_index.md#config-file) ([#2591](https://github.com/operator-framework/operator-sdk/pull/2591)) +- **Breaking Change:** The scorecard feature now only supports YAML config files. So, any config file with other extension is deprecated and should be changed for the YAML format. For further information see [`scorecard config file`](./website/content/en/docs/advanced-topics/scorecard/_index.md#config-file) ([#2591](https://github.com/operator-framework/operator-sdk/pull/2591)) ### Removed @@ -465,7 +465,7 @@ ### Changed -- **Breaking Change:** New configuration format for the `operator-sdk scorecard` using config files. See [`doc/test-framework/scorecard`](./website/content/en/docs/scorecard/_index.md) for more info ([#1641](https://github.com/operator-framework/operator-sdk/pull/1641)) +- **Breaking Change:** New configuration format for the `operator-sdk scorecard` using config files. See [`doc/test-framework/scorecard`](./website/content/en/docs/advanced-topics/scorecard/_index.md) for more info ([#1641](https://github.com/operator-framework/operator-sdk/pull/1641)) - **Breaking change:** CSV config field `role-path` is now `role-paths` and takes a list of strings. Users can now specify multiple `Role` and `ClusterRole` manifests using `role-paths`. ([#1704](https://github.com/operator-framework/operator-sdk/pull/1704)) - Make `ready` package idempotent. Now, a user can call `Set()` or `Unset()` to set the operator's readiness without knowing the current state. ([#1761](https://github.com/operator-framework/operator-sdk/pull/1761)) @@ -534,7 +534,7 @@ - Unify CLI debug logging under a global `--verbose` flag ([#1361](https://github.com/operator-framework/operator-sdk/pull/1361)) - [Go module](https://github.com/golang/go/wiki/Modules) support by default for new Go operators and during Ansible and Helm operator migration. The dependency manager used for a new operator can be explicitly specified for new operators through the `--dep-manager` flag, available in [`operator-sdk new`](https://github.com/operator-framework/operator-sdk/blob/v0.8.0/doc/sdk-cli-reference.md#new) and [`operator-sdk migrate`](https://github.com/operator-framework/operator-sdk/blob/v0.8.0/doc/sdk-cli-reference.md#migrate). `dep` is still available through `--dep-manager=dep`. ([#1001](https://github.com/operator-framework/operator-sdk/pull/1001)) - New optional flag `--custom-api-import` for [`operator-sdk add controller`](https://github.com/operator-framework/operator-sdk/blob/v0.8.0/doc/sdk-cli-reference.md#controller) to specify that the new controller reconciles a built-in or external Kubernetes API, and what import path and identifier it should have. ([#1344](https://github.com/operator-framework/operator-sdk/pull/1344)) -- Operator Scorecard plugin support. Documentation for scorecard plugins can be found in the main scorecard [doc](./website/content/en/docs/scorecard/_index.md). ([#1379](https://github.com/operator-framework/operator-sdk/pull/1379)) +- Operator Scorecard plugin support. Documentation for scorecard plugins can be found in the main scorecard [doc](./website/content/en/docs/advanced-topics/scorecard/_index.md). ([#1379](https://github.com/operator-framework/operator-sdk/pull/1379)) ### Changed @@ -650,7 +650,7 @@ - Ansible operator proxy added the cache handler which allows the get requests to use the operators cache. [#760](https://github.com/operator-framework/operator-sdk/pull/760) - Ansible operator proxy added ability to dynamically watch dependent resource that were created by ansible operator. [#857](https://github.com/operator-framework/operator-sdk/pull/857) - Ansible-based operators have leader election turned on by default. When upgrading, add environment variable `POD_NAME` to your operator's Deployment using the Kubernetes downward API. To see an example, run `operator-sdk new --type=ansible ...` and see file `deploy/operator.yaml`. -- A new command [`operator-sdk scorecard`](https://github.com/operator-framework/operator-sdk/blob/v0.4.0/doc/sdk-cli-reference.md#scorecard) which runs a series of generic tests on operators to ensure that an operator follows best practices. For more information, see the [scorecard documentation](./website/content/en/docs/scorecard/_index.md) +- A new command [`operator-sdk scorecard`](https://github.com/operator-framework/operator-sdk/blob/v0.4.0/doc/sdk-cli-reference.md#scorecard) which runs a series of generic tests on operators to ensure that an operator follows best practices. For more information, see the [scorecard documentation](./website/content/en/docs/advanced-topics/scorecard/_index.md) ### Changed diff --git a/hack/generate/cli-doc/gen-cli-doc.go b/hack/generate/cli-doc/gen-cli-doc.go index fafb1cbd32..1b9e2346c9 100644 --- a/hack/generate/cli-doc/gen-cli-doc.go +++ b/hack/generate/cli-doc/gen-cli-doc.go @@ -39,12 +39,12 @@ func main() { log.Fatalf("Failed to get current directory: %v", err) } - legacyDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli") + legacyDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "ansible-helm") legacyRoot := cli.GetCLIRoot() legacyRoot.DisableAutoGenTag = true recreateDocDir(legacyRoot, legacyDocPath) - newDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "new-cli") + newDocPath := filepath.Join(currentDir, "website", "content", "en", "docs", "cli", "golang") _, newRoot := cli.GetPluginsCLIAndRoot() newRoot.DisableAutoGenTag = true recreateDocDir(newRoot, newDocPath) diff --git a/release.sh b/release.sh index b52a53d18d..bdaae16fb2 100755 --- a/release.sh +++ b/release.sh @@ -38,7 +38,7 @@ if [[ "$VER" != "$CURR_VER" ]]; then exit 1 fi -INSTALL_GUIDE_FILE="website/content/en/docs/install-operator-sdk.md" +INSTALL_GUIDE_FILE="website/content/en/docs/installation/install-operator-sdk.md" CURR_VER_INSTALL_GUIDE_FILE="$(sed -nr 's/.*RELEASE_VERSION=(.+)/\1/p' "$INSTALL_GUIDE_FILE" | tr -d ' \t\n')" if [[ "$VER" != "$CURR_VER_INSTALL_GUIDE_FILE" ]]; then echo "version '$VER' is not set correctly in $INSTALL_GUIDE_FILE" diff --git a/website/content/en/build/_index.html b/website/content/en/build/_index.html index 88bab7c648..96626520b2 100644 --- a/website/content/en/build/_index.html +++ b/website/content/en/build/_index.html @@ -24,14 +24,14 @@

How can I write an Operator with Operator

Installing the SDK CLI

-

Follow the steps in the installation guide to learn how to install the Operator SDK CLI tool. If you are using a release version of the SDK, make sure to follow the documentation for that version. You make use any of the following installation processes:

+

Follow the steps in the installation guide to learn how to install the Operator SDK CLI tool. If you are using a release version of the SDK, make sure to follow the documentation for that version. You make use any of the following installation processes:

    -
  1. Install the Homebrew (macOS)
    2. -
  2. Install from GitHub release
    3. -
  3. Compile and install from master
    4. +
  4. Install the Homebrew (macOS)
    5. +
  5. Install from GitHub release
    6. +
  6. Compile and install from master
- Learn More + Learn More @@ -44,19 +44,19 @@

Installing the SDK CLI

READ THE USER GUIDES

Operators can be created with the SDK using Ansible, Helm, or Go. Follow the one of the quickstart guides to dive in.