Uploaded image for project: 'OpenShift Service Mesh'
  1. OpenShift Service Mesh
  2. OSSM-3109

[Jupiter] Ensure all service mesh files have an abstract

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Obsolete
    • Icon: Major Major
    • None
    • None
    • Documentation
    • None

      Jupiter checklist - https://docs.engineering.redhat.com/pages/viewpage.action?spaceKey=JUP&title=Jupiter+Source+files+readiness+Checklist

      Ensure that every file has an abstract.

      Modules and assemblies are required to have an abstract that is at least 2 sentences long. Write a short introductory paragraph that provides an overview of the module or assembly.

      The first paragraph will be identified by Jupiter as abstract and its contents are going to be used to provide metadata for search engines.

      Abstract should not contain any numbered or unnumbered steps. Abstracts can't be in a note format.

       
      [id="title_\{context}"]
      = Title
       
      This is a short description of the file's content.
      It contains more than one line.
       

       

      See the Modules tab of the OSSM and DT Jupiter checklist

      https://docs.google.com/spreadsheets/d/1nGbJeLtcEarHZ4NWIzDzKhXWrH-12dKKJLloQP8Do0Y/edit#gid=1782919005 

            gmonahan Gwynne Monahan
            jstickler Julie Stickler (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

              Created:
              Updated:
              Resolved: