Skip to content
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

Merged
merged 9 commits into from
Aug 29, 2022

Conversation

SignorMercurio
Copy link
Contributor

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

  • 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

  • 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)

  • doc
    (Your PR contains doc changes)

  • doc-complete
    (Docs have been already added)

@github-actions github-actions bot added the doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. label Aug 21, 2022
@SignorMercurio
Copy link
Contributor Author

@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.
Copy link
Member

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?

Copy link
Member

@Anonymitaet Anonymitaet left a 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).
Copy link
Member

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?

Copy link
Contributor Author

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.

Copy link
Member

@Anonymitaet Anonymitaet Aug 22, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, I see (as below)
image

Sorry I got the sites mixed up 😝

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

No. They're under the same site. I'll handle this alongside with fixing all back links to getting-started-standalone.md

site2/docs/reference-configuration.md Outdated Show resolved Hide resolved
@Anonymitaet Anonymitaet added this to the 2.11.0 milestone Aug 22, 2022
@Anonymitaet
Copy link
Member

/pulsarbot run-failure-checks

3 similar comments
@SignorMercurio
Copy link
Contributor Author

/pulsarbot run-failure-checks

@SignorMercurio
Copy link
Contributor Author

/pulsarbot run-failure-checks

@SignorMercurio
Copy link
Contributor Author

/pulsarbot run-failure-checks

@urfreespace urfreespace merged commit ac640d9 into apache:master Aug 29, 2022
@SignorMercurio SignorMercurio deleted the config-docs-migrate branch August 29, 2022 02:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants