Move docs test workflow and rm obsolete docs processes

This does:

* Adds a docs test workflow in the ci.yml
* Removes docs test from test.yml workflow (which tests the plugin)
* Deprecate --docs feature from plugin-template
  * remove docs_test option
  * remove template/docs
  * remove template/bootstrap/docs legacy content
  * remove ci_update_docs
  * make it no-ops
* Update various info across files

Closes: #901

.github/workflows/test.yml

@@ -22,7 +22,6 @@ jobs:
       matrix:
         env:
           - TEST: pulp
-          - TEST: docs
           - TEST: azure
           - TEST: gcp
           - TEST: s3

README.md

@@ -92,8 +92,6 @@ The following settings are stored in `template_config.yml`.
   latest_release_branch A pointer to the currently latest release branch (this is automatically
                         updated).
 
-  docs_test             Include a CI build for testing the 'make html' command for sphinx docs.
-
   os_required_packages  A list of packages to be installed on the host OS (Ubuntu) in the build
                         step.
 
@@ -229,12 +227,12 @@ provided by the plugin-template.
 
 # Add Documentation to a Pulp plugin
 
-The next step is to add documentation that can be hosted on
-[Read the Docs](https://readthedocs.org/).
-
-1. Run the `./plugin-template --docs` command to generate the docs.
+The next step is to add documentation.
+Pulp has a dedicated documentation tool that aggregates docs from subscribed plugins and handles
+its publishing.
 
-   ``$ ./plugin-template --docs PLUGIN_NAME``
+To learn more about how it works and how to include your plugin, check out
+[pulp-docs documentation](https://pulpproject.org/pulp-docs/docs/dev/).
 
 ## Discoverability
 
@@ -263,7 +261,7 @@ pulpcore.plugin.PulpPluginAppConfig]({{ plugin_name | snake }}/app/__init__.py)
 
 # Customizing Plugin Behavior
 
-First, look at the [overview](https://docs.pulpproject.org/pulpcore/plugins/plugin-writer/concepts/index.html) of Pulp Models to understand how Pulp fits these pieces together.
+First, look at the [overview](https://pulpproject.org/pulpcore/docs/dev/learn/plugin-concepts/) of Pulp Models to understand how Pulp fits these pieces together.
 
 Bootstrapping created various new endpoints (e.g. remote, repository and content).
 Additional information should be added to these to tell Pulp how to handle your content.

plugin-template

@@ -28,15 +28,12 @@ DEFAULT_SETTINGS = {
     "ci_base_image": "ghcr.io/pulp/pulp-ci-centos9",
     "ci_env": {},
     "ci_trigger": "{pull_request: {branches: ['*']}}",
-    "ci_update_docs": True,
     "core_import_allowed": [],
     "deploy_client_to_pypi": True,
     "deploy_client_to_rubygems": True,
     "deploy_to_pypi": True,
     "disabled_redis_runners": [],
-    "doc_requirements_from_pulpcore": False,
     "docker_fixtures": False,
-    "docs_test": True,
     "flake8_ignore": [],
     "flake8": True,
     "github_org": "pulp",
@@ -124,6 +121,12 @@ DEPRECATED_FILES = {
     ],
 }
 
+DOCS_OPTION_DEPRECATION_INFO = """\
+'--docs' option is deprecated (July, 2024):
+    Most docs intervention are now handled by pulp-docs.
+    See https://github.com/pulp/pulp-docs.\
+"""
+
 
 def main():
     parser = argparse.ArgumentParser(
@@ -194,9 +197,11 @@ def main():
         "--docs",
         action="store_true",
         help=textwrap.dedent(
-            """\
+            f"""\
                 Generate or update plugin documentation.
 
+                {DOCS_OPTION_DEPRECATION_INFO}
+
             """
         ),
     )
@@ -276,12 +281,6 @@ def main():
                         "\nLoaded plugin template config from "
                         "{path}/template_config.yml.\n".format(path=plugin_root_dir)
                     )
-                    if not config["docs_test"]:
-                        if config["ci_update_docs"]:
-                            print("There's no use updating the docs pipeline without using it.")
-                            print("Disabling 'ci_update_docs'.")
-                            config["ci_update_docs"] = False
-                            write_new_config = True
 
                     if args.verbose:
                         print("\nUsing the following config:\n")
@@ -334,6 +333,9 @@ def main():
         if getattr(args, section) or args.all
     ]
     for section in sections:
+        if section == "docs":
+            print(DOCS_OPTION_DEPRECATION_INFO)
+            continue
         write_template_section(config, section, plugin_root_dir, verbose=args.verbose)
 
     if write_new_config and not (args.generate_config or args.all):

templates/bootstrap/.bumpversion.cfg.j2

@@ -18,4 +18,3 @@ values =
 
 [bumpversion:file:./setup.py]
 
-[bumpversion:file:./docs/conf.py]

templates/bootstrap/.gitignore.j2

@@ -64,10 +64,6 @@ instance/
 # Scrapy stuff:
 .scrapy
 
-# Sphinx documentation
-docs/_build/
-docs/_static/
-
 # PyBuilder
 target/
 

templates/bootstrap/README.md.j2

@@ -2,7 +2,7 @@
 
 A Pulp plugin to support hosting your own {{ plugin_app_label | dash }}.
 
-For more information, please see the [documentation](docs/index.rst) or the [Pulp project page](https://pulpproject.org/).
+For more information, please see the [documentation](docs/index.md) or the [Pulp project page](https://pulpproject.org/).
 
 
 How to File an Issue

templates/docs/doc_requirements.txt.j2 → templates/bootstrap/doc_requirements.txt.j2

@@ -1,5 +1,2 @@
 {% include 'header.j2' %}
--r requirements.txt
-towncrier
-
 pulp-docs @ git+https://github.com/pulp/pulp-docs@main

templates/bootstrap/docs/index.md.j2

@@ -0,0 +1,12 @@
+# Welcome to Pulp {{ plugin_label | upper }}
+
+The `{{ plugin_label | upper }}` plugin extends pulpcore to support hosting python packages.
+This plugin is a part of the Pulp Project, and assumes some familiarity with the
+[pulpcore documentation](site:pulpcore/).
+
+If you are just getting started, we recommend:
+
+- [Getting Started with {{ plugin_label | upper }}](site:{{ plugin_name }}/docs/tutorials/getting-started.md),
+  for a starting out with a common use case.
+
+