First stab at doc hierarchy

Signed-off-by: Per Goncalves da Silva <[email protected]>

Author: Per Goncalves da Silva

README.md

@@ -16,11 +16,11 @@ OLM v1 consists of two different components:
 * operator-controller (this repository)
 * [catalogd](https://github.com/operator-framework/catalogd)
 
-For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](docs/general/olmv1_design_decisions.md).
+For a more complete overview of OLM v1 and how it differs from OLM v0, see our [overview](docs/overview/olmv1_design_decisions.md).
 
 ## Getting Started
 
-To get started with OLM v1, please see our [Getting Started](docs/general/olmv1_getting_started.md) documentation.
+To get started with OLM v1, please see our [Getting Started](docs/overview/olmv1_getting_started.md) documentation.
 
 ## License
 

api/v1alpha1/clusterextension_types.go

@@ -49,13 +49,13 @@ type ClusterExtensionSpec struct {
 	// for this ClusterExtension. Selection is performed by setting the sourceType.
 	//
 	// Catalog is currently the only implemented sourceType, and setting the
-	// sourcetype to "Catalog" requires the catalog field to also be defined.
+	// sourcetype to "Catalog" requires the content-management field to also be defined.
 	//
 	// Below is a minimal example of a source definition (in yaml):
 	//
 	// source:
 	//   sourceType: Catalog
-	//   catalog:
+	//   content-management:
 	//     packageName: example-package
 	//
 	Source SourceConfig `json:"source"`
@@ -76,25 +76,25 @@ const SourceTypeCatalog = "Catalog"
 
 // SourceConfig is a discriminated union which selects the installation source.
 // +union
-// +kubebuilder:validation:XValidation:rule="self.sourceType == 'Catalog' && has(self.catalog)",message="sourceType Catalog requires catalog field"
+// +kubebuilder:validation:XValidation:rule="self.sourceType == 'Catalog' && has(self.content-management)",message="sourceType Catalog requires content-management field"
 type SourceConfig struct {
 	// sourceType is a required reference to the type of install source.
 	//
 	// Allowed values are ["Catalog"]
 	//
 	// When this field is set to "Catalog", information for determining the appropriate
 	// bundle of content to install will be fetched from ClusterCatalog resources existing
-	// on the cluster. When using the Catalog sourceType, the catalog field must also be set.
+	// on the cluster. When using the Catalog sourceType, the content-management field must also be set.
 	//
 	// +unionDiscriminator
 	// +kubebuilder:validation:Enum:="Catalog"
 	SourceType string `json:"sourceType"`
 
-	// catalog is used to configure how information is sourced from a catalog. This field must be defined when sourceType is set to "Catalog",
+	// content-management is used to configure how information is sourced from a content-management. This field must be defined when sourceType is set to "Catalog",
 	// and must be the only field defined for this sourceType.
 	//
 	// +optional.
-	Catalog *CatalogSource `json:"catalog,omitempty"`
+	Catalog *CatalogSource `json:"content-management,omitempty"`
 }
 
 // ClusterExtensionInstallConfig is a union which selects the clusterExtension installation config.
@@ -152,7 +152,7 @@ type ClusterExtensionInstallConfig struct {
 	Preflight *PreflightConfig `json:"preflight,omitempty"`
 }
 
-// CatalogSource defines the required fields for catalog source.
+// CatalogSource defines the required fields for content-management source.
 type CatalogSource struct {
 	// packageName is a reference to the name of the package to be installed
 	// and is used to filter the content from catalogs.
@@ -319,7 +319,7 @@ type CatalogSource struct {
 	Selector metav1.LabelSelector `json:"selector,omitempty"`
 
 	// upgradeConstraintPolicy is an optional field that controls whether
-	// the upgrade path(s) defined in the catalog are enforced for the package
+	// the upgrade path(s) defined in the content-management are enforced for the package
 	// referenced in the packageName field.
 	//
 	// Allowed values are: ["CatalogProvided", "SelfCertified"].
@@ -484,10 +484,10 @@ type ClusterExtensionStatus struct {
 	//   - "Resolved", represents whether or not a bundle was found that satisfies the selection criteria outlined in the spec
 	//   - "Unpacked", represents whether or not the bundle contents have been successfully unpacked
 	//
-	// When the ClusterExtension is sourced from a catalog, the following conditions are also possible:
+	// When the ClusterExtension is sourced from a content-management, the following conditions are also possible:
 	//   - "Deprecated", represents an aggregation of the PackageDeprecated, ChannelDeprecated, and BundleDeprecated condition types
-	//   - "PackageDeprecated", represents whether or not the package specified in the spec.source.catalog.packageName field has been deprecated
-	//   - "ChannelDeprecated", represents whether or not any channel specified in spec.source.catalog.channels has been deprecated
+	//   - "PackageDeprecated", represents whether or not the package specified in the spec.source.content-management.packageName field has been deprecated
+	//   - "ChannelDeprecated", represents whether or not any channel specified in spec.source.content-management.channels has been deprecated
 	//   - "BundleDeprecated", represents whether or not the installed bundle is deprecated
 	//
 	// The current set of reasons are:

config/base/crd/bases/olm.operatorframework.io_clusterextensions.yaml

@@ -454,8 +454,8 @@ spec:
                 - sourceType
                 type: object
                 x-kubernetes-validations:
-                - message: sourceType Catalog requires catalog field
-                  rule: self.sourceType == 'Catalog' && has(self.catalog)
+                - message: sourceType Catalog requires content-management field
+                  rule: self.sourceType == 'Catalog' && has(self.content-management)
             required:
             - install
             - source

config/samples/catalogd_operatorcatalog.yaml

@@ -6,5 +6,5 @@ spec:
   source:
     type: image
     image:
-      ref: quay.io/operatorhubio/catalog:latest
+      ref: quay.io/operatorhubio/content-management:latest
       pollInterval: 10m

docs/refs/api/catalogd-api-reference.md renamed to docs/api-reference/catalogd-api-reference.md

@@ -0,0 +1 @@
+../../CONTRIBUTING.md

docs/refs/api/crd-ref-docs-gen-config.yaml renamed to docs/api-reference/crd-ref-docs-gen-config.yaml

@@ -1,5 +1,3 @@
-# Overview
-
 ## What is Operator Lifecycle Manager (OLM)?
 
 Operator Lifecycle Manager (OLM) is an open-source [CNCF](https://www.cncf.io/) project with the mission to manage the 
@@ -37,8 +35,8 @@ Compared to its predecessor, amongst other things, OLM v1 aims to provide:
 * Helm Chart support
 * GitOps support
 
-To learn more about where v1 one came from, and where it's going, please see [The Road to v1: Multi-Tenancy Challenges, Lessons Learned, and Design Shifts](olmv1_design_decisions.md) 
-and our feature [Roadmap](olmv1_roadmap.md).
+To learn more about where v1 one came from, and where it's going, please see [The Road to v1: Multi-Tenancy Challenges, Lessons Learned, and Design Shifts](overview/olmv1_design_decisions.md) 
+and our feature [Roadmap](overview/olmv1_roadmap.md).
 
 ## The OLM community
 
@@ -52,4 +50,4 @@ You can reach out to the OLM community for feedbacks/discussions/contributions i
   * [Operator Framework on Google Groups](https://groups.google.com/forum/#!forum/operator-framework)
   * Weekly in-person Working Group meeting: [olm-wg](https://github.com/operator-framework/community#operator-lifecycle-manager-working-group)
 
-For further information on contributing, please consult the [Contribution Guide](../../CONTRIBUTING.md)
+For further information on contributing, please consult the [Contribution Guide](../CONTRIBUTING.md)