//#H Header ##//
include::vars/render-vars.adoc[]
include::vars/document-vars.adoc[]
include::vars/redhat-vars.adoc[]
include::vars/customer-vars.adoc[]
include::content/000_vars.adoc[]
include::locale/attributes.adoc[]

// Adding logo to the coverpage.
// Change the pdfwidth to improve embedding
ifeval::["{customerlogo}" != "empty"]
:title-logo-image: image:{customerlogo}[pdfwidth=50%,align=center]
endif::[]

= {subject}: {customer} - {description}

// M = mandatory
// R = recommended
// O = optional
// H = header
// 
// This document describes the different sections:
//  https://docs.google.com/document/d/1qGsgsE0tg6oHOKS178pF6IkmVSF_yQTiXr29gSsWQfU/edit#heading=h.66y4kqbj468a
// 
// The sections have also been described here: 
//  https://source.redhat.com/groups/public/gcs_asociates_success_enablement/tsm_adp/global_enablement/content_strategy_programs/engagementjournalstandardization/consulting_engagement_report_cer_wiki/consulting_engagement_report_cer_components__raci
// 
// The markings for mandatory/recommended/optional come from this document and this
// page, which has been aligned with legal.
// 
//## ##//

//#M The table of content will allow the reader to quickly flip to the sections they are interested in throughout the document. The AsciiDoc Render should create it automatically, though it is the owners responsibility to ensure its accuracy. The prefaces is a required section and covers basic legalities and document information. ##//
<<<
toc::[]

<<<
include::content/legal-approved/preface.adoc[leveloffset=+1]
//## ##//

//#H Header bit ##//
<<<
== Project Information
//## ##//

//#M This section provides general information about document ownership and Red Hat project team and customer participants. ##//
=== Originator 
include::content/010_originator.adoc[leveloffset=+3]

=== Owner
include::content/020_owner.adoc[leveloffset=+3]
//## ##//

//#R The document conventions section is provided so the customer understands the markup. ##//
=== Document Conventions
include::content/030_document-conventions.adoc[leveloffset=+3]
//## ##//

//#M Will you need an additional copies segment? ##//
=== Additional Copies
include::content/040_additional-copies.adoc[leveloffset=+3]
//## ##//

//#M The participants section describes all participants and is very valuable for future engagements. Will this be provided? ##//
[#participants]
=== Participants of the Engagement

==== Red Hat
include::content/050_red-hat-participants.adoc[leveloffset=+4]

==== {customer}
include::content/060_customer-participants.adoc[leveloffset=+4]
//## ##//

//#M The executive summary is the part read most by customers. It captures the work done in a summarized, high-level way. ##//
<<<
== Executive Summary
include::content/070_executive-summary.adoc[leveloffset=+2]
//## ##//

//#H Header ##//
<<<
== Overview
//## ##//

//#R Will a short description which explains what the customer is or does be provided? ##//
=== About {cust}
include::content/080_about-the-customer.adoc[leveloffset=+3]
//## ##//

//#R Will a list of documentation as provided by the customer be provided? This list could be empty, showing a documentation issue. ##//
=== Documentation Provided By {cust}
include::content/090_customer-provided-documentation.adoc[leveloffset=+3]
//## ##//

//#M Describe the approach taken? ##//
=== Purpose And Engagement Approach
include::content/100_purpose-and-approach.adoc[leveloffset=+3]
//## ##//

//#M Describe, in short, the scope of the engagement? ##//
=== Scope Summary
include::content/110_scope-summary.adoc[leveloffset=+3]
//## ##//

//#R Provide requirements as they came up during the engagement? ##//
=== Engagement Requirement Criteria
include::content/120_requirement_criteria.adoc[leveloffset=+3]
//## ##//

//#O Is this a navigate? If not, this topic could be removed. ##//
== Navigate
include::content/130_navigate.adoc[leveloffset=+2]
//## ##//

//#H Header ##//
<<<
== Implementation Details
//## ##//

//#R Add a daily journal? Recommened for short projects, < 3 weeks ##//
=== Journal
include::content/140_journal.adoc[leveloffset=+3]
//## ##//

//#O Is this an AI-Accelerator? ##//
// this is included ONLY if the AI-Accelerator is selected in
// init-cer.
ifeval::[ "{included_cer_AI-Accelerator}" == "true"]
<<<
include::content/150_ai-accelerator-pre-implementation.adoc[leveloffset=+2]
endif::[]

//#O Is this an MLOps-Foundation? ##//
// this is included ONLY if the MLOps-Foundation is selected in
// init-cer.
ifeval::[ "{included_cer_MLOps-Foundation}" == "true"]
<<<
include::content/160_mlops-foundation-pre-implementation.adoc[leveloffset=+2]
endif::[]

//#R Describe the deployed architecture? This is provided mostly through the canned contents! ##//
<<<
=== Deployed Architecture
include::content/170_architecture.adoc[leveloffset=+3]
//## ##//

//#M Describe the technical implementation? Mostly provided through the canned contents! ##//
<<<
=== Technical Implementation
include::content/180_implementation.adoc[leveloffset=+3]
//## ##//

//#M Will there a validation procedure be used? ##//
<<<
=== Validation Procedure
include::content/190_validation.adoc[leveloffset=+3]
//## ##//

//#R Provide details on knowledge transferred and how this is done? (workshops, docs, etc) ##//
<<<
=== Knowledge Transfer
include::content/200_knowledge-transfer.adoc[leveloffset=+3]
//## ##//

//#R When we run into challenges, this section helps describe them. Will they be described? ##//
<<<
=== Challenges, Resolutions, and Recommendations
include::content/210_challenges.adoc[leveloffset=+3]
//## ##//

//#O Is this an OCP healthcheck? ##//
// this is included ONLY if the OCP 4 archreview is selected in
// init-cer.
ifeval::[ "{included_cer_OCP-4x-healthcheck}" == "true"]
include::content/220_healthcheck.adoc[opts=optional]
endif::[]
// this is included ONLY if the 'App-Practice-BRA-HealthCheck-RHSSO-On-OCP-4x' is selected in init-cer.
ifeval::[ "{included_cer_App-Practice-BRA-HealthCheck-RHSSO-On-OCP-4x}" == "true"]
== Health Check do Middleware {rhsso}
include::content/230_health-check.adoc[opts=optional, leveloffset=+2]
endif::[]
//#O is this an OpenShift AI healthcheck? ##//
// this is included ONLY if the 'OpenShift-AI-healthcheck' is selected in init-cer.
ifeval::[ "{included_cer_OpenShift-AI-healthcheck}" == "true"]
include::content/220_healthcheck.adoc[opts=optional]
endif::[]
//## ##//

//#H Header ##//
<<<
== Recommendations
//## ##//

//#M Provide some technical next steps? ##//
=== Technical Next Steps
include::content/250_recommendations-technical.adoc[leveloffset=+3]
//## ##//

//#R Include relevant training chapter? This is all canned content! ##//
=== Relevant Training
include::content/260_recommendations-relevant-training.adoc[leveloffset=+3]
//## ##//

//#O Include other recommendations? ##//
=== Other
include::content/270_recommendations-other.adoc[leveloffset=+3]
//## ##//

//#O Describe post engagement risks? ##//
<<<
== Post-Engagement Risks

=== Scalability and Supportability Risks
include::content/280_scaling-supportability-risks.adoc[leveloffset=+3]
//## ##//

//#M The glossary describes all acronyms. It comes from the canned contents, add it? ##//
<<<
[appendix]
== Glossary
include::content/290_glossary.adoc[leveloffset=+2]
//## ##//

//#O Any other, additional appendices? This may come from the selected canned contents, so be careful with leaving this out. ##//
<<<
// It is expected that anyone using additional-appendices.adoc will include one or more [appendix] blocks
include::content/300_additional-appendices.adoc[leveloffset=+1]
//## ##//

//#O Will the relevant links be provided in a separate list? ##//
<<<
[appendix]
== Relevant Links
include::content/310_relevant-links.adoc[leveloffset=+2]
//## ##//

//#M Add the original statement of work. ##//
<<<
[appendix]
== Statement of Work
include::content/320_statement-of-work.adoc[leveloffset=+2]
//## ##//

//#M Maintain the revision table ##//
<<<
[appendix]
== Revisions
include::content/330_revisions.adoc[leveloffset=+2]
//## ##//

//#O Add the subscriptions section? ##//
<<<
include::content/legal-approved/subscriptions.adoc[leveloffset=+1]
//## ##//

//#R Add the support section? ##//
<<<
include::content/legal-approved/support.adoc[leveloffset=+1]
//## ##//
