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

Task Force Proposal: Documentation #46

Open
4 tasks
tkuhrt opened this issue Jan 26, 2023 · 3 comments
Open
4 tasks

Task Force Proposal: Documentation #46

tkuhrt opened this issue Jan 26, 2023 · 3 comments
Assignees
Labels

Comments

@tkuhrt
Copy link
Contributor

tkuhrt commented Jan 26, 2023

Introduction/background material

In the first meeting of the 2023 TOC, one of the goals specified was to create documentation standards.

Task to be completed

The main goal of this task force is to document standards for new projects to use for creating their documentation.

List of deliverables or work products

  • Common styling guide
  • Recommended common publishing platform
  • Document best practices for creating documentation, including information on tooling and the audiences
  • Create a template repo that new projects can use for creating their documentation

Time to complete (no more than 6 months)

TBD

Leader

Bobbi Muscara

Initial participant list

  • Venkatraman Ramakrishna (Rama)
  • Tracy Kuhrt
@bobbi28 bobbi28 self-assigned this Feb 9, 2023
@octonawish-akcodes
Copy link

octonawish-akcodes commented Apr 26, 2023

@bobbi28 @tkuhrt I am interested on working on this under hyperledger mentorship, can you guide me how can I contact you.

@YashPimple
Copy link

Hello @tkuhrt @bobbi28 , I am interested in learning about this project and want to work on this project under Hyperledger Mentorship. This issue seems like a great starting point for getting started with a contribution to Hyperledger.
I would like to know about any materials or resources I should refer to to better understand the project.

Additionally, I was wondering if there is anything else I can do to get started, such as reference and learn about the project from the existing documentation

@bobbi28
Copy link

bobbi28 commented May 15, 2023 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants