liquidmetal-dev / liquidmetal-dev/flintlock

reacquaint ourselves with the docs

Open
#463 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/documentation kind/feature lifecycle/stale
Dominant language
Go
Stars
1.5k
Forks
73
Avg merge
17h 24m
Merged PRs (30d)
30

Description

We have docs published here https://docs.flintlock.dev/ .

They were generated from our **dev** markdown docs (found in `docs/` I believe) late in 2021 . (Personally I am not sure how, hopefully there will be something in the original PR.)

What we need are **user facing** docs (as well as dev ones) and a nicely documented process of how to alter/generate/publish them.

The docs are also fairly underdeveloped visually: we still have the placeholder images/icons which [docusaurus](https://docusaurus.io/) comes with. We should update to use our own svgs which we now have.

So, outcomes:
- The existing docs are reviewed, restructured and rebranded.
- The main "theme" of the docs should be "How do I, as a user, create Microvms with flintlock". Including (but not limited to):
- An easy getting started guide
- More advanced options
- How to provision flintlock
- Microvm spec examples (in json and Go client snippets)
- How to interact with flintlock using the recognised tools ([fl](https://github.com/weaveworks-liquidmetal/fl), [hammertime](https://github.com/warehouse-13/hammertime), etc)
- Any troubleshooting notes
- There should be another clearly marked section for **developing** flintlock (basically what we have now, just moved under a clear tab/page/whatever)
- A repo doc explaining how the docs are built and how to develop/update them

***Note: as for publishing the site with the updates, this may need to be handled by a teammember as I am not sure we have automation around that right now***

Contributor guide

Open the contributing guide

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 by reviewing the existing docs/ markdown and the published site at docs.flintlock.dev, then identify how the Docusaurus site is currently generated and published. Done means the docs are restructured around user workflows, retain a clearly separated development section, use the available SVGs, and include a repository guide for building and updating them.

Written by the indexing model from the issue text.

Assessment

Tech stack
go, markdown
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.