Skip to content

add ci for build online doc#241

Merged
NeoZhangJianyu merged 44 commits intoopea-project:mainfrom
NeoZhangJianyu:add_ci
Nov 8, 2024
Merged

add ci for build online doc#241
NeoZhangJianyu merged 44 commits intoopea-project:mainfrom
NeoZhangJianyu:add_ci

Conversation

@NeoZhangJianyu
Copy link
Collaborator

add ci for build online doc

Copy link
Collaborator

@mkbhanda mkbhanda left a comment

Choose a reason for hiding this comment

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

Is there any chance of a broken build updating/publishing to the docs folder? Where are you checking docs build status.

Can we control this docs build process to only when doc collateral changes, or nightly?

@NeoZhangJianyu
Copy link
Collaborator Author

Is there any chance of a broken build updating/publishing to the docs folder? Where are you checking docs build status.

Can we control this docs build process to only when doc collateral changes, or nightly?

Here the CI broken means there is online doc building error. If we publish them forcedly, the html page would be out of work.

Doc building is hard to be broken if follow the MD and rst file format rule.
If it is broken, it's easy to fix if familiar with the file format.

Here, the CI just check the PR format and make sure it don't break the online doc building.
But it wouldn't update the online doc.

There is hourly action to build the online doc. If there is no content change, the action won't update the HTML.

@yinghu5 yinghu5 self-requested a review November 8, 2024 01:21
@NeoZhangJianyu NeoZhangJianyu merged commit 016942a into opea-project:main Nov 8, 2024
alexsin368 pushed a commit to alexsin368/opea-project-docs that referenced this pull request Nov 14, 2024
* add ci for build online doc

* for debug

* for debug

* fix bug

* add print

Signed-off-by: ZhangJianyu <zhang.jianyu@outlook.com>

* add print

* debug

* debug

* debug

* debug

* debug

* fix

* debug

* fix

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* debug

* rm write access

---------

Signed-off-by: ZhangJianyu <zhang.jianyu@outlook.com>
Co-authored-by: ZhangJianyu <zhang.jianyu@outlook.com>
Signed-off-by: alexsin368 <alex.sin@intel.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants