This is an automated email from the ASF dual-hosted git repository.
bugraoz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new ac7b29abd70 fix(docs): remove trademark symbol and update section
titles for clarity (#54887)
ac7b29abd70 is described below
commit ac7b29abd707430c20492dcc5e83fbe44902bb0d
Author: Bugra Ozturk <[email protected]>
AuthorDate: Mon Aug 25 00:05:06 2025 +0200
fix(docs): remove trademark symbol and update section titles for clarity
(#54887)
* fix(docs): remove trademark symbol and update section titles for clarity
* Update airflow-ctl/docs/cli-and-env-variables-ref.rst
Co-authored-by: Jarek Potiuk <[email protected]>
* Update airflow-ctl/docs/index.rst
Co-authored-by: Jarek Potiuk <[email protected]>
---------
Co-authored-by: Jarek Potiuk <[email protected]>
---
airflow-ctl/docs/cli-and-env-variables-ref.rst | 4 +--
airflow-ctl/docs/index.rst | 6 ++--
airflow-ctl/docs/installation/dependencies.rst | 26 --------------
airflow-ctl/docs/installation/index.rst | 4 +--
.../docs/installation/supported-versions.rst | 42 ----------------------
airflow-ctl/docs/start.rst | 6 ++++
6 files changed, 12 insertions(+), 76 deletions(-)
diff --git a/airflow-ctl/docs/cli-and-env-variables-ref.rst
b/airflow-ctl/docs/cli-and-env-variables-ref.rst
index 4d577eafb99..a662dcdd728 100644
--- a/airflow-ctl/docs/cli-and-env-variables-ref.rst
+++ b/airflow-ctl/docs/cli-and-env-variables-ref.rst
@@ -18,8 +18,8 @@
Command Line Interface and Environment Variables Reference
==========================================================
-Command Line Interface
-''''''''''''''''''''''
+CLI
+'''
airflowctl has a very rich command line interface that allows for
many types of operation on a DAG, starting services, and supporting
diff --git a/airflow-ctl/docs/index.rst b/airflow-ctl/docs/index.rst
index 5e7cea898f5..ef75a99cb25 100644
--- a/airflow-ctl/docs/index.rst
+++ b/airflow-ctl/docs/index.rst
@@ -15,8 +15,8 @@
specific language governing permissions and limitations
under the License.
-What is airflowctl®?
-=====================
+What is airflowctl?
+===================
airflowctl is a command line tool that helps you manage and deploy Apache
Airflow environments.
.. toctree::
@@ -33,4 +33,4 @@ airflowctl is a command line tool that helps you manage and
deploy Apache Airflo
:caption: Usage
start
- cli-and-env-variables-ref
+ References <cli-and-env-variables-ref>
diff --git a/airflow-ctl/docs/installation/dependencies.rst
b/airflow-ctl/docs/installation/dependencies.rst
deleted file mode 100644
index 29c04f63f59..00000000000
--- a/airflow-ctl/docs/installation/dependencies.rst
+++ /dev/null
@@ -1,26 +0,0 @@
- .. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- .. http://www.apache.org/licenses/LICENSE-2.0
-
- .. Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Dependencies
-------------
-
-airflowctl dependencies
-''''''''''''''''''''''''''
-
-The ``apache-airflow-ctl`` PyPI basic package only installs what's needed to
get started.
-Additional packages can be installed depending on what will be useful in your
-environment.
diff --git a/airflow-ctl/docs/installation/index.rst
b/airflow-ctl/docs/installation/index.rst
index bdb0ce96bf5..d3f2062c297 100644
--- a/airflow-ctl/docs/installation/index.rst
+++ b/airflow-ctl/docs/installation/index.rst
@@ -16,7 +16,7 @@
under the License.
-Installation of airflowctl®
+Installation of airflowctl
----------------------------
.. contents:: :local:
@@ -27,8 +27,6 @@ Installation of airflowctl®
:hidden:
Prerequisites <prerequisites>
- Dependencies <dependencies>
- Supported versions <supported-versions>
Installing from sources <installing-from-sources>
Installing from PyPI <installing-from-pypi>
diff --git a/airflow-ctl/docs/installation/supported-versions.rst
b/airflow-ctl/docs/installation/supported-versions.rst
deleted file mode 100644
index 18a46b0d36c..00000000000
--- a/airflow-ctl/docs/installation/supported-versions.rst
+++ /dev/null
@@ -1,42 +0,0 @@
- .. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- .. http://www.apache.org/licenses/LICENSE-2.0
-
- .. Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Supported versions
-------------------
-
-Version Life Cycle
-``````````````````
-
-Apache airflowctl is compatible with Apache Airflow® versions 3.0.0 and later.
-
-Apache airflowctl version life cycle:
-
- .. This table is automatically updated by prek hook
scripts/ci/prek/supported_versions.py
- .. Beginning of auto-generated table
-
-========= ===================== ========= ===============
================= ================
-Version Current Patch/Minor State First Release Limited Support
EOL/Terminated
-========= ===================== ========= ===============
================= ================
-1 1.0.0 Supported TBD TBD
TBD
-========= ===================== ========= ===============
================= ================
-
- .. End of auto-generated table
-
-
-Limited support versions will be supported with security and critical bug fix
only.
-EOL versions will not get any fixes nor support.
-We **highly** recommend installing the latest airflowctl release which has
richer features.
diff --git a/airflow-ctl/docs/start.rst b/airflow-ctl/docs/start.rst
index 3e1f13dea16..fc879092c8c 100644
--- a/airflow-ctl/docs/start.rst
+++ b/airflow-ctl/docs/start.rst
@@ -18,6 +18,12 @@
Quick Start
-----------
+Let's first install ``airflowctl`` if you haven't already:
+
+From PyPI: :doc:`/installation/installing-from-pypi`
+
+From source: :doc:`/installation/installing-from-sources`
+
airflowctl is a command line tool that helps you manage your Airflow
deployments.
It is designed to be easy to use and provides a simple interface for managing
your Airflow environment.
