Ma77Ball opened a new pull request, #55:
URL: https://github.com/apache/incubator-texera-site/pull/55

   This sets up the website to build documentation from apache/texera as the 
single source of truth, per 
[apache/texera#5001](https://github.com/apache/texera/issues/5001). It is the 
website-side counterpart to apache/texera#5299 (which reconciles the in-repo 
`docs/` and migrates the remaining unique wiki pages).
   
   ## What this PR does
   
   - Adds a scheduled `sync-docs` workflow (`.github/workflows/sync-docs.yml`, 
daily + manual `workflow_dispatch`) that:
     - sparse-checks-out the `docs/` folder from `apache/texera@main`,
     - regenerates `content/docs/latest` from it via `scripts/sync-docs.py`,
     - commits the result and redeploys when the rendered docs change.
   - `scripts/sync-docs.py` copies the clean source Markdown and re-applies the 
Hugo artifacts the site needs but that do not belong in the source: a per-page 
`aliases` entry (so `/docs/<path>/` URLs and in-page `/docs/...` links keep 
resolving to `/docs/latest/<path>/`), and the `linkTitle`/`menu` nav keys on 
the section root `_index.md`.
   - Extracts the build/deploy steps from `publish-site.yml` into a reusable 
composite action (`.github/actions/build-and-deploy`). The sync job uses it to 
rebuild the freshly synced working tree in the same run, since a `GITHUB_TOKEN` 
push to `main` does not re-trigger the push-based publish workflow.
   - Documents in the README that `content/docs/latest` is generated and should 
be edited in apache/texera, not here.
   
   ## Validation
   
   Running `scripts/sync-docs.py` against the current apache/texera `docs/` 
reproduces the existing `content/docs/latest` byte-for-byte, except for the 
genuine content changes pending in apache/texera#5299 (the updated 
`installing-using-docker`, the new `deploy-on-aws`/`deploy-on-gcp` pages, and 
the `install-texera` links). This confirms the transform faithfully preserves 
the current site.
   
   ## Follow-up
   
   `content/docs/latest` is left in place in this PR so the site keeps 
building. Once this and apache/texera#5299 are merged, the first sync run takes 
over `content/docs/latest`, completing the handover so apache/texera is the 
only place docs are maintained. The GitHub wiki can then be retired.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: [email protected]

For queries about this service, please contact Infrastructure at:
[email protected]

Reply via email to