Skip to content

Conversation

@Jetoson
Copy link
Contributor

@Jetoson Jetoson commented Nov 15, 2024

This PR adds an entry for linux-meta and linux-signed in the glossary.

Fixes #7

@Jetoson Jetoson requested a review from AnneCYH as a code owner November 15, 2024 22:53
@AnneCYH
Copy link
Collaborator

AnneCYH commented Nov 20, 2024

Hi @Jetoson , thanks so much for your continued contributions!

I left some comments, and I have some general advice on the PRs.

If you are using a line length limit, it would be good to stick to it. For example, linux-meta and linux-signed entries seem to cut off at a specific character count but the SRU entry doesn't wrap the lines, per se. :) It would be easier for readability if the code (in this case 'docs code') is consistently formatted within the file (and hopefully within the repo!).

Another thing, which was not enabled properly. You can preview the PR builds if you click on "Details" for the "docs/readthedocs.com:canonical-kernel-docs" check. This is particularly useful for changes with a larger scope or content with a lot of nesting / formatting etc. :)

image

As always, let us know if you have any questions, thanks!

@AnneCYH
Copy link
Collaborator

AnneCYH commented Nov 20, 2024

Hi @Jetoson , as a gentle reminder of other opportunities available for contributing to docs; which might spark your interest in contributing to the many other open source projects in Canonical.

Canonical has the Open Documentation Academy, which is a platform for you to connect with the Documentation team at Canonical, and also a place to start getting involved in open source through documentation.
Read more about the ODA here:
https://canonical.com/documentation/open-documentation-academy

There are also specially curated issues which anyone who is interested can contribute to here, as part of the ODA efforts:
https://github.com/canonical/open-documentation-academy/issues

Thank you!

@Jetoson
Copy link
Contributor Author

Jetoson commented Nov 23, 2024

Thank you @AnneCYH for your gentle feedback, I'm learning a lot about opensource contribution and kernel development. And thank you for the heads up about ODA, it is a great platform. I'm really excited!

Copy link
Collaborator

@AnneCYH AnneCYH left a comment

Choose a reason for hiding this comment

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

Thanks @Jetoson , looks good! Thanks so much for your time & effort.
I'm going to go ahead and merge it.

@AnneCYH AnneCYH merged commit c49b6f8 into canonical:main Nov 25, 2024
1 check passed
@AnneCYH AnneCYH mentioned this pull request Nov 25, 2024
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.

Glossary - linux-meta and linux-signed

3 participants