Linux Foundation Mentorship project: Perform a docs assessment

[youngnick]

This issue covers performing a CNCF-style docs assessment for the Gateway API documentation, as part of a Linux Foundation Mentorship project.

Why this is needed:

Our documentation has grown quickly and organically, and as a result is lacking overarching structure and clarity. I hope that getting some tech writer skills across it will give us some useful recommendations.

In scope:

• reviewing our site's current state
• producing a recommendation

Stretch goal:

• fixing issues found.

/kind documentation

If you are interested, please check out more information and apply at the following links:

• CNCF Mentorship, LFX Spring 2022 URL: https://github.com/cncf/mentoring/blob/main/lfx-mentorship/2022/01-Spring/README.md#documentation-assessment-sig-network-gateway-api
• LFX URL: https://mentorship.lfx.linuxfoundation.org/project/0e4c9797-2dc5-4621-b46a-f1b7371a2495

[nate-double-u]

• CNCF Mentorship, LFX Spring 2022 URL: https://github.com/cncf/mentoring/blob/main/lfx-mentorship/2022/01-Spring/README.md#documentation-assessment-sig-network-gateway-api
• LFX URL: https://mentorship.lfx.linuxfoundation.org/project/0e4c9797-2dc5-4621-b46a-f1b7371a2495

[deprov447]

Hi @nate-double-u @youngnick I would like to take this task up for LFX Spring 2022. Kindly mention how can I communicate with mentors regarding the project. (ie. if there is a chatroom or IRC server)

[youngnick]

Hi @deprov447, please apply through the LFX URL above, and we'll assess your application.

[jj551]

Gateway API documentation and code locations are at ???? I can start now 😄 @youngnick

[youngnick]

Sorry @Kodalien, this is intended as a tracking issue for the person who gets the Linux Foundation Spring Mentorship position. If you would like to do it, I'd encourage you to apply at the links Nate posted above.

I've updated the title to be more clear.

[aastha0326]

@youngnick Hi! I really liked the concept of this project. I am proficient in python programming and Go. Would love to engage with the community and contribute here this spring.

[youngnick]

Great to hear @aastha01chauhan! As I said above, we'll need an application through the Linux Foundation Mentorship program. I've updated the description as well so that's more clear. Sorry for the confusion.

[khabdrick]

@youngnick are potential candidates required to make contributions to the project prior to getting accepted?

[akshat5302]

Hii @youngnick I want to be part of it I'm intermediate in python and DevOps and want to upskill myself by contributing to opensource. I just want to know if this contribution is still open in lfx mentorship or application had been closed?

[khabdrick]

@akshat5302 you can just go to the link and find out.
https://mentorship.lfx.linuxfoundation.org/project/0e4c9797-2dc5-4621-b46a-f1b7371a2495

[youngnick]

@khabdrick no, no requirements for contributions. I believe that applications close on the 15th of February, so get them in now!

[ShivamTyagi12345]

hey I believe my skills perfectly alignwith this mentorship and No mentees were accepted for this Is there a way to ask for a consideration?

[shreyadenny]

Hello I applied for this through the Linux Foundation Mentorship with hopes to be able to work on this particular project. Is there a way to find out the status of my application?

[akshat5302]

Hello I applied for this through the Linux Foundation Mentorship with hopes to be able to work on this particular project. Is there a way to find out the status of my application?

I applied too but didn't got any reply till yet

[youngnick]

Hi everyone, currently the process for selection is still ongoing, people will be notified of the results sometime on February 25, 2022 US Pacific time.

[mehabhalodiya]

/assign

[youngnick]

Nice work @mehabhalodiya, and sorry for not doing that earlier!

For everyone else watching this, please join me in congratulating @mehabhalodiya on her successful application!

We'll leave this issue open for tracking, and reference the docs assessment here once it's created.

[k8s-triage-robot]

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

• After 90d of inactivity, lifecycle/stale is applied
• After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
• After 30d of inactivity since lifecycle/rotten was applied, the issue is closed

You can:

• Mark this issue or PR as fresh with /remove-lifecycle stale
• Mark this issue or PR as rotten with /lifecycle rotten
• Close this issue or PR with /close
• Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

[youngnick]

@mehabhalodiya has done a great job and has finished up the docs assessment. Please see the results at https://github.com/cncf/techdocs/blob/main/assessments/0006-gateway-api.md .

/close

[k8s-ci-robot]

@youngnick: Closing this issue.

In response to this:

@mehabhalodiya has done a great job and has finished up the docs assessment. Please see the results at https://github.com/cncf/techdocs/blob/main/assessments/0006-gateway-api.md .

/close

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.