From 0b9c998d8afffa6ec51d92a14614def5c36c1e26 Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephenfin@redhat.com>
Date: Thu, 13 Mar 2025 15:10:11 +0000
Subject: [PATCH] Remove contributor specs
There is only one and it was never implemented. Remove the directory.
Change-Id: Ibfffe7936556a626b407deca0e8de17b45db5313
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
---
doc/source/contributor/index.rst | 1 -
.../specs/command-objects/example.rst | 86 -------------------
doc/source/contributor/specs/commands.rst | 44 ----------
.../contributor/specs/network-topology.rst | 44 ----------
4 files changed, 175 deletions(-)
delete mode 100644 doc/source/contributor/specs/command-objects/example.rst
delete mode 100644 doc/source/contributor/specs/commands.rst
delete mode 100644 doc/source/contributor/specs/network-topology.rst
diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst
index 2aa9498f1b..445aac92d1 100644
--- a/doc/source/contributor/index.rst
+++ b/doc/source/contributor/index.rst
@@ -11,7 +11,6 @@
command-wrappers
command-errors
command-logs
- specs/commands
plugins
humaninterfaceguide
api/modules
diff --git a/doc/source/contributor/specs/command-objects/example.rst b/doc/source/contributor/specs/command-objects/example.rst
deleted file mode 100644
index fa559433e2..0000000000
--- a/doc/source/contributor/specs/command-objects/example.rst
+++ /dev/null
@@ -1,86 +0,0 @@
-=======
-example
-=======
-
-This is a specification for the ``example`` command object. It is not intended
-to be a complete template for new commands since other actions, options
-and/or arguments may be used. You can include general specification information
-before the commands below. This information could include links to related material
-or descriptions of similar commands.
-
-[example API name] [example API version]
-
-example create
---------------
-
-Create new example
-
-.. program:: example create
-.. code:: bash
-
- openstack example create
- <name>
-
-.. describe:: <name>
-
- New example name
-
-example delete
---------------
-
-Delete example(s)
-
-.. program:: example delete
-.. code:: bash
-
- openstack example delete
- <example> [<example> ...]
-
-.. describe:: <example>
-
- Example(s) to delete (name or ID)
-
-example list
-------------
-
-List examples
-
-.. program:: example list
-.. code:: bash
-
- openstack example list
-
-example set
------------
-
-Set example properties
-
-.. program:: example set
-.. code:: bash
-
- openstack example set
- [--name <new-name>]
- <example>
-
-.. option:: --name <new-name>
-
- New example name
-
-.. describe:: <example>
-
- Example to modify (name or ID)
-
-example show
-------------
-
-Display example details
-
-.. program:: example show
-.. code:: bash
-
- openstack example show
- <example>
-
-.. describe:: <example>
-
- Example to display (name or ID)
diff --git a/doc/source/contributor/specs/commands.rst b/doc/source/contributor/specs/commands.rst
deleted file mode 100644
index f9d757e785..0000000000
--- a/doc/source/contributor/specs/commands.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-=============
-Command Specs
-=============
-
-Specifications for new commands, objects and actions are listed below.
-These specifications have not been implemented. See
-:ref:`command-list` for implemented commands and
-:ref:`command-structure` for implemented objects and actions.
-
-It is optional to propose a specifications patch for new commands,
-objects and actions here before submitting the implementation. Once your
-specifications patch merges then you may proceed with the implementation.
-Your implementation patches should move applicable portions of the
-specifications patch to the official :ref:`command-list`
-and :ref:`command-structure` documentation.
-
-Objects Specs
--------------
-
-Add specifications for new objects based on the ``example`` object.
-
-Actions Specs
--------------
-
-Add specifications for new actions based on the ``example`` action.
-
-.. toctree::
- :maxdepth: 1
-
- network-topology
-
-Commands Specs
---------------
-
-Add specifications for new commands based on the commands for the
-``example`` object. The ``example`` commands are not intended to
-be a complete template for new commands since other actions, options
-and/or arguments may be used.
-
-.. toctree::
- :glob:
- :maxdepth: 2
-
- command-objects/*
diff --git a/doc/source/contributor/specs/network-topology.rst b/doc/source/contributor/specs/network-topology.rst
deleted file mode 100644
index 6789ee975f..0000000000
--- a/doc/source/contributor/specs/network-topology.rst
+++ /dev/null
@@ -1,44 +0,0 @@
-================
-network topology
-================
-
-A **network topology** shows a topological graph about
-devices which connect to the specific network. Also, it
-will return availability information for each individual
-device within the network as well. One other thing to note
-is that it is the intention for OSC to collect data from
-existing REST APIs
-
-Network v2
-
-network topology list
----------------------
-
-List network topologies
-
-.. program:: network topology list
-.. code:: bash
-
- openstack network topology list
- [--project <project>]
-
-.. option:: --project <project>
-
- List network topologies for given project
- (name or ID)
-
-network topology show
----------------------
-
-Show network topology details
-
-.. program:: network topology show
-.. code:: bash
-
- openstack network topology show
- <network>
-
-.. _network_topology_show-network:
-.. describe:: <network>
-
- Show network topology for a specific network (name or ID)