Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-805

[ContentX]: Downstream to upstream conversion of the Deploying to OpenShift Container Platform guide

XMLWordPrintable

    • Icon: Task Task
    • Resolution: Unresolved
    • Icon: Major Major
    • Quarkus-3.15 GA
    • None
    • documentation
    • None

      Scope: The goal of this task is to discuss approaches and identify issues in bringing the downstream Deploying your RHBQ applications to OpenShift Container Platform guide for publication upstream at https://quarkus.io/guides/ 

      For consideration (rdlugyhe proposals):

      Choose an overall structure or strategy:

        • Keep-it-the-Same Strategy (optimal):
          • Should we ask upstream if they would accept having assembly_quarkus-openshift.adoc plus modules in their repo?
        • Alternative Strategies:
          • Go Monolithic Strategy (Recommended 2nd choice):
            • Move everything into one large file in the community.
          • 3-into-2 Strategy (avoid):
            • Move content from the assembly (lines 1-25) to either the master.adoc in the product or into the modules in the community.

      Content updates:

        • Context Management:
          • Depending on the adopted strategy, manage the :context: attribute and cross-reference values accordingly.
        • Common Attributes:
          • Make attributes common to both community and product repositories.
        • Attribute Replacement:
          • Replace "Red Hat build of Quarkus" with an attribute.
        • Conditionalization:
          • Rewrite or conditionalize instances of the "Red Hat" company name and company-specific statements.
          • Example: "From {ProductLongName} 3.8, the DeploymentConfig object, deprecated in OpenShift, is also deprecated in {ProductLongName}. Deployment is the default and preferred deployment kind for the {ProductName} OpenShift extension."
        • Undocumented Capabilities:
          • Work with SMEs to identify undocumented capabilities that the community supports, but the product does not. Add these to the content and enclose them in conditionals.
          • Example: "{CompanyName} supports only the following strategies in {ProductName}:"
        • Link Management:
          • Use conditionals to manage links to community and product guides.
          • Example: "** For information about how to create a {ProductName} project with Maven, see link:{URL_MAVEN_QUARKUS}[Developing and compiling your \{ProductLongName} applications with Apache Maven]." This might need to link to https://quarkus.io/guides/maven-tooling in the community.

              shjones@redhat.com Sheila Jones
              shjones@redhat.com Sheila Jones
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Created:
                Updated: