Skip to content

Commit ac045e3

Browse files
Yicong-Huangclaude
authored andcommitted
docs: fix stale repo, branch, and architecture references (#6113)
### What changes were proposed in this PR? Cleans up leftovers from before the ASF migration, plus two small adjacent doc fixes: - `github.com/Texera/texera` → `github.com/apache/texera` in `CONTRIBUTING.md` (fork + Actions links), `docs/contribution-guidelines/_index.md`, `docs/examples/_index.md`, and the clone URL in `guide-for-developers.md`. - `CONTRIBUTING.md`: PRs are squash-merged into `main`, not `master` (two mentions). - `docs/examples/_index.md`: dropped the dead link to an `examples/` directory that has never existed in this repo. - `SECURITY.md`: "Kubernates PODs" → "Kubernetes pods". ### Any related issues, documentation, discussions? Closes #6107 ### How was this PR tested? Docs-only change. Verified `main` is the default branch and `apache/texera` the canonical repo (`git remote -v`, `.github/workflows/required-checks.yml`), and that `grep -rn "github.com/Texera/texera"` finds no remaining hits outside files handled by #6111. ### Was this PR authored or co-authored using generative AI tooling? Generated-by: Claude Code (Claude Fable 5) --------- (backported from commit f787472) Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent d1c9579 commit ac045e3

5 files changed

Lines changed: 12 additions & 12 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Thank you for your interest in contributing to Texera! Please follow the steps b
1515
## 🛠 Contribution Steps
1616

1717
### 1. Fork the Repo
18-
- Fork the [Texera repository](https://github.com/Texera/texera) to your own GitHub account.
18+
- Fork the [Texera repository](https://github.com/apache/texera) to your own GitHub account.
1919

2020
### 2. Find an Existing Issue or Open an Issue
2121
- Find an existing issue that you want to work on, or create one issue for new proposal/bug description.
@@ -29,7 +29,7 @@ Thank you for your interest in contributing to Texera! Please follow the steps b
2929

3030
#### PR Title and Commit Messages
3131
- We require all PR titles and commit messages to follow the [Conventional Commits spec](https://www.conventionalcommits.org/en/v1.0.0/).
32-
- All PR titles will be used as the **squashed commit message** when merged into the `master` branch.
32+
- All PR titles will be used as the **squashed commit message** when merged into the `main` branch.
3333
- Example PR titles:
3434
- `feat: add a new join operator`
3535
- `fix(ui): prevent racing of requests`
@@ -67,7 +67,7 @@ Do not include any of the following in your PR:
6767
* For the amber engine's tests, the working directory should be `amber`
6868
* For the other services' tests, the working directory should be the root directory
6969
#### Testing the frontend
70-
Before merging your code to the master branch, you need to pass the existing unit tests first.
70+
Before merging your code to the main branch, you need to pass the existing unit tests first.
7171
1. Open a command line. Navigate to the `frontend` directory.
7272
2. Start the test:
7373
```
@@ -85,7 +85,7 @@ yarn format:fix
8585
- [ ] Ask a Texera Committer (by commenting on the PR) to triage your PR, i.e., request a reviewer, and assign the PR to you.
8686
- [ ] Add appropriate labels such as `fix`, `enhancement`, `docs`, etc.
8787
- [ ] If the change should also land in a release branch, add the matching `release/<branch>` label (e.g. `release/v1.1.0-incubating`); the change will be backported to that branch automatically.
88-
- [ ] Ensure that all CI checks pass (see [GitHub Actions](https://github.com/Texera/texera/actions)).
88+
- [ ] Ensure that all CI checks pass (see [GitHub Actions](https://github.com/apache/texera/actions)).
8989
- [ ] Fully test your changes locally.
9090

9191
> ℹ️ If your PR is not ready for review, please mark it as a draft. You can change it to “Ready for review” when it is complete.

SECURITY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Texera supports the following resource types:
3434

3535
- **Datasets**: Input data imported or uploaded for workflow processing
3636
- **Workflows**: Data analytics pipelines defined by users
37-
- **Computing Units**: Execution environments for running workflows (e.g., Kubernates PODs)
37+
- **Computing Units**: Execution environments for running workflows (e.g., Kubernetes pods)
3838
- **Results**: Output from workflow executions, including but not limited to data, logs, metrics, and visualizations
3939

4040
### Resource Ownership and Access Control

docs/contribution-guidelines/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Texera welcomes contributions from everyone — whether you’re fixing a small
3131
## 🛠 How to Contribute Code
3232

3333
### 1. Fork the Repository
34-
Fork the [Texera repository](https://github.com/Texera/texera) on GitHub and clone it locally.
34+
Fork the [Texera repository](https://github.com/apache/texera) on GitHub and clone it locally.
3535

3636
### 2. Find or Open an Issue
3737
- Pick an existing issue or create a new one describing your proposal or bug.
@@ -110,7 +110,7 @@ Write `.spec.ts` tests for new functionality to ensure future safety.
110110
## 🔍 Pull Request Review Process
111111
1. Request a committer to review your PR.
112112
2. Add labels (e.g., `fix`, `enhancement`, `docs`).
113-
3. Wait for CI to pass ([GitHub Actions](https://github.com/Texera/texera/actions)).
113+
3. Wait for CI to pass ([GitHub Actions](https://github.com/apache/texera/actions)).
114114
4. Mark your PR as **draft** if it’s not ready.
115115
5. Once approved, a committer will merge your PR.
116116

@@ -135,7 +135,7 @@ To automate this in IntelliJ:
135135
## ✍️ Contributing to Documentation
136136

137137
Texera uses [Hugo](https://gohugo.io/) and the [Docsy](https://github.com/google/docsy) theme to build its website.
138-
All documentation is stored in the [Texera GitHub repository](https://github.com/Texera/texera).
138+
All documentation is stored in the [Texera GitHub repository](https://github.com/apache/texera).
139139

140140
### Quick Steps
141141
1. Click **Edit this page** at the top of any doc page to edit directly on GitHub.
@@ -153,7 +153,7 @@ Visit `http://localhost:1313` to view the site as you edit.
153153
---
154154

155155
## 📚 Resources
156-
- [Texera GitHub Repository](https://github.com/Texera/texera)
156+
- [Texera GitHub Repository](https://github.com/apache/texera)
157157
- [Conventional Commits Spec](https://www.conventionalcommits.org/en/v1.0.0/)
158158
- [Hugo Documentation](https://gohugo.io/documentation/)
159159
- [Docsy Guide](https://www.docsy.dev/docs/)

docs/contribution-guidelines/guide-for-developers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ ng version
8080

8181
In the terminal, clone the Texera repo:
8282
```console
83-
git clone git@github.com:Texera/texera.git
83+
git clone git@github.com:apache/texera.git
8484
```
8585

8686
Do the following changes to the configuration files:

docs/examples/_index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,15 +41,15 @@ To try these examples on your local Texera instance:
4141

4242
1. Launch Texera following the [Getting Started](/docs/getting-started/) guide.
4343
2. Open the **Workflow Editor** in your browser at `http://localhost:4200`.
44-
3. Import an example workflow file (`.json`) from the [Texera Example Repository](https://github.com/Texera/texera/tree/master/examples).
44+
3. Import an example workflow file (`.json`) into the editor.
4545
4. Run the workflow to see Texera’s operators and data visualizations in action.
4646

4747
---
4848

4949
## 🧠 Want to Contribute an Example?
5050

5151
If you’ve built your own workflow and want to share it:
52-
- Fork the [Texera repository](https://github.com/Texera/texera).
52+
- Fork the [Texera repository](https://github.com/apache/texera).
5353
- Add your workflow under `examples/` with a short README.
5454
- Submit a pull request following our [Contribution Guidelines](/docs/contribution-guidelines/).
5555

0 commit comments

Comments
 (0)