Skip to content

chore: update documentation to clarify installation options and emphasize the OpenCHAMI Tutorial as the recommended starting point#102

Merged
alexlovelltroy merged 1 commit into
mainfrom
chore/clarify-install-options
Jun 5, 2026
Merged

chore: update documentation to clarify installation options and emphasize the OpenCHAMI Tutorial as the recommended starting point#102
alexlovelltroy merged 1 commit into
mainfrom
chore/clarify-install-options

Conversation

@alexlovelltroy

Copy link
Copy Markdown
Member

Description

This pull request updates OpenCHAMI documentation and blog posts to emphasize the new, recommended deployment tutorial and clarify the legacy status of older deployment methods (such as Docker Compose and LANL-specific recipes). The changes improve clarity for new users, direct them to the most up-to-date resources, and clearly mark deprecated or legacy content throughout guides and blog posts.

Major documentation and content updates:

1. Emphasizing the new OpenCHAMI Tutorial and recommended deployment method

  • Updated guides and blog posts to recommend the OpenCHAMI Tutorial as the primary resource for new users, highlighting its use of Podman Quadlets and the Release RPM. Alternative and legacy deployment methods are now clearly marked as such. [1] [2] [3] [4] [5] [6]

2. Marking legacy and deprecated deployment methods

  • Added notes and clarifications in blog posts and documentation to indicate that Docker Compose, LANL-specific, and quickstart recipes are legacy or deprecated, and not recommended for new users. Updated links and references to point to the new tutorial where appropriate. [1] [2] [3] [4] [5] [6] [7]

3. Improved organization and clarity in installation and deployment guides

  • Refactored the installation handbook to present the tutorial as the primary path, moved alternative and organization-specific recipes to separate sections, and provided a clear index of deployment options.

4. Updated references and links throughout documentation

  • Changed references from the quickstart and deployment-recipes repositories to the new tutorial, and updated language to reflect current best practices for new deployments. [1] [2] [3] [4] [5] [6]

5. Added clear warnings and notes for legacy content

  • Inserted notes and callouts in blog posts and guides to inform readers when they are viewing legacy or deprecated deployment instructions, and direct them to the current tutorial. [1] [2] [3] [4] [5]

These changes ensure new users are guided to the most reliable and up-to-date deployment approach, while still providing access to legacy methods for reference or advanced users.

Fixes #(issue)

Type of Change

  • Bug fix
  • New feature
  • Breaking change
  • Documentation update

For more info, see Contributing Guidelines.

…size the OpenCHAMI Tutorial as the recommended starting point

Signed-off-by: Alex Lovell-Troy <alovelltroy@lanl.gov>
@alexlovelltroy alexlovelltroy requested a review from rainest June 5, 2026 17:32

@davidallendj davidallendj left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@alexlovelltroy alexlovelltroy merged commit 07bd0d5 into main Jun 5, 2026
4 checks passed
@synackd synackd deleted the chore/clarify-install-options branch June 5, 2026 18:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants