DOC-1160 single source SM for Cloud cluster config #1041
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
micheleRP
changed the title
Co-authored-by: Jake Cahill <[email protected]>
There was a problem hiding this comment.
Not in a diff, but I think we should tweak this as well as the Use the Schema Registry API doc a little bit since the NOTE near the start of the page looks like this in Cloud docs:
The Schema Registry is built into Redpanda, and you can use it with the Schema Registry API or with Redpanda Cloud. This section describes Schema Registry operations available in Redpanda Cloud.
Instead of saying just "Redpanda Cloud" it would be better to specify that it's the Cloud UI
| endif::[] | ||
|
|
||
| ifndef::env-cloud[] | ||
| [[max-threads]] |
There was a problem hiding this comment.
Double checking that we want to add this custom section ID
There was a problem hiding this comment.
omg, I think copilot popped that in. Good eye, @kbatuigas!
| endif::[] | ||
|
|
||
| ifdef::env-cloud[] | ||
| TIP: You can also view logs in Redpanda Cloud]. |
There was a problem hiding this comment.
| TIP: You can also view logs in Redpanda Cloud]. | |
| TIP: You can also view logs in Redpanda Cloud. |
Maybe specify Cloud UI?
There was a problem hiding this comment.
yes, thanks, I've fixed
| :page-layout: index | ||
| :page-categories: Development, Stream Processing, Data Transforms | ||
| :page-categories: Development, Stream Processing, Data Transforms | ||
| // tag::single-source[] |
There was a problem hiding this comment.
Do we need the single-source tag here? I think this is just an index page in Self-Managed because there is a standalone quickstart for k8s
There was a problem hiding this comment.
maybe not, but tagging it without using it does not do any harm, right @JakeSCahill? e.g., in the cluster properties reference, I left tags around properties that were removed from Cloud just to save time in the future (since I think they'll be coming soon). Let me know if we should remove instead.
| ---- | ||
| endif::[] | ||
|
|
||
| ifdef::env-cloud[] |
There was a problem hiding this comment.
Just double checking - do we have an equivalent Cloud docs page yet where this content would display? I wasn't able to find it in #245
There was a problem hiding this comment.
no: initially the property for schema ID validation was added for Cloud, then it was removed.
There was a problem hiding this comment.
Not sure if it should be part of this PR, but we might need to also make sure that some of the values on this page such as ip and port are applicable in Cloud as well. I think Cloud has their own IP addresses/bootstrap server URLs
There was a problem hiding this comment.
perhaps @deniscoady can help here in terms of providing examples of the right ip/port
There was a problem hiding this comment.
Created this issue to verify steps: https://redpandadata.atlassian.net/browse/DOC-1211
| rpk cluster config set audit_excluded_principals '["User:principal1", "principal2"]' | ||
| rpk cluster config set audit_enabled true | ||
| rpk topic alter-config _redpanda.audit_log --set retention.ms=259200000 | ||
|
|
There was a problem hiding this comment.
These added lines are duplicates of the lines immediately below btw! So it displays twice here https://deploy-preview-1041--redpanda-docs-preview.netlify.app/current/manage/audit-logging/#enable-audit-logging (and not at all for the Cloud version of the page, please double check that that's correct)
| - xref:develop:config-topics.adoc[] | ||
| endif::[] | ||
|
|
||
| ifdef::env-cloud[] |
There was a problem hiding this comment.
Also double check - is this page https://deploy-preview-1041--redpanda-docs-preview.netlify.app/redpanda-cloud/manage/cluster-maintenance/audit-logging supposed to display more than these two sections?
Description
This single-sources the files necessary with redpanda-data/cloud-docs#245.
Single-Sourcing Enhancements:
// tag::single-source[]and// end::single-source[]tags to multiple files for better content reuse and consistency. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12] [13] [14] [15] [16] [17] [18] [19] [20] [21]Cloud and Non-Cloud Environment Adjustments:
modules/develop/pages/data-transforms/configure.adoc: Added conditional content for cloud and non-cloud environments to provide appropriate instructions based on the deployment environment. [1] [2]modules/develop/pages/data-transforms/deploy.adoc: Updated prerequisites and instructions for deploying data transforms, including conditional content for cloud and non-cloud environments. [1] [2] [3]modules/develop/pages/data-transforms/monitor.adoc: Added conditional content for monitoring data transforms based on the deployment environment. [1] [2]Documentation Updates:
local-antora-playbook.yml: Updated the branch reference forcloud-docstoDOC-666-Document-feature-Manage-form-factor-appropriate-cluster-configuration-properties-in-Console.modules/console/pages/ui/data-transforms.adoc: Updated the content to use{ui}for single-sourcing and improved descriptions and instructions for managing data transforms. [1] [2]Resolves https://redpandadata.atlassian.net/browse/DOC-1160
Review deadline: April 4
Page previews
Audit logging - SM
Checks