Add getting started guide#5
Conversation
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- The
compose.yamldownload URL usesrefs/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 incompose.yamlto 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.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
385ca00 to
86e7c21
Compare
|
@pkliczewski @chadcrum Here is the website running with the getting-started guide: Feel free to try. Everything should work just OK from latest images. |
bc3ef5e to
e2d1b82
Compare
chadcrum
left a comment
There was a problem hiding this comment.
I ran through the docs e2e successfully.
ed702e5 to
1a4db93
Compare
1a4db93 to
7921eca
Compare
@chadcrum Thanks! I've added a new section decribing registering another provider. If you can try as well, would be great. |
gabriel-farache
left a comment
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
Signed-off-by: Ondra Machacek <omachace@redhat.com>
7921eca to
a202c59
Compare
Summary by Sourcery
Add a getting started guide for running DCM locally and link it from the main documentation index.
Build:
Documentation: