Skip to content

chore(docs): include the wiki instruction as the README in the docker compose folder#4320

Open
bobbai00 wants to merge 2 commits intoapache:mainfrom
bobbai00:feat/include-readme-in-docker-compose-tarball
Open

chore(docs): include the wiki instruction as the README in the docker compose folder#4320
bobbai00 wants to merge 2 commits intoapache:mainfrom
bobbai00:feat/include-readme-in-docker-compose-tarball

Conversation

@bobbai00
Copy link
Contributor

@bobbai00 bobbai00 commented Mar 22, 2026

What changes were proposed in this PR?

Replace the placeholder bin/single-node/README.md with the full Docker Compose setup guide from the wiki, with the "Download the docker compose tarball" section removed (tarball users already have the files).

Any related issues, documentation, discussions?

Wiki page: https://github.com/apache/texera/wiki/Installing-Apache-Texera-using-Docker

How was this PR tested?

Content verified against the wiki source.

Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.6)

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@github-actions github-actions bot added feature ci changes related to CI labels Mar 22, 2026
@bobbai00 bobbai00 requested a review from chenlica March 22, 2026 07:30
@bobbai00 bobbai00 changed the title feat(ci): fetch docker-compose README from wiki instead of repo feat(release-ci): include the wiki instruction as the README in the docker compose release tarball Mar 22, 2026
@bobbai00 bobbai00 self-assigned this Mar 22, 2026
cp "$TEMP_DIR/_raw/bin/single-node/README.md" "$BUNDLE_DIR/"
# Fetch the README from the GitHub wiki and remove the download section
# (users of the tarball already have the files, so that section is irrelevant)
curl -fsSL "https://github.com/wiki/apache/texera/Installing-Apache-Texera-using-Docker.md" \
Copy link
Contributor

Choose a reason for hiding this comment

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

It replies on the content of another page https://github.com/wiki/apache/texera/Installing-Apache-Texera-using-Docker.md with instructions.  Then this package is not self-contained.  Can we include this file into this release as well?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed. Please check

Replace the placeholder README in bin/single-node/ with the full
installation guide from the wiki, minus the download section (since
tarball users already have the files). Reverts the CI workflow change.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
@bobbai00 bobbai00 changed the title feat(release-ci): include the wiki instruction as the README in the docker compose release tarball [CHORE] docs Mar 22, 2026
@github-actions github-actions bot added docs Changes related to documentations build and removed ci changes related to CI labels Mar 22, 2026
@bobbai00 bobbai00 changed the title [CHORE] docs chore(docs): include the wiki instruction as the README in the docker compose folder Mar 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

build docs Changes related to documentations feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants