apache / apache/incubator-graphar

feat(infra): Automatically docs deployment with CI.

Open
#569 3 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
373
Forks
93
Avg merge
7d 21h
Merged PRs (30d)
7

Description

### Describe the enhancement requested

As I inspect the docs.yml and if I have not overlooked something, the action seems only check and build the website?

Maybe we can improve the CI to make the website automatically built and... Deployed!
The practice in graphscope website maybe work:

- in this repo, docs.yml checks if anything in /docs changes, if yes, either:
- in repo incubator-graphar-website, keep a synchronized copy of `/docs`, push the change to that repo, and if any change happens, build and deploy with CI.
- or even built the website `/docs` in this repo and push to the branch `asf-site` of repo incubator-graphar-website directly

using this action: https://github.com/ad-m/github-push-action

### Component(s)

Developer Tools

Contributor guide

Open the contributing guide

Research direction

Start by reading docs.yml and tracing how changes under /docs are currently checked and built. Compare the two proposed deployment paths for incubator-graphar-website, including pushing to its asf-site branch with ad-m/github-push-action. Done means the selected workflow builds and deploys the documentation automatically when relevant changes occur.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
ci-cd, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.