Skip to content

FIX Docs Link: ./kernel to ../kernel/README.md #2074

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

Merged
merged 2 commits into from
Jun 20, 2017

Conversation

ndauten
Copy link
Contributor

@ndauten ndauten commented Jun 19, 2017

Signed-off-by: Nathan Dautenhahn ndd@cis.upenn.edu

- What I did

Converted link of .kernel in docs/kernels.md to point to ../kernel/README.md

- How I did it

Modified it.

- How to verify it

Read it and verify link works

- Description for the changelog

FIX Docs Link: ./kernel to ../kernel/README.md

- A picture of a cute animal (not mandatory but encouraged)

Signed-off-by: Nathan Dautenhahn <ndd@cis.upenn.edu>
@ndauten
Copy link
Contributor Author

ndauten commented Jun 19, 2017

This might be better served linking the Makefile instead because the README doesn't have any general instructions on kernel image building.

Copy link
Contributor

@riyazdf riyazdf left a comment

Choose a reason for hiding this comment

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

LGTM

@justincormack
Copy link
Member

I think the current link makes more sense, it is just there to point out where the actual build code is, the README is that document itself.

@riyazdf
Copy link
Contributor

riyazdf commented Jun 20, 2017

@justincormack: good point, the GH page will display the README for the directory as well. I'm fine with closing this to leave the link as-is

@ndauten
Copy link
Contributor Author

ndauten commented Jun 20, 2017

The link as is points to "./kernel" and should minimally be changed to "../kernel". I wasn't sure if that would work fine in github, which is why I pointed it directly at ../kernel/README.md.

If the link "../kernel" works in github then that would be my proposal.

@riyazdf
Copy link
Contributor

riyazdf commented Jun 20, 2017

@ndauten: good point, I missed that. I agree that we should change the link to point to ../kernel

@justincormack
Copy link
Member

Ah ok, yes directory links work fine in github.

Signed-off-by: Nathan Dautenhahn <ndd@cis.upenn.edu>
@justincormack justincormack merged commit 95c0c29 into linuxkit:master Jun 20, 2017
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.

5 participants