docs: correct three broken internal links #1526
Conversation
|
Welcome @soobinrho! |
k8s-ci-robot
added
cncf-cla: no
soobinrho
changed the title
|
CI seems broken, fixing on that now. After that, we can merge this. |
Sounds good! |
|
Sorry about the delay @soobinrho can you please rebase this PR against master and let's try to get this merged? Thanks :) |
k8s-ci-robot
added
the
approved
No problem at all! I just rebased this PR against master by: git remote add upstream https://github.com/kubernetes/kompose.git
git fetch upstream
git rebase upstream/master
git push -fPlease let me know if you need anything else 👍 |
1. When I was reading the documentation, I noticed that links to other documents inside the repository were giving a 404 error. So, I cloned the repository and found found that all links such as "[Quickstart](/docs/maven-example.md)" were giving the errors. 2. The fix is to remove the `/docs/` part and the `.md` part. 3. I tested these commits with `bundle exec jekyll serve`. All the pages getting changed by the commits now work correctly.
- Removed the `/docs` part and the `.md` part from the link. - Tested with `bundle exec jekyll serve`. - Working correctly now.
- Removed the `/docs` part and the `.md` part from the link. - Tested with `bundle exec jekyll serve`. - Working correctly now.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: cdrage, soobinrho The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Hey @soobinrho thank you so much for fixing the links! I've added some changes to this commit (resolved the conflict) and will now merge it in :) thanks again. |
Problem
When I was reading the documentation, I noticed that some links to other documents inside the repository were giving a 404 error. So, I cloned the repository and searched if there's any other link that is also broken. There were three broken links. It turns out that links such as
[Quickstart](/docs/maven-example.md)were giving the errors. These links were pointing to, for example,https://kompose.io/docs/maven-example, while the correct link ishttps://kompose.io/maven-example.[1 of 3]
Quickstartlink at https://kompose.io/integrations/[2 of 3]
Kompose Installation Guidelink at https://kompose.io/maven-example/[3 of 3]
conversion documentlink at https://kompose.io/user-guide/Commits
/docspart and the.mdpart.[before]
[Quickstart](/docs/maven-example.md)-> [after][Quickstart](/maven-example)bundle exec jekyll serve. Every page being changed in this PR works correctly now.