Skip to content

Conversation

@jbampton
Copy link
Member

General clean up

Copy link
Contributor

@volosied volosied left a comment

Choose a reason for hiding this comment

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

Looks like a majority of white space changes, and some spelling.

@volosied
Copy link
Contributor

Before I merge, let me confirm there's no issue modifying the xsd files (whitespace). @bohmber would you see any potential issues?

@volosied
Copy link
Contributor

@henningn

Do you see any potential problems regarding the whitespace changes in the xsd files? If not, I'd like to merge this. Thanks!

@henningn
Copy link
Contributor

I have discussed this with @lofwyr14. Please do not change the released documentation. Especially not the XSD. The spelling issue must be fixed in the next version of the XSD.

@lofwyr14
Copy link
Contributor

lofwyr14 commented Dec 3, 2025

It is good to correct spelling mistakes. However, this must be done at the source. Subsequent changes to releases are to be discarded.

In general, this is my point of view:

Releases must be immutable
Under ASF policy, a published release artefact (including Javadoc and XSDs) must not be changed; any modification, even spelling fixes, effectively creates a new release that hasn’t gone through the formal process.

Reproducibility and trust
Users must be able to verify that what they have matches the signed release. If we silently edit generated docs, the content no longer matches the original source + build at release time.

Auditability and legal provenance
ASF emphasizes clear, traceable provenance of what was released and when. Post-hoc edits blur that boundary and can complicate legal or compliance questions later.

Version history clarity
The documentation associated with version X.Y should represent exactly what was shipped as X.Y. If we want corrected docs, they should be published as part of a new release or as separate, clearly marked, website content (e.g. “fixed docs” or errata), not by rewriting the original artefacts.

@lofwyr14 lofwyr14 closed this Dec 3, 2025
@lofwyr14 lofwyr14 reopened this Dec 3, 2025
Copy link
Contributor

@lofwyr14 lofwyr14 left a comment

Choose a reason for hiding this comment

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

No changes in releases

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.

4 participants