chore: generate docs & site for d-operators

Open

#86 opened on Jun 30, 2020 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

chore documentation good first issue

Dominant language: Go
Stars: 10
Forks: 6
PR merge metrics: No merged PRs in 30d

Description

I prefer gitbook - https://github.com/kubernetes-sigs/kubebuilder/tree/master/docs

Refer for MkDocs:

Contributor guide

Open the contributing guide

First steps

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

Research direction

Start by reviewing the linked kubebuilder docs and the Typhoon mkdocs.yml and docs examples. The issue does not identify source files, commands, or specific content, so first define the documentation structure and site generator; done means the d-operators documentation and site are generated and published according to that plan.

Written by the indexing model from the issue text.

Assessment

Domain: documentation
Issue type: Documentation
Difficulty: 5/5
Estimated time: Over a week
Activity status: Stale
Clarity: Needs clarification
Newbie friendliness: 20/100

A short digest of beginner-friendly GitHub issues.