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.

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

Merged
merged 3 commits into from
Jul 8, 2024

Conversation

padovan
Copy link
Contributor

@padovan padovan commented Jul 3, 2024

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.

Screenshot from 2024-07-03 15-30-55

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.

Copy link

@tales-aparecida tales-aparecida left a comment

Choose a reason for hiding this comment

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

nits and typos

kernelci.org/content/en/_index.md Outdated Show resolved Hide resolved
kernelci.org/content/en/_index.md Outdated Show resolved Hide resolved
kernelci.org/content/en/kernel-community/_index.md Outdated Show resolved Hide resolved
kernelci.org/content/en/labs/_index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@patersonc patersonc left a 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?

kernelci.org/content/en/_index.md Outdated Show resolved Hide resolved
kernelci.org/content/en/_index.md Outdated Show resolved Hide resolved
kernelci.org/content/en/_index.md Outdated Show resolved Hide resolved
@padovan
Copy link
Contributor Author

padovan commented Jul 3, 2024

/staging

@padovan padovan force-pushed the new-landing-page branch 2 times, most recently from 490364a to 94d93b1 Compare July 4, 2024 18:54
@padovan
Copy link
Contributor Author

padovan commented Jul 4, 2024

/staging

Copy link

@tales-aparecida tales-aparecida left a 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

kernelci.org/content/en/labs/_index.md Outdated Show resolved Hide resolved
@padovan padovan force-pushed the new-landing-page branch from 94d93b1 to 22c6f98 Compare July 4, 2024 19:33
@padovan
Copy link
Contributor Author

padovan commented Jul 4, 2024

/staging
https://static.staging.kernelci.org/

Copy link
Contributor

@JenySadadia JenySadadia left a 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.

padovan added 3 commits July 5, 2024 09:17
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]>
@padovan padovan force-pushed the new-landing-page branch from 22c6f98 to a913ee0 Compare July 5, 2024 12:18
@padovan padovan mentioned this pull request Jul 5, 2024
Copy link
Collaborator

@patersonc patersonc left a comment

Choose a reason for hiding this comment

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

Thanks @padovan !

@patersonc
Copy link
Collaborator

It looks like everyone's comments have been resolved, so I'll merge now. Thanks everyone!
We can open another MR if there are any follow-ups.

@patersonc patersonc merged commit ab5b71a into kernelci:main Jul 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants