Skip to content

Conversation

@CaveEcho
Copy link

@CaveEcho CaveEcho commented Dec 24, 2024

if ["keepFile": true] starts The connector "The property keepFile must be false if the property processedFileSuffix is set"

✅ Contribution Checklist

if ["keepFile": true] starts The connector "The property keepFile must be false if the property processedFileSuffix is set"
@CaveEcho
Copy link
Author

CaveEcho commented Jan 8, 2025

Description
While following the YAML configuration example provided in the Pulsar documentation, I encountered a situation where setting keepFile to true while also setting processedFileSuffix causes an error:
“The property keepFile must be false if the property processedFileSuffix is set.”

This situation arises because the keepFile property must be set to false if processedFileSuffix is configured. To resolve this, I would like to suggest two possible approaches:

  1. Set keepFile to false when processedFileSuffix is configured, in order to avoid the error.
  2. Alternatively, if it’s not strictly necessary, remove the processedFileSuffix setting from the YAML example to help simplify the configuration.
    I hope these suggestions are helpful and clarify the intended configuration. Thank you for considering them!

@dave2wave
Copy link
Member

@lhotari ready to merge?

@lhotari
Copy link
Member

lhotari commented Oct 31, 2025

@lhotari ready to merge?

@dave2wave No. Like in most cases, contributors haven't applied the changes to the documentation in the way that takes Docusaurus docs and versioned_docs into account. The PR reviewer should help in addressing this and possibly handle this on behalf of the PR author. For example, I recently handled this in this PR: 7330ea9 .
In some cases, a PR is opened with a change made a versioned_docs file and in some case docs file without changes to versioned_docs.
There's some tooling and instructions at https://github.com/apache/pulsar-site?tab=readme-ov-file#updating-versioned-docs and https://pulsar.apache.org/contribute/document-contribution/. These instructions could be improved.
The tooling should also be improved so that a change made to a versioned_doc could be applied to docs folder automatically. I was planning to add that to https://github.com/apache/pulsar-site/blob/main/scripts/docs-tool.sh for making pulsar-site PR reviewers easier or let PR contributors handle this with some tooling like it's already possible with ./scripts/docs-tool.sh apply_last_commit_to_versioned_docs when you make the change to docs file and what the same change to be made to versioned_docs files.
I just feel that I shouldn't be the one who takes care of all tasks in the project. I've done a lot of this mostly alone in the past 2 years.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants