Merge "Fixed docs and enabled addition validation. Fixed files filter for doc-check job."

Author: Microzuul CI

Makefile

@@ -185,7 +185,7 @@ KUSTOMIZE_VERSION ?= v5.4.3
 CONTROLLER_TOOLS_VERSION ?= v0.15.0
 OPERATOR_SDK_VERSION ?= 1.36.1
 STATICCHECK_VERSION ?= 2025.1.1
-MKDOCS_VERSION ?= 1.5.3
+MKDOCS_VERSION ?= 1.6.0
 SETUP_ENVTEST_VERSION ?= v0.0.0-20240320141353-395cfc7486e6
 ZUUL_CLIENT_VERSION ?= 10.0.0
 

doc/README.md

@@ -184,16 +184,14 @@ The current project status is: **Beta**
 
 ## Getting Started
 
-* [Installing the Operator ](https://softwarefactory-project.github.io/sf-operator/operator/getting_started/)
-* [Deploying Zuul and dependencies with SF-Operator](https://softwarefactory-project.github.io/sf-operator/deployment/getting_started)
+* [Deploying Zuul and dependencies with SF-Operator](deployment/getting_started.md)
 
 ## Documentation
 
-* [Operator documentation](https://softwarefactory-project.github.io/sf-operator/operator/): for OpenShift cluster administrators, this documentation covers installing SF-Operator and managing the operator's lifecycle.
-* [Deployment documentation](https://softwarefactory-project.github.io/sf-operator/deployment/): this documentation covers the essentials for people or teams who intend to deploy and manage Zuul and its dependencies through the SF-Operator.
-* [Developer documentation](https://softwarefactory-project.github.io/sf-operator/developer/): this documentation describes how to set up a development and testing environment to develop the SF-Operator.
-* [End User documentation](https://softwarefactory-project.github.io/sf-operator/user/): for users of a Software Factory instance. This documentation mostly describes the `Software Factory's config repository` usage (configuration-as-code).
-* [CLI reference](https://softwarefactory-project.github.io/sf-operator/reference/cli/)
+* [Deployment documentation](deployment/index.md): this documentation covers the essentials for people or teams who intend to deploy and manage Zuul and its dependencies through the SF-Operator.
+* [Developer documentation](developer/index.md): this documentation describes how to set up a development and testing environment to develop the SF-Operator.
+* [End User documentation](user/index.md): for users of a Software Factory instance. This documentation mostly describes the `Software Factory's config repository` usage (configuration-as-code).
+* [CLI reference](reference/cli/index.md)
 
 ## Getting Help
 
@@ -205,7 +203,7 @@ Should you have any questions or feedback concerning the SF-Operator, you can:
 
 ## Contributing
 
-Refer to [CONTRIBUTING.md](https://softwarefactory-project.github.io/sf-operator/developer/CONTRIBUTING/).
+Refer to [CONTRIBUTING.md](developer/CONTRIBUTING.md).
 
 ## License
 

doc/deployment/config_repository.md

@@ -2,7 +2,6 @@
 
 
 1. [Concept](#concept)
-1. [Repository content](#repository-content)
 1. [Setting up the repository](#setting-up-the-repository)
     1. [Gerrit](#hosting-on-gerrit)
         - [Prerequisites](#prerequisites-on-gerrit)

doc/deployment/crds.md

@@ -4,7 +4,7 @@ This document gives details about the Custom Resource Definitions (CRDs) that th
 
 The specs are constantly evolving during alpha development and should be considered unstable, but they are the ultimate source of truth for documentation about their properties.
 
-1. [SoftwareFactory](#crds)
+1. [SoftwareFactory](#softwarefactory)
 
 ## SoftwareFactory
 

doc/deployment/logging.md

@@ -5,8 +5,8 @@ This document describes different ways of handling log collection and aggregatio
 
 1. [Using kubectl](#using-kubectl)
 1. [Native Cluster Logging](#native-cluster-logging)
-1. [Operator-Managed Log Forwarding](#operator-managed-log-forwarding)
-1. [Example: Forwarding Logs to Loki](#example-forwarding-logs-to-loki)
+1. [Log Forwarding to a Fluent Bit collector](#log-forwarding-to-a-fluent-bit-collector)
+1. [Example: Setting up a simple Fluent Bit + Loki stack for log collection](#example-setting-up-a-simple-fluent-bit-loki-stack-for-log-collection)
 
 ## Using kubectl
 
@@ -21,7 +21,7 @@ If you need to check logs from init containers, crashed containers, batch jobs,
 just containers that were destroyed after a configuration change, you will need to rely on
 another tool.
 
-### Native Cluster Logging
+## Native Cluster Logging
 
 Some clusters may have a built-in log collection infrastructure in place. For example:
 

doc/reference/CHANGELOG.md

@@ -169,7 +169,7 @@ This release also marks the migration of the sf-operator's CI to https://gateway
 ### Removed
 
 - cert-manager: dependency removal complete. If you deployed a Software Factory with sf-operator prior to version
-  v0.0.55, please upgrade to [v0.0.55](#v0055---2025-03-03) first to ensure the proper removal of dangling cert-manager-related resources.
+  v0.0.55, please upgrade to [v0.0.55](#v0055-2025-03-03) first to ensure the proper removal of dangling cert-manager-related resources.
 - The spec `config-location` "base-url" attribute is no longer required.
 
 ### Fixed

doc/reference/adr/index.md

@@ -30,4 +30,7 @@ General information about architectural decision records is available at <https:
 1. [Database Agnosticity for SF Deployments](./0009-database-agnosticity.md)
 1. [Usage of the upstream zuul-operator](./0010-zuul-operator-usage.md)
 1. [Nodepool Builder](./0011-nodepool-builder.md)
-1. [CLI overhaul](./0012-CLI-overhaul.md)
+1. [CLI overhaul](./0012-CLI-overhaul.md)
+1. [Route management](./0015-route-handling.md)
+1. [Remove OLM and simplify the CI](./0016-remove-olm-and-simplify-the-ci.md)
+1. [Project code hosting change](./0017-sf-operator-code-hosting.md)

doc/reference/api/index.md

@@ -662,3 +662,36 @@ _Appears in:_
 | `limits` _[LimitsSpec](#limitsspec)_ | Memory/CPU Limit | {map[cpu:500m memory:2Gi]}|
 
 
+
+#### SoftwareFactoryStatus
+
+_Type alias for:_ _[BaseStatus](#basestatus)_
+
+SoftwareFactoryStatus defines the observed state of SoftwareFactory. It is a type alias for BaseStatus with no additional fields.
+
+_Appears in:_
+- [SoftwareFactory](#softwarefactory)
+
+#### SecretRef
+
+_This type is defined but not currently used in the public API._
+
+SecretRef selects a key of a secret in the pod's namespace.
+
+_Appears in:_
+- [Secret](#secret)
+
+| Field | Description | Default Value |
+| --- | --- | --- |
+| `secretKeyRef` _[Secret](#secret)_ | Selects a key of a secret in the pod's namespace | - |
+
+#### LetsEncryptSpec
+
+_This type is defined but not currently implemented in the operator._
+
+LetsEncryptSpec specifies the Let's Encrypt server configuration. This feature is planned but not yet implemented.
+
+| Field | Description | Default Value |
+| --- | --- | --- |
+| `server` _[LEServer](#leserver)_ | Specify the Let's Encrypt server. Valid values are: "staging", "prod" | staging |
+

doc/reference/cli/index.md

@@ -30,7 +30,7 @@ deployments, beyond what can be defined in a custom resource manifest.
   1. [Zuul](#zuul)
     - [create auth-token](#create-auth-token)
     - [create client-config](#create-client-config)
-  1. [Deploy](#deploy-sf)
+  1. [Deploy](#deploy)
   1. [Version](#version)
 
 ## Installing the CLI

doc/user/nodepool_config_repository.md

@@ -43,7 +43,7 @@ The configuration provided in `nodepool/nodepool.yaml` will be appended to the b
     --8<-- "controllers/static/nodepool/generate-config.sh"
     ```
 
-For each provider used in the Nodepool launcher configuration, Nodepool must be able to find the required connection credentials. Please refer to the deployment documentation about [setting up provider secrets](../deployment/nodepool.md#setting-up-provider-secrets).
+For each provider used in the Nodepool launcher configuration, Nodepool must be able to find the required connection credentials. Please refer to the deployment documentation about [setting up provider secrets](../deployment/nodepool.md#setting-up-providers-secrets).
 
 ### Use an official cloud image within an OpenStack cloud
 
@@ -100,7 +100,7 @@ The configuration provided in `nodepool/nodepool-builder.yaml` will be appended
 
 1. See ["What happens during a `config-update` job?"](#configuring-nodepool-launcher) for implementation details.
 
-For each provider used in the Nodepool builder configuration, Nodepool must be able to find the required connection credentials. Please refer to the deployment documentation about [setting up provider secrets](../deployment/nodepool.md#setting-up-provider-secrets).
+For each provider used in the Nodepool builder configuration, Nodepool must be able to find the required connection credentials. Please refer to the deployment documentation about [setting up provider secrets](../deployment/nodepool.md#setting-up-providers-secrets).
 
 ### disk-image-builder