OpenLake / OpenLake/OpenLake--Website

Create documentation for contributors

Open
#20 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue
Dominant language
TypeScript
Stars
3
Forks
16
Avg merge
8h 54m
Merged PRs (30d)
7

Description

Create documentation for contributors

This is a sub-issue of #15

Overview

Develop comprehensive documentation to guide contributors on how to submit new blog posts to our platform.

Tasks

  • Write CONTRIBUTING_BLOGS.md guide with clear step-by-step instructions
  • Create a blog post template file (blog-template.md) with example frontmatter
  • Document all required and optional frontmatter fields with descriptions
  • Provide examples for common Markdown formatting elements (headings, lists, code blocks)
  • Include guidance on image inclusion and optimization
  • Document the full contribution workflow (fork → create → submit PR)
  • Add troubleshooting section for common issues

Contents for CONTRIBUTING_BLOGS.md

  1. Introduction and purpose
  2. Prerequisites (GitHub account, basic Markdown knowledge)
  3. Step-by-step contribution process
  4. Frontmatter fields reference
  5. Markdown formatting guidelines
  6. Media inclusion guidelines
  7. Sample blog post examples
  8. Submission checklist
  9. Troubleshooting

Definition of Done

  • Documentation is clear, comprehensive, and beginner-friendly
  • Blog template file is created and well-commented
  • All frontmatter fields are properly documented
  • Media handling instructions are clear with examples
  • Documentation is reviewed for accuracy and completeness

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the requested CONTRIBUTING_BLOGS.md outline and blog-template.md tasks, using the issue checklist to organize the frontmatter, Markdown, media, workflow, examples, and troubleshooting sections. Done means both files exist, the required fields and contribution steps are documented with beginner-friendly examples, and the definition-of-done review confirms accuracy and completeness.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, markdown
Domain
content, documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.