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.

Sign up for GitHub

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

Jump to bottom

Add hyperlinks and paths validation. #148

Closed
wants to merge 49 commits into from
Closed

Add hyperlinks and paths validation. #148

wants to merge 49 commits into from

Conversation

ZePan110
Copy link
Collaborator

No description provided.

@ZePan110
Copy link
Collaborator Author

@ctao456 Can you help check

docs/community/rfcs/24-08-02-OPEA-AIAvatarChatbot.md

Line 8 in a841a92

[ctao456](https://github.com/ctao456), [alexsin368](https://github.com/alexsin368), [YuningQiu](https://github.com/YuningQiu), [louie-tsai](https://github.com/louie-tsai)
The tool reports an error when checking, I can't find where this link points to.
image

@ctao456
Copy link
Contributor

ctao456 commented Sep 19, 2024

Hi @ZePan110 I submitted a pull request to fix this invalid link.
#149

mkbhanda
mkbhanda requested changes Sep 19, 2024
View reviewed changes
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Show resolved Hide resolved
@ZePan110
Copy link
Collaborator Author

ZePan110 commented Sep 19, 2024 •
edited
Loading

@ctao456

Hi @ZePan110 I submitted a pull request to fix this invalid link. #149
Still not accessible. BTW, Should we put such private links?
image
image

@mkbhanda
Copy link
Collaborator

mkbhanda commented Sep 19, 2024 •
edited
Loading

Private links --- given this is for documentation .. am guessing there should be no private links! Would not help user. The error code should be adequate to prompt them how to fix. Or add a sentence .. perhaps you incorrectly provided a restricted link or something. I am ambivalent about emails .. what if it is a vulnerability reporting link and it bounces. Put that as issue and lets deal with it in the future. Thank you for this link correctness checker script.

@ctao456
Copy link
Contributor

ctao456 commented Sep 19, 2024

@ctao456

Hi @ZePan110 I submitted a pull request to fix this invalid link. #149
Still not accessible. BTW, Should we put such private links?
image
image

In order for the pr to take effect, I need 2 approvals first.

mkbhanda
mkbhanda reviewed Sep 19, 2024
View reviewed changes
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.

please address earlier comment about not retrying for certain error codes like 400 range.

.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
@ZePan110
Copy link
Collaborator Author

@ctao456

Hi @ZePan110 I submitted a pull request to fix this invalid link. #149
Still not accessible. BTW, Should we put such private links?
image
image

In order for the pr to take effect, I need 2 approvals first.
The link doesn't seem to exist
image

@ZePan110
Add hyperlinks and paths validation.
1f9e9e4 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test
91f4be4 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test
15c6aec 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Set IFS to newlines only.
9af6b74 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Fix path error.
ef6b6d2 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Excluded mailboxes.
fde2674 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Fix path error
5af3c37 
Signed-off-by: ZePan110 <[email protected]>
@dbkinder
Copy link
Contributor

Hi @ZePan110 I submitted a pull request to fix this invalid link. #149

PR approved and merged, thanks.

dbkinder
dbkinder suggested changes Sep 19, 2024
View reviewed changes
Copy link
Contributor

@dbkinder dbkinder left a comment

Choose a reason for hiding this comment

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

Some comments

community/rfcs/24-05-16-OPEA-001-Overall-Design.md Show resolved Hide resolved
community/rfcs/24-05-16-OPEA-001-Overall-Design.md Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
.github/workflows/pr-path-detection.yml Outdated Show resolved Hide resolved
@ZePan110
Copy link
Collaborator Author

I've deleted that test folder. But we should have a way to exclude test issues from your CI checking.

The tool's is to expose invalid links during integration, I don't quite understand what you mean by exclusion.

@dbkinder
doc: remove test directory (#176)
3cca01e 
This directory held tests for scripts that do manipulation of markdown
files to prepare for doc publishing.  They were causing problems for the
CI testing looking for broken links, so remove the test folder.

Signed-off-by: David B. Kinder <[email protected]>
@ZePan110 ZePan110 mentioned this pull request Sep 25, 2024
Merged
@ZePan110
Copy link
Collaborator Author

Due to the excessive discussion, in order to facilitate review, we will recreate the #177
and continue working on this.

@ZePan110 ZePan110 closed this Sep 25, 2024
ZePan110 and others added 23 commits September 25, 2024 18:21
@ZePan110
Add hyperlinks and paths validation.
49438ef 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test
a2ee08c 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test
6382f31 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Set IFS to newlines only.
194ca18 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Fix path error.
8882703 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Excluded mailboxes.
b7fc9dc 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Fix path error
d2c1d08 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Exclude linkedin links and video link verification.
c6d3b35 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110 @mkbhanda
Update .github/workflows/pr-path-detection.yml
8a464d6 
Co-authored-by: Malini Bhandaru <[email protected]>
@ZePan110 @mkbhanda
Update .github/workflows/pr-path-detection.yml
b2d6ac0 
Co-authored-by: Malini Bhandaru <[email protected]>
@ZePan110 @mkbhanda
Update .github/workflows/pr-path-detection.yml
3da3800 
Co-authored-by: Malini Bhandaru <[email protected]>
@ZePan110
Change output.
ecdcb52 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Remove test output
0b7fcbb 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110 @mkbhanda
Update .github/workflows/pr-path-detection.yml
3c692ec 
Co-authored-by: Malini Bhandaru <[email protected]>
@ZePan110
Add status code output
94daca0 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test.
ea54efc 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
test
bf9632e 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Add retry for occasional failures
a341932 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Change output
45087c4 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Increase the number of retries
2965a14 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
delay
eda586d 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Clean up code.
c9fd8d9 
Signed-off-by: ZePan110 <[email protected]>
@ZePan110
Merge branch 'zepan/dev' of https://github.com/opea-project/docs into…
c2c7404 
… zepan/dev
@ZePan110 ZePan110 deleted the zepan/dev branch November 4, 2024 07:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dbkinder dbkinder dbkinder requested changes

@mkbhanda mkbhanda mkbhanda requested changes

@kevinintel kevinintel kevinintel approved these changes

@chensuyue chensuyue chensuyue approved these changes

@ftian1 ftian1 ftian1 approved these changes

@preethivenkatesh preethivenkatesh Awaiting requested review from preethivenkatesh preethivenkatesh is a code owner

@chickenrae chickenrae Awaiting requested review from chickenrae chickenrae is a code owner

@tomlenth tomlenth Awaiting requested review from tomlenth tomlenth is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@ZePan110 @ctao456 @mkbhanda @dbkinder @ftian1 @chensuyue @kevinintel