-
Notifications
You must be signed in to change notification settings - Fork 3.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[fix][doc] Migrate config docs to pulsar-site #17197
[fix][doc] Migrate config docs to pulsar-site #17197
Conversation
Signed-off-by: Mercurio <[email protected]>
@Anonymitaet PTAL |
@@ -1404,13 +1404,13 @@ Deploy the schema compatibility checker for a specific schema type to enforce sc | |||
|
|||
### schemaCompatibilityStrategy | |||
|
|||
The schema compatibility strategy at broker level, see [here](schema-evolution-compatibility.md#schema-compatibility-check-strategy) for available values. | |||
The schema compatibility strategy at broker level, see [here](https://pulsar.apache.org/docs/next/schema-evolution-compatibility/#schema-compatibility-check-strategy) for available values. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess the reason for this change is reference-configuration-standalone.md
is not an "internal" file, so the relative path becomes invalid, right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@urfreespace
Could you please review this PR from a technical perspective?
Thank you! 😊
@@ -4,14 +4,6 @@ title: Pulsar configuration | |||
sidebar_label: "Pulsar configuration" | |||
--- | |||
|
|||
You can manage Pulsar configuration by configuration files in the [`conf`](https://github.com/apache/pulsar/tree/master/conf) directory of a Pulsar [installation](getting-started-standalone.md). | |||
You can manage Pulsar configuration by configuration files in the [`conf`](https://github.com/apache/pulsar/tree/master/conf) directory of a Pulsar [installation](https://pulsar.apache.org/docs/next/getting-started-standalone). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The reason for this change is the same to #17197 (comment)?
I guess no because reference-configuration.md
is still in the same repo as getting-started-standalone.md
, getting-started-standalone/
is still valid, correct?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
No, link getting-started-standalone.md
is not valid here because here is another site, not the Docusaurus site. But the "Markdown Link" syntax here is Docusaurus feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Co-authored-by: Anonymitaet <[email protected]>
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java
Show resolved
Hide resolved
…ated Signed-off-by: Mercurio <[email protected]>
/pulsarbot run-failure-checks |
3 similar comments
/pulsarbot run-failure-checks |
/pulsarbot run-failure-checks |
/pulsarbot run-failure-checks |
Motivation
Pulsar configuration docs are going to be migrated to https://pulsar.apache.org/reference (Not available currently, will be after apache/pulsar-site#169 is merged. Current version is deployed here). This PR aims to adjust the docs so that everything looks fine in the new site.
Modifications
Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
Does this pull request potentially affect one of the following parts:
Documentation
Check the box below or label this PR directly.
Need to update docs?
doc-required
(Your PR needs to update docs and you will update later)
[]
doc-not-needed
(Please explain why)
doc
(Your PR contains doc changes)
doc-complete
(Docs have been already added)