Skip to content

Add getting started guide#5

Merged
machacekondra merged 1 commit into
dcm-project:mainfrom
machacekondra:getting_started
Apr 7, 2026
Merged

Add getting started guide#5
machacekondra merged 1 commit into
dcm-project:mainfrom
machacekondra:getting_started

Conversation

@machacekondra

@machacekondra machacekondra commented Mar 24, 2026

Copy link
Copy Markdown
Contributor

Summary by Sourcery

Add a getting started guide for running DCM locally and link it from the main documentation index.

Build:

  • Update the hextra documentation theme dependency to version v0.12.1 in go.mod.

Documentation:

  • Introduce a Getting Started guide detailing local setup, optional KubeVirt integration, verification steps, and configuration options for DCM.
  • Link the new Getting Started guide from the main documentation landing page.

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Hey - I've left some high level feedback:

  • The compose.yaml download URL uses refs/heads/main; consider pinning this to a specific tag or commit to ensure the getting-started instructions remain stable as the gateway repo evolves.
  • Double-check that the configuration defaults listed in the table (e.g., POSTGRES_USER, POSTGRES_PASSWORD, KUBERNETES_NAMESPACE) exactly match the values in compose.yaml to avoid drift between docs and actual behavior.
Prompt for AI Agents
Please address the comments from this code review:

## Overall Comments
- The `compose.yaml` download URL uses `refs/heads/main`; consider pinning this to a specific tag or commit to ensure the getting-started instructions remain stable as the gateway repo evolves.
- Double-check that the configuration defaults listed in the table (e.g., `POSTGRES_USER`, `POSTGRES_PASSWORD`, `KUBERNETES_NAMESPACE`) exactly match the values in `compose.yaml` to avoid drift between docs and actual behavior.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Comment thread content/docs/getting-started/_index.md Outdated
Comment thread content/docs/getting-started/_index.md Outdated
Comment thread content/docs/getting-started/_index.md
Comment thread content/docs/getting-started/_index.md
Comment thread content/docs/getting-started/_index.md Outdated
Comment thread content/docs/getting-started/_index.md Outdated
@machacekondra machacekondra force-pushed the getting_started branch 2 times, most recently from 385ca00 to 86e7c21 Compare March 25, 2026 13:18
@machacekondra

Copy link
Copy Markdown
Contributor Author

@pkliczewski @chadcrum Here is the website running with the getting-started guide:
https://machacekondra.github.io/dcm-project.github.io/docs/getting-started/

Feel free to try. Everything should work just OK from latest images.
Except CLI, you need to have this PR in order to have dcm sp resource get my-dev-vm command working.

@machacekondra machacekondra force-pushed the getting_started branch 2 times, most recently from bc3ef5e to e2d1b82 Compare March 25, 2026 16:35
Comment thread content/docs/getting-started/create-placement-policy.md
@chadcrum chadcrum self-requested a review March 26, 2026 00:59

@chadcrum chadcrum 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.

I ran through the docs e2e successfully.

@machacekondra machacekondra force-pushed the getting_started branch 4 times, most recently from ed702e5 to 1a4db93 Compare March 26, 2026 11:41
@machacekondra

machacekondra commented Mar 26, 2026

Copy link
Copy Markdown
Contributor Author

I ran through the docs e2e successfully.

@chadcrum Thanks! I've added a new section decribing registering another provider. If you can try as well, would be great.
Again deployed here, for easier reading: https://machacekondra.github.io/dcm-project.github.io/docs/getting-started/

@gabriel-farache gabriel-farache left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

small nitpick, especially on how to create a catalog item but this may be part of another PR as this one focuses on a getting started with a given example


For a detailed explanation of the catalog item schema, see the [Catalog Item Schema](../../enhancements/catalog-item-schema/) enhancement.

Create a file called `small-vm.yaml` with the following content:

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Maybe we can add a section on how to build this file for another catalog item? Especially a link to the service type definition to let the users know what is currently shipped withing DCM and what can/should/must be defined in the catalog item level

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Yes that would be great to document as well. I think we need section of how to craete catalog-item as well as section how to create policies. So let's do it as follow up.

Comment thread content/docs/getting-started/local-setup.md
Signed-off-by: Ondra Machacek <omachace@redhat.com>
@machacekondra machacekondra merged commit 5717a81 into dcm-project:main Apr 7, 2026
2 checks passed
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.

5 participants