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

[DOCS][CI] Auto push docs to the website branch #1305

Merged
merged 15 commits into from
Apr 3, 2024
Merged

Conversation

jiayuasu
Copy link
Member

@jiayuasu jiayuasu commented Apr 2, 2024

Did you read the Contributor Guide?

Is this PR related to a JIRA ticket?

  • No, this is a documentation update. The PR name follows the format [DOCS] my subject.

What changes were proposed in this PR?

  1. Build the doc website automatically per commit, only push to website branch when the event is not a PR.
  2. Remove any embedded iframe or javascript
  3. Minor fixes to docs

How was this patch tested?

Passed GitHub CI

Did this PR include necessary documentation updates?

  • Yes, I have updated the documentation update.

@jiayuasu jiayuasu marked this pull request as draft April 3, 2024 04:49
.github/workflows/docs.yml Outdated Show resolved Hide resolved
jiayuasu and others added 5 commits April 2, 2024 22:59
Co-authored-by: John Bampton <jbampton@users.noreply.github.com>
@jiayuasu jiayuasu marked this pull request as ready for review April 3, 2024 06:52
@jiayuasu jiayuasu marked this pull request as draft April 3, 2024 06:52
@jiayuasu jiayuasu marked this pull request as ready for review April 3, 2024 07:20
@jiayuasu jiayuasu merged commit 4d66011 into master Apr 3, 2024
2 checks passed
@jiayuasu jiayuasu deleted the auto-commit-doc branch April 3, 2024 07:33
jiayuasu added a commit that referenced this pull request Apr 28, 2024
* Init commit

* Add JavaDoc and ScalaDoc

* Build docs

* Copy Javadoc

* Fix again

* Update .github/workflows/docs.yml

Co-authored-by: John Bampton <jbampton@users.noreply.github.com>

* Fix

* Fix

* Skip tests

* Fix

* Update links

* Update URL, fix some wrong links

* Deploy docs only when the event is not a PR

* Add usecase placeholder

---------

Co-authored-by: John Bampton <jbampton@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants