cncf / techdocs

CNCF TechDocs Team
https://cncf.io
Apache License 2.0
43 stars 26 forks source link

CNCFSD-1516 Do a first look at the TUF project docs... #162

Open nate-double-u opened 1 year ago

nate-double-u commented 1 year ago

Docs assessment request: https://cncfservicedesk.atlassian.net/browse/CNCFSD-1516

Take a first pass at the TUF project and look and see how an outsider would view it.

nate-double-u commented 1 year ago

This is potentially both a TechDocs assessment and a Website update request.

anshikavashistha commented 6 months ago

@nate-double-u I would love to work in this project under LFX mentorship. Is there any prerequisite task which needs to be done ?

Ayush9026 commented 6 months ago

@nate-double-u Sir I am eager to contribute to this project under mentorship.

nate-double-u commented 6 months ago

Applications can be made here. There are no prerequisites beyond what the application lays out.

edit: correcting link.

priyakumari02 commented 6 months ago

Hello @nate-double-u , I am unable to access the link https://cncfservicedesk.atlassian.net/browse/CNCFSD-1516

nate-double-u commented 6 months ago

Hello @nate-double-u , I am unable to access the link https://cncfservicedesk.atlassian.net/browse/CNCFSD-1516

This is an internal CNCF service desk link, access isn't needed for candidates.

For an overview of the TechDocs Analysis program and how it works, please take a look at https://github.com/cncf/techdocs/tree/main/assessments, and the documentation set that will be analyzed is https://theupdateframework.io/

MANISH-K-07 commented 6 months ago

Hey @nate-double-u , I am Manish K, an undergrad sophomore pursuing Computer Science Engineering in India and keen on open source. GitHub , LinkedIn I have colossal passion for research, analysis and technical writing, and also published a paper related to Blockchain technology titled Charity with Clarity: Crowdfunding using Smart Contracts at IEEE. I am equally proficient in business english (also certified)

This is potentially both a TechDocs assessment and a Website update request.

Regarding the mentorship program, I came across this project and had a quick overview of it. There are a few areas that hold potential for updates and enhancement such as the Specification Index frontend. I would like to help you guys in assessing the docs (I can play around well with git and markdown) and also with website updates wherever we require.

Could you please tell me how I can prove my experience here and also get in touch with mentors? Hope I'm not too late :)

Thanks, Manish K

nate-double-u commented 6 months ago

The best way to show your experience is to apply to the program via the LFX platform.

Ayush9026 commented 6 months ago

Okay @nate-double-u sir thank you.

shubhusion commented 6 months ago

@nate-double-u Should the tech doc assessment be submitted as part of Sample Writing, or do I need to raise a PR?

nate-double-u commented 6 months ago

A writing sample can be any writing a candidate has previously done; we're just looking to confirm that a candidate has written English language proficiency.

MANISH-K-07 commented 5 months ago

@nate-double-u , @chalin could you please give an update on when the summer term begins? https://docs.linuxfoundation.org/lfx/mentorship/mentorship-program-timelines

nate-double-u commented 5 months ago

Assigning @chalin as a part of CNCF LFX 2024 Term 2 Mentorship.