Update docs for control-plane monolith#19
Open
gciavarrini wants to merge 6 commits into
Open
Conversation
Replace api-gateway and separate managers with the single control-plane process, port 8080, and updated compose setup. Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
Run make check-format on PRs so docs/blog stay at 80 columns. Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
There was a problem hiding this comment.
Hey - I've found 1 issue, and left some high level feedback:
- In
architecture.md, the components table now describes an embedded OPA engine while the sequence diagram still models OPA as a separate participant; consider updating the diagram and surrounding text so the role of OPA is consistently represented as part of the control-plane process rather than an external service. - In
local-setup.mdand related getting-started docs, terminology alternates between “API gateway” and “control plane” (e.g., “The API gateway will be available at http://localhost:8080”); it would be clearer to standardize on “control plane” throughout those sections to match the new monolith architecture.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- In `architecture.md`, the components table now describes an embedded OPA engine while the sequence diagram still models OPA as a separate participant; consider updating the diagram and surrounding text so the role of OPA is consistently represented as part of the control-plane process rather than an external service.
- In `local-setup.md` and related getting-started docs, terminology alternates between “API gateway” and “control plane” (e.g., “The API gateway will be available at http://localhost:8080”); it would be clearer to standardize on “control plane” throughout those sections to match the new monolith architecture.
## Individual Comments
### Comment 1
<location path="Makefile" line_range="28-32" />
<code_context>
check-spell:
$(SPELLCHECK) "$(FILE)"
+
+format:
+ $(PRETTIER) --write --prose-wrap always --print-width 80 $(FORMAT_FILES)
+
+check-format:
+ $(PRETTIER) --check --prose-wrap always --print-width 80 $(FORMAT_FILES)
</code_context>
<issue_to_address>
**suggestion:** Avoid duplicating Prettier CLI flags between `format` and `check-format` targets.
Both `format` and `check-format` repeat `--prose-wrap` and `--print-width`. Please extract these into a shared `PRETTIER_FLAGS` (or similar) so formatting options are defined in one place and don’t drift between targets.
Suggested implementation:
```
FORMAT_FILES ?= content/docs/**/*.md content/blog/**/*.md
PRETTIER_FLAGS ?= --prose-wrap always --print-width 80
```
```
format:
$(PRETTIER) $(PRETTIER_FLAGS) --write $(FORMAT_FILES)
check-format:
$(PRETTIER) $(PRETTIER_FLAGS) --check $(FORMAT_FILES)
```
</issue_to_address>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
Show OPA as embedded in the Policy Manager, not a separate service. Use control-plane terminology in local setup. Assisted-By: Claude (Anthropic) Signed-off-by: Gloria Ciavarrini <gciavarrini@redhat.com>
|
with the formatting it's hard to tell what was changed and what was just formatted, could you split in 2 to make the review easier? |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Updates the DCM documentation site for the control-plane monolith.
The old docs still described api-gateway on :9080 and four separate manager services. Update them with the current stack: one control-plane process on :8080, compose under
control-plane/deploy/, and CLI config via--control-plane-url.Main content changes are in architecture, local setup, troubleshooting, policies, CLI configuration, and a few user-guide/blog references (Rego URLs, repo links).
Also adds
make format/make check-formatfor docs and blog markdown (80-column prose wrap), with.prettierignorefor the Hugo homepage and RemoteMD stubs. A CI workflow runs the format check automatically.Fixes: https://redhat.atlassian.net/browse/FLPATH-4407
--
Assisted-By: Claude (Anthropic)
Signed-off-by: Gloria Ciavarrini gciavarrini@redhat.com
Summary by Sourcery
Update DCM documentation and examples to reflect the unified control-plane monolith and new CLI configuration, and add automated markdown formatting tooling for docs and blog content.
Enhancements:
CI: