-
Notifications
You must be signed in to change notification settings - Fork 29
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
New landing page for Documentation #406
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nits and typos
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I like the new style, thank you @padovan.
I've added some annoying nits - sorry :D
Any objections to triggering staging for this PR?
/staging |
490364a
to
94d93b1
Compare
/staging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A small typo escaped! hehe
/staging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the below should also be covered by this PR as #405 has already been merged.
On page https://static.staging.kernelci.org/labs/,
If you are interested it just sending the results of test runs in your infrastructure, you should look at sending the data to [KCIDB](https://static.staging.kernelci.org/kcidb) - KernelCI common database for results.
should be changed to
If you are interested in just sending the results of test runs in your infrastructure, you should look at sending the data to [KCIDB](https://static.staging.kernelci.org/kcidb) - KernelCI common database for results.
We need documentation for the Linux kernel community to learn about how to use KernelCI. So far we had nothing in that diretion for the new architecture. This first version is quite simple, but sets the foundation for expanding on this work. Signed-off-by: Gustavo Padovan <[email protected]>
We want to direct different users to different parts of the documentation. Our documentation has a few different audiences and that was not clear in the landing page. Signed-off-by: Gustavo Padovan <[email protected]>
From feedback giving after the first version of the page was merged. Signed-off-by: Gustavo Padovan <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @padovan !
It looks like everyone's comments have been resolved, so I'll merge now. Thanks everyone! |
We have several types of audience; our documentation should reflect that. This PR is a initial step into creating a foundation to grow Documentation to our different types of users. You can see the proposed new users in the screenshot below.
Once we merge this, we can iterative improve the documentation (as it is being discussed in different forums).
this include the patch from #405 too.