reacquaint ourselves with the docs

[Callisto13]

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 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, 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

[basit9958]

hello @Callisto13 , I would like to take this, let me know what is needed in the documentation 🐱

[Callisto13]

🙌 awesome! thanks @basit9958 !

Let me update the description so that it is more useful...

[Callisto13]

Okay updated, let me know if you have any questions or need any more clarity.

This is quite a hefty task, but means getting to know flintlock really well 😄

I am off with covid right now, but will be back online next Monday so will be more available for help (i am also happy to jump on a call and walk through things if you want help getting set up quickly) 👍

[basit9958]

I am also busy travelling 😿. I will give you a update on this on 27 😸.

[basit9958]

@sbdtu5498 message me on slack on weave users or cncf @basit Hasan

[github-actions]

This issue is stale because it has been open 60 days with no activity.

[github-actions]

This issue was closed because it has been stalled for 365 days with no activity.