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

[ISSUE #166] Provide updated Runtime/Docker deployment and compilation docs #170

Merged
merged 25 commits into from
Jan 10, 2024

Conversation

Pil0tXia
Copy link
Member

@Pil0tXia Pil0tXia commented Jan 1, 2024

Fixes #166.

The documentation for Runtime and Runtime Docker has not been updated for a long time, containing numerous outdated commands and incorrect descriptions. This PR addresses all of these issues and optimizes the structure of the Runtime documentation, making it more user-friendly, web-friendly, and comprehensible.

Preview markdown web pages:

Additionally, this PR optimizes the following:

  • Supplementary fixes for [Enhancement] Incubator logo footer should be updated #162, correcting the copyright desc and the "incubator" word on the Chinese website.
  • The v1.10.0 documentation still used the v1.9.0 documentation; now the v1.10.0 documentation is consistent with Next.
  • Updated multiple version numbers, such as in the Release Notes on the Roadmap page.
  • Synchronized all connector documentation.
  • Improved the Connector Implementation Status table, moved it to the Roadmap for better visibility. Added the Event Store Implementation Status.
  • Made less important Eclipse documentation less prominent.
  • Added code highlighting for the following languages to the code block: bash, gradle, groovy, properties, json, protobuf, sql, antlr4, log, rust.
  • Upgraded docusaurus from 2.4.1 to 2.4.3 (no breaking change) and node from 16 to 18 (16 has End of Life).
  • Many other minor changes.

In the next PR, I am working on updating the Roadmap and addressing image relative path issues.

docs/roadmap.md Show resolved Hide resolved
docs/instruction/03-runtime.md Outdated Show resolved Hide resolved
docs/instruction/03-runtime.md Outdated Show resolved Hide resolved
docs/instruction/03-runtime.md Outdated Show resolved Hide resolved
docs/instruction/03-runtime.md Outdated Show resolved Hide resolved
versioned_docs/version-v1.10.0/sdk-java/01-intro.md Outdated Show resolved Hide resolved
Copy link
Member

@pandaapo pandaapo left a comment

Choose a reason for hiding this comment

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

Due to my limited personal abilities, in too many changes to files, I did not review the modifications to historical versions, workflow and schema that I do not understand, etc. And I did not comment on all the similar issues one by one.

由于个人能力有限,改动文件太多,对于历史版本的修改、workflow和schema(我不懂)的修改等等内容,我没有review;对于类似的问题我也没有逐个全部标记。

@Pil0tXia
Copy link
Member Author

Pil0tXia commented Jan 8, 2024

This PR does not have any content modifications to the documentation of historical versions, workflows, and schemas.

Speaking of historical versions, there are significant issues with them currently. Multiple versions are almost identical, and they do not align with the document structure and content in the Git repository. I first mentioned this issue in #132 (comment).

@pandaapo
Copy link
Member

pandaapo commented Jan 9, 2024

For the contents that I can review, they are already OK for me.

@Pil0tXia Pil0tXia merged commit fb16c27 into apache:master Jan 10, 2024
1 check passed
@Pil0tXia Pil0tXia deleted the pil0txia_doc_166 branch January 10, 2024 09:46
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.

[Doc] Provide updated Runtime/Docker deployment and compilation docs
3 participants