DOP-3438: Remove devhub data paths (#437)

* DOP-3438: Remove devhub data paths

* Remove devhub from rstspec.toml and test_data

Author: i80and

snooty/parser.py

@@ -71,7 +71,7 @@
 from .n import FileId, SerializableType, TocTreeDirectiveEntry
 from .openapi import OpenAPI
 from .page import Page, PendingTask
-from .postprocess import DevhubPostprocessor, Postprocessor, PostprocessorResult
+from .postprocess import Postprocessor, PostprocessorResult
 from .target_database import ProjectInterface, TargetDatabase
 from .types import BuildIdentifierSet, ParsedBannerConfig, ProjectConfig, StaticAsset
 from .util import RST_EXTENSIONS
@@ -940,7 +940,7 @@ def _locate_text(text: str) -> int:
             if "date" in node:
                 doc.options["date"] = node["date"]
 
-        elif key in {"devhub:author", ":og", ":twitter"}:
+        elif key in {":og", ":twitter"}:
             # Grab image from options array and save as static asset
             image_argument = options.get("image")
 
@@ -1554,9 +1554,7 @@ def __init__(
         self.prefix = [self.config.name, username, branch]
 
         self.pages = PageDatabase(
-            lambda: DevhubPostprocessor(self.config, self.targets.copy_clean_slate())
-            if self.config.default_domain == "devhub"
-            else Postprocessor(self.config, self.targets.copy_clean_slate())
+            lambda: Postprocessor(self.config, self.targets.copy_clean_slate())
         )
 
         self.asset_dg: "networkx.DiGraph[FileId]" = networkx.DiGraph()

snooty/postprocess.py

@@ -1912,134 +1912,3 @@ def clean_slug(slug: str) -> str:
         return root
 
     return slug
-
-
-class DevhubHandler(Handler):
-    # TODO: Identify directives that should be exposed in the rstspec.toml to avoid hardcoding
-    # These directives are represented as list nodes; they will return a list of strings
-    LIST_FIELDS = {"devhub:products", "devhub:tags", ":languages"}
-    # These directives have their content represented as children; they will return a list of nodes
-    BLOCK_FIELDS = {"devhub:meta-description"}
-    # These directives have their content represented as an argument; they will return a string
-    ARG_FIELDS = {"devhub:level", "devhub:type", ":atf-image"}
-    # These directives have their content represented as children, along with a series of options;
-    # they will return a dictionary with all options represented, and with the content represented as a list of nodes whose key is `children`.
-    OPTION_BLOCK_FIELDS = {":og", ":twitter"}
-
-    def enter_page(self, fileid_stack: FileIdStack, page: Page) -> None:
-        """To be called at the start of each page: reset the query field dictionary"""
-        self.query_fields: Dict[str, Any] = {}
-
-    def exit_page(self, fileid_stack: FileIdStack, page: Page) -> None:
-        """To be called at the end of each page: append the query field dictionary to the
-        top level of the page's class instance.
-        """
-        # Save page title to query_fields, if it exists
-        slug = clean_slug(fileid_stack.current.as_posix())
-        self.query_fields["slug"] = f"/{slug}" if slug != "index" else "/"
-        title = self.context[HeadingHandler].get_title(slug)
-        if title is not None:
-            self.query_fields["title"] = [node.serialize() for node in title]
-
-        page.query_fields = self.query_fields
-
-    def enter_node(self, fileid_stack: FileIdStack, node: n.Node) -> None:
-        """Extract fields from a page's AST and expose them as a queryable nested document in the page document."""
-        if not isinstance(node, n.Directive):
-            return
-
-        key = f"{node.domain}:{node.name}"
-
-        if key == "devhub:author":
-            # Create a dict unifying the node's options and children
-            author_obj: Dict[str, SerializableType] = {}
-            author_obj.update(node.options)
-            author_obj["children"] = [child.serialize() for child in node.children]
-
-            self.query_fields.setdefault("author", []).append(author_obj)
-        elif key == "devhub:related":
-            # Save list of nodes (likely :doc: roles)
-            self.query_fields[node.name] = []
-            if len(node.children) > 0:
-                first_child = node.children[0]
-                assert isinstance(first_child, n.Parent)
-                for item in first_child.children:
-                    paragraph = item.children[0]
-                    self.query_fields[node.name].append(
-                        paragraph.children[0].serialize()
-                    )
-        elif key in {":pubdate", ":updated-date"}:
-            date = node.options.get("date")
-            if date:
-                self.query_fields[node.name] = date
-        elif key in self.OPTION_BLOCK_FIELDS:
-            # Create a dict unifying the node's options and children
-            node_obj: Dict[str, SerializableType] = {}
-            node_obj.update(node.options)
-            node_obj["children"] = [child.serialize() for child in node.children]
-
-            self.query_fields[node.name] = node_obj
-        elif key in self.ARG_FIELDS:
-            if len(node.argument) > 0:
-                self.query_fields[node.name] = node.argument[0].value
-        elif key in self.BLOCK_FIELDS:
-            self.query_fields[node.name] = [
-                child.serialize() for child in node.children
-            ]
-        elif key in self.LIST_FIELDS:
-            self.query_fields[node.name] = []
-            if len(node.children) > 0:
-                first_child = node.children[0]
-                assert isinstance(first_child, n.Parent)
-                list_items = first_child.children
-                assert isinstance(list_items, List)
-                for item in list_items:
-                    text_candidate = get_deepest(item)
-                    assert isinstance(text_candidate, n.Text)
-                    self.query_fields[node.name].append(text_candidate.value)
-
-
-class DevhubPostprocessor(Postprocessor):
-    """Postprocess operation to be run if a project's default_domain is equal to 'devhub'"""
-
-    PASSES: Sequence[Sequence[Type[Handler]]] = [
-        [IncludeHandler],
-        [SubstitutionHandler],
-        [
-            HeadingHandler,
-            AddTitlesToLabelTargetsHandler,
-            ProgramOptionHandler,
-            TabsSelectorHandler,
-            ContentsHandler,
-            BannerHandler,
-            GuidesHandler,
-            OpenAPIHandler,
-        ],
-        [TargetHandler, IAHandler, NamedReferenceHandlerPass1],
-        [RefsHandler, NamedReferenceHandlerPass2, DevhubHandler],
-    ]
-
-    def finalize(self, context: Context, metadata: n.SerializedNode) -> None:
-        def clean_and_validate_page_group_slug(slug: str) -> Optional[str]:
-            """Clean a slug and validate that it is a known page. If it is not, return None."""
-            cleaned = clean_slug(slug)
-            if cleaned not in context[HeadingHandler]:
-                # XXX: Because reporting errors in config.toml properly is dodgy right now, just
-                # log to stderr.
-                logger.error(f"Cannot find slug '{cleaned}'")
-                return None
-
-            return cleaned
-
-        # Normalize all page group slugs
-        page_groups = {
-            title: [
-                slug
-                for slug in (clean_and_validate_page_group_slug(slug) for slug in slugs)
-                if slug
-            ]
-            for title, slugs in self.project_config.page_groups.items()
-        }
-
-        if page_groups:
-            metadata.update({"pageGroups": page_groups})

snooty/rstspec.toml

@@ -11,7 +11,6 @@ card_layout = ["default", "carousel"]
 card_style = ["default", "compact", "extra-compact"]
 card_type = ["small", "large"]
 charts_theme = ["light", "dark"]
-devhub_type = ["article", "quickstart", "how-to", "video", "live"]
 guide_categories = ["Getting Started"]
 mws_version = ["3.4", "3.6", "4.0", "4.2", "4.4", "5.0", "latest"]
 output_format = ["html"]
@@ -561,139 +560,6 @@ help = """A list of languages that this guide supports."""
 # """
 content_type = "list"
 
-###### DevHub
-[directive._devhub-base]
-required_context = "devhub"
-
-[directive._devhub-inline]
-inherit = "_devhub-base"
-argument_type = "string"
-
-[directive._devhub-block]
-inherit = "_devhub-base"
-content_type = "block"
-
-[directive."devhub:meta-description"]
-help = "Short and simple explanation of what the page is about. Try to include a target keyword and call to action. 125–155 Characters."
-inherit = "_devhub-block"
-example = """.. meta-description::
-
-   ${0:Short and simple explanation of what the page is about. Try to
-   include a target keyword and call to action. 125–155 Characters.}
-"""
-
-[directive."devhub:author"]
-help = "Author profile for the byline."
-example = """.. author::
-   :name: ${1:Eliot Horowitz}
-   :image: ${2:/path/to/image.jpg}
-   :location: ${3:New York, NY}
-   :company: ${4:MongoDB Inc.}
-   :title: ${5:Co-founder}
-   :website: ${6:http://www.example.com}
-   :twitter: ${7:https://twitter.com/eliothorowitz}
-   :github: ${8:https://github.com/erh}
-   :linkedin: ${9:https://www.linkedin.com/in/eliothorowitz/}
-
-   ${0:Author bio goes here.}
-"""
-inherit = "_devhub-block"
-options.name = "string"
-options.image = ["path", "uri"]
-options.location = "string"
-options.company = "string"
-options.title = "string"
-options.website = "uri"
-options.twitter = "uri"
-options.github = "uri"
-options.linkedin = "uri"
-
-
-[directive."devhub:type"]
-help = "Specify the type of document"
-inherit = "_devhub-inline"
-argument_type = "devhub_type"
-example = """.. type:: ${1|article,quickstart,how-to,video,live|}
-"""
-
-[directive."devhub:level"]
-help = "Specify the experience level of the audience: beginner, intermediate, or advanced"
-inherit = "_devhub-inline"
-argument_type = "user_level"
-example = """.. level:: ${1|beginner,intermediate,advanced|}
-"""
-
-[directive."devhub:tags"]
-help = "User-specified tags."
-example = """.. tags::
-
-   * ${0:first tag
-   * second tag
-   * third tag}
-"""
-inherit = "_devhub-block"
-content_type = "list"
-
-[directive."devhub:products"]
-help = "MongoDB products discussed in the article"
-example = """.. products::
-
-   * ${0:Realm
-   * MongoDB Atlas}
-"""
-inherit = "_devhub-block"
-content_type = "list"
-
-[directive."devhub:callout"]
-help = "Call out a specific University course, blog post, event, etc."
-inherit = "_devhub-block"
-example = """.. callout::
-   ${0:Call out specific content, such as an event, University course, etc.}
-"""
-
-[directive."devhub:introduction"]
-help = "Capture the reader's attention, offer the reason for the article's existence, and explain how the content will address the problem. Use the target keyword in the first 100 words."
-inherit = "_devhub-block"
-example = """.. introduction::
-
-   ${0:Capture the reader's attention, offer the reason for the article's existence,
-   and explain how the content will address the problem.
-   Use the target keyword in the first 100 words.}
-"""
-
-[directive."devhub:prerequisites"]
-help = "If your content has prerequisites, describe them here."
-inherit = "_devhub-block"
-example = """.. prerequisites::
-
-   ${0:If your content has prerequisites, describe them here}
-"""
-
-[directive."devhub:content"]
-help = "Body of the article. Use headers, links, lists, etc."
-inherit = "_devhub-block"
-example = """.. content::
-
-   ${0:Article content}
-"""
-
-[directive."devhub:summary"]
-help = "Summarize or conclude the article. Include a relevant call to action."
-inherit = "_devhub-block"
-example = """.. summary::
-
-   ${0:Summarize or conclude the article. Include a relevant call to action.}
-"""
-
-[directive."devhub:related"]
-help = "List of related articles."
-inherit = "_devhub-block"
-content_type = "list"
-example = """.. related::
-
-   * ${0: /path-to-first-related-article
-   * https://url-of-related-article}
-"""
 
 ##### Guides (LEGACY - do not deprecate until removed in dependent docs repos)
 [directive.hlist]