Skip to content

Ensure docs/ examples have description and keywords on all pages #729

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 17, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Makefile
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# ----------------------------------------------------------------------------------------------------------------------
# Copyright (c) 2019, 2024, Oracle and/or its affiliates.
# Copyright (c) 2019, 2025, Oracle and/or its affiliates.
# Licensed under the Universal Permissive License v 1.0 as shown at
# http://oss.oracle.com/licenses/upl.
#
Expand Down Expand Up @@ -2935,7 +2935,7 @@ test-docs: docs
serve-docs:
@echo "Serving documentation on http://localhost:8080"
cd $(BUILD_OUTPUT)/docs; \
python -m SimpleHTTPServer 8080
python3 -m http.server 8080

# ======================================================================================================================
# Release targets
Expand Down
4 changes: 2 additions & 2 deletions docs/about/01_overview.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Overview
:description: Coherence Operator documentation
:description: Coherence Operator Documentation
:keywords: oracle coherence, kubernetes, operator, documentation

== Get Going
Expand Down
4 changes: 3 additions & 1 deletion docs/about/02_introduction.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Coherence Operator Introduction
:description: Coherence Operator Documentation - Introduction
:keywords: oracle coherence, kubernetes, operator, documentation, introduction

== What is the Coherence Operator?
The Coherence Operator is a https://kubernetes.io/docs/concepts/extend-kubernetes/operator/[Kubernetes Operator] that
Expand Down
4 changes: 3 additions & 1 deletion docs/about/03_quickstart.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Copyright (c) 2020, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Quick Start
:description: Coherence Operator Documentation - Quick Start
:keywords: oracle coherence, kubernetes, operator, documentation, quick start

This guide is a simple set of steps to install the Coherence Operator and then use that
to install a simple Coherence cluster.
Expand Down
4 changes: 3 additions & 1 deletion docs/about/05_upgrade.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Upgrade from Version 2
:description: Coherence Operator Documentation - Upgrade from Version 2
:keywords: oracle coherence, kubernetes, operator, documentation, upgrade, version 2, version 3

== Upgrading from Operator v2

Expand Down
4 changes: 3 additions & 1 deletion docs/applications/010_overview.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Overview
:description: Coherence Operator Documentation - Application Deployment
:keywords: oracle coherence, kubernetes, operator, documentation, application deployment, deployment

== Overview

Expand Down
4 changes: 3 additions & 1 deletion docs/applications/020_build_application.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Build Application Images
:description: Coherence Operator Documentation - Build Application Images
:keywords: oracle coherence, kubernetes, operator, documentation, Build Application Images, build

== Build Custom Application Images

Expand Down
2 changes: 2 additions & 0 deletions docs/applications/030_deploy_application.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Deploy Coherence Applications
:description: Coherence Operator Documentation - Deploy Coherence Applications
:keywords: oracle coherence, kubernetes, operator, documentation, Deploy Coherence Applications

== Deploy Coherence Applications

Expand Down
4 changes: 3 additions & 1 deletion docs/applications/032_rolling_upgrade.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2024, Oracle and/or its affiliates.
Copyright (c) 2024, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Rolling Upgrades of Coherence Applications
:description: Coherence Operator Documentation - Rolling Upgrades of Coherence Applications
:keywords: oracle coherence, kubernetes, operator, documentation, rolling upgrades

== Rolling Upgrades of Coherence Applications

Expand Down
2 changes: 2 additions & 0 deletions docs/applications/040_application_main.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Set the Application Main
:description: Coherence Operator Documentation - Set the Application Main
:keywords: oracle coherence, kubernetes, operator, documentation, set application main

== Set the Application Main

Expand Down
2 changes: 2 additions & 0 deletions docs/applications/050_application_args.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Set Application Arguments
:description: Coherence Operator Documentation - Set Application Arguments
:keywords: oracle coherence, kubernetes, operator, documentation, set application arguments

== Set Application Arguments

Expand Down
4 changes: 3 additions & 1 deletion docs/applications/060_application_working_dir.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Set the Working Directory
:description: Coherence Operator Documentation - Set the Working Directory
:keywords: oracle coherence, kubernetes, operator, documentation, Set the Working Directory

== Set the Working Directory

Expand Down
2 changes: 2 additions & 0 deletions docs/applications/070_spring.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Spring Boot Applications
:description: Coherence Operator Documentation - Spring Boot Applications
:keywords: oracle coherence, kubernetes, operator, documentation, Spring Boot Applications

== Spring Boot Applications

Expand Down
2 changes: 2 additions & 0 deletions docs/applications/080_entrypoint.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Run an Image Entry Point
:description: Coherence Operator Documentation - Run an Image Entry Point
:keywords: oracle coherence, kubernetes, operator, documentation, Run an Image Entry Point

== Run an Image Entry Point

Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/010_overview.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Overview
:description: Coherence Operator Documentation - Coherence Settings
:keywords: oracle coherence, kubernetes, operator, documentation, coherence settings

The `Coherence` resource has a number of fields to configure the behaviour of `Coherence`,
these fields are in the `spec.coherence` section of the CRD.
Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/020_cluster_name.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Coherence Cluster Name
:description: Coherence Operator Documentation - Set Coherence Cluster Name
:keywords: oracle coherence, kubernetes, operator, documentation, set coherence cluster name, cluster name

== Set Coherence Cluster Name

Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/021_member_identity.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2024, Oracle and/or its affiliates.
Copyright (c) 2021, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Member Identity
:description: Coherence Operator Documentation - Member Identity
:keywords: oracle coherence, kubernetes, operator, documentation, member identity, member

== Member Identity

Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/030_cache_config.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Copyright (c) 2020, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Cache Configuration File
:description: Coherence Operator Documentation - Set the Cache Configuration File
:keywords: oracle coherence, kubernetes, operator, documentation, Cache Configuration File, cache configuration

== Set the Cache Configuration File Name

Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/040_override_file.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Copyright (c) 2020, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Operational Configuration File
:description: Coherence Operator Documentation - Set the Operational Configuration File
:keywords: oracle coherence, kubernetes, operator, documentation, Cache Operational Configuration File, operational configuration

== Set the Operational Configuration File Name

Expand Down
5 changes: 4 additions & 1 deletion docs/coherence/050_storage_enabled.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Storage Enabled or Disabled
:description: Coherence Operator Documentation - Storage Enabled or Disabled Deployments
:keywords: oracle coherence, kubernetes, operator, documentation, Storage Enabled or Disabled Deployments


== Storage Enabled or Disabled Deployments
Partitioned cache services that manage Coherence caches are configured as storage enabled or storage disabled.
Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/060_log_level.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Coherence Log Level
:description: Coherence Operator Documentation - Set the Coherence Log Level
:keywords: oracle coherence, kubernetes, operator, documentation, Set the Coherence Log Level

== Set the Coherence Log Level
Logging granularity in Coherence is controlled by a log level, that is a number between one and nine,
Expand Down
5 changes: 4 additions & 1 deletion docs/coherence/070_wka.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Copyright (c) 2020, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Well Known Addressing
:description: Coherence Operator Documentation - Well Known Addressing and Cluster Discovery
:keywords: oracle coherence, kubernetes, operator, documentation, Well Known Addressing and Cluster Discovery, WKA


== Well Known Addressing and Cluster Discovery

Expand Down
4 changes: 3 additions & 1 deletion docs/coherence/080_persistence.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, 2024, Oracle and/or its affiliates.
Copyright (c) 2020, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Coherence Persistence
:description: Coherence Operator Documentation - Configure Coherence Persistence
:keywords: oracle coherence, kubernetes, operator, documentation, configure Coherence Persistence, persistence

Coherence persistence is a set of tools and technologies that manage the persistence and recovery of Coherence
distributed caches. Cached data can be persisted so that it can be quickly recovered after a catastrophic failure
Expand Down
5 changes: 4 additions & 1 deletion docs/coherence/090_ipmonitor.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,15 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2021, 2024, Oracle and/or its affiliates.
Copyright (c) 2021, 2025, Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Coherence IPMonitor
:description: Coherence Operator Documentation - Coherence IPMonitor
:keywords: oracle coherence, kubernetes, operator, documentation, IPMonitor


== Coherence IPMonitor

Expand Down
2 changes: 2 additions & 0 deletions docs/installation/01_installation.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
///////////////////////////////////////////////////////////////////////////////

= Coherence Operator Installation
:description: Coherence Operator Documentation - Coherence Operator Installation
:keywords: oracle coherence, kubernetes, operator, documentation, Coherence Operator Installation

The Coherence Operator is available as an image from the GitHub container registry `container-registry.oracle.com/middleware/coherence-operator:{operator-version}` that can
easily be installed into a Kubernetes cluster.
Expand Down
4 changes: 3 additions & 1 deletion docs/installation/02_pre_release_versions.adoc
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
///////////////////////////////////////////////////////////////////////////////

Copyright (c) 2020, Oracle and/or its affiliates.
Copyright (c) 2020, 2025 Oracle and/or its affiliates.
Licensed under the Universal Permissive License v 1.0 as shown at
http://oss.oracle.com/licenses/upl.

///////////////////////////////////////////////////////////////////////////////

= Accessing Pre-Release Versions
:description: Coherence Operator Documentation - Accessing Pre-Release Versions
:keywords: oracle coherence, kubernetes, operator, documentation, Accessing Pre-Release Versions

Pre-release version of the Coherence Operator are made available from time to time.

Expand Down
3 changes: 3 additions & 0 deletions docs/installation/04_obtain_coherence_images.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@
///////////////////////////////////////////////////////////////////////////////

= Obtain Coherence Images
:description: Coherence Operator Documentation - Obtain Coherence Images
:keywords: oracle coherence, kubernetes, operator, documentation, Obtain Coherence Images, images


For most use-cases we expect the developer to provide a suitable Coherence application image to be
run by the operator. For POCs, demos and experimentation the Coherence Operator uses the OSS Coherence CE image
Expand Down
Loading
Loading