You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/08/21 13:09:47 UTC
[GitHub] [pulsar] SignorMercurio opened a new pull request, #17197: [fix][doc] Migrate config docs to pulsar-site
SignorMercurio opened a new pull request, #17197:
URL: https://github.com/apache/pulsar/pull/17197
### 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](https://pulsar.apache.org/tools/pulsar-config/2.11.0-SNAPSHOT/)). This PR aims to adjust the docs so that everything looks fine in the new site.
### Modifications
- Remove config docs that are auto-generated with code. Manually maintained ones are uneffected.
- Adjust the format of admonition.
- Correct the invalid links.
- Adjust sidebar structure.
### Verifying this change
- [x] Make sure that the change passes the CI checks.
This change is a trivial rework / code cleanup without any test coverage.
### Does this pull request potentially affect one of the following parts:
- Dependencies (does it add or upgrade a dependency): no
- The public API: no
- The schema: no
- The default values of configurations: no
- The wire protocol: no
- The rest endpoints: no
- The admin cli options: no
- Anything that affects deployment: no
### 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)
- [x] `doc`
(Your PR contains doc changes)
- [ ] `doc-complete`
(Docs have been already added)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] tisonkun commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
tisonkun commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r963458889
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
Review Comment:
<img width="1727" alt="image" src="https://user-images.githubusercontent.com/18818196/188595386-3cf2cf17-2c9d-41a4-9425-de1feb341bf7.png">
No. They're under the same site. I'll handle this alongside with fixing all back links to `getting-started-standalone.md`
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r951261821
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
Review Comment:
Oh, I see (as below)
<img width="578" alt="image" src="https://user-images.githubusercontent.com/50226895/185898263-d053483b-8b91-48e6-8fa4-63a2c14a8406.png">
Sorry I got the sites mixed up 😝
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r951162040
##########
site2/docs/reference-configuration-standalone.md:
##########
@@ -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.
Review Comment:
I guess the reason for this change is `reference-configuration-standalone.md` is not an "internal" file, so the relative path becomes invalid, right?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r951166197
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
Review Comment:
The reason for this change is the same to https://github.com/apache/pulsar/pull/17197#discussion_r951162040?
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?
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
-- [BookKeeper](./reference-configuration-bookkeeper.md)
-- [Broker](./reference-configuration-broker.md)
-- [Client](./reference-configuration-client.md)
-- [Log4j](./reference-configuration-log4j.md)
-- [Log4j shell](./reference-configuration-log4j-shell.md)
-- [Standalone](./reference-configuration-standalone.md)
-- [WebSocket](./reference-configuration-websocket.md)
-- [Pulsar proxy](./reference-configuration-pulsar-proxy.md)
-- [ZooKeeper](./reference-configuration-zookeeper.md)
\ No newline at end of file
+For a full list of configuration of different components, please visit the [Pulsar Reference](https://pulsar.apache.org/reference).
Review Comment:
```suggestion
For a full list of the configuration of different components, see [Pulsar Reference](https://pulsar.apache.org/reference).
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#issuecomment-1227919244
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#issuecomment-1227195021
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r951261821
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
Review Comment:
Oh, I see (as below)
<img width="614" alt="image" src="https://user-images.githubusercontent.com/50226895/185897958-57f4cc6e-9f17-4a38-90e2-a8dffd4aadcb.png">
Sorry I got the site mixed up 😝
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r952042006
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -124,14 +124,10 @@ public int compare(Field o1, Field o2) {
}
protected String prefix = """
- :::note
-
- This page is automatically generated from code files.
+ !> This page is automatically generated from code files.
Review Comment:
Important content in Docsify. You can find it in Docify Docs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] urfreespace merged pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
urfreespace merged PR #17197:
URL: https://github.com/apache/pulsar/pull/17197
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#issuecomment-1226973638
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#issuecomment-1221735571
@Anonymitaet PTAL
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] urfreespace commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
urfreespace commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r952036583
##########
pulsar-broker-common/src/main/java/org/apache/pulsar/broker/BaseGenerateDocumentation.java:
##########
@@ -124,14 +124,10 @@ public int compare(Field o1, Field o2) {
}
protected String prefix = """
- :::note
-
- This page is automatically generated from code files.
+ !> This page is automatically generated from code files.
Review Comment:
what's this `!>`?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on a diff in pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on code in PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#discussion_r951171510
##########
site2/docs/reference-configuration.md:
##########
@@ -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).
Review Comment:
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.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] SignorMercurio commented on pull request #17197: [fix][doc] Migrate config docs to pulsar-site
Posted by GitBox <gi...@apache.org>.
SignorMercurio commented on PR #17197:
URL: https://github.com/apache/pulsar/pull/17197#issuecomment-1228698186
/pulsarbot run-failure-checks
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org