doc: fix missing references to README.md #860
Conversation
dbkinder
force-pushed
the
add-readme20
branch
from
fd23ee4
to
92add3e
Compare
|
The link check failure to https://github.com/opea-project/docs/tree/main/guide/installation/k8s_install/README.md is because the file being referenced is added by an unmerged PR in the docs repo opea-project/docs#170. I guess we need to merge that one first before this one will succeed? Perhaps we need a way to override the link check failure if you consider the case where there is a circular failure between PRs in two different repos. We could have the situation where two docs are added in separate repos that link to each other. Both of these PRs would fail the link check and neither could be merged. :( |
|
@dbkinder,
|
dbkinder
force-pushed
the
add-readme20
branch
from
92add3e
to
fd32988
Compare
Need to have the docs repo opea-project/docs#170 merged before this one will pass your linkcheck and can be merged. |
dbkinder
force-pushed
the
add-readme20
branch
from
fd32988
to
2807c1a
Compare
Cross-repo references using an URL that only has the folder name cause links in the github.io site to go to the github.com site. Most of these uses want to link to the documentation (README.md) so add that where appropriate so links in the github.io site stay there. Also use an URL when relative links want to take you to the github.com repo and add the README.md when the document is the link target. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
dbkinder
force-pushed
the
add-readme20
branch
from
2807c1a
to
13b2186
Compare
|
@lvliang-intel Passing checks now... ready for your review/approval/merge |
Cross-repo references using an URL that only has the folder name cause links in the github.io site to go to the github.com site. Most of these uses want to link to the documentation (README.md) so add that where appropriate so links in the github.io site stay there.