Proposed Additions and Changes for Getting Started

[toby63]

(This is related to [Request] Add more info about images into Getting Started , but more generic)

Update:
See also https://github.com/lxc/linuxcontainers.org/issues/412
https://github.com/lxc/linuxcontainers.org/issues/413

@stgraber @tomp

Before I start writing a pull request for the getting started page,
I want to ask you, what you would like to see included or changed and what not, so here is a list of my ideas and questions:

1. General questions regarding “rules” for editing:

• can I include links to official external documentation (e.g. like cloud-init)?

• I guess everything should be as short as possible?

2. My ideas:
   I would add more info about:

• the options of lxd-init (like answers to “what is clustering?”)

• VMs:

  • should I seperate this, or mingle it (most topics like images, profiles etc. apply to both (containers and vms)) ?

• details for “lxc launch” (like requested in this issue)

• profiles (only short info + links)

  • extended info could be in the docs (https://linuxcontainers.org/lxd/docs/master/profiles), but would need a rewrite

• (maybe later) cloud-init (only short info + links):

  • extended info could be in the docs (“cloud-init”, but would need a rewrite
  • potencial link: https://cloudinit.readthedocs.io/en/latest/topics/examples.html

• images:

  • “official” images (how to list, find and use them)
  • “download the images yourself”
    • maybe only a link to seperate documentation (would need a new page, maybe “images”)
    • otherwise link to imageserver and how to download & import the images
  • “building your own images”:
    • maybe only a link to seperate documentation (“images”), otherwise:
      • link to distrobuilder instructions
      • link to image templates
      • extended info: e.g. about how to modify the image templates
  • link to image handling or include it in new document (“images”)

• storage (pools) (only short info + links)

• add a section for tips & tricks (for better workflow)

• Links:

  • To the documentation and also:

    • Security
    • FAQ

  • To the forum: https://discuss.linuxcontainers.org/

3. Regarding the layout of the document, I would like to:

• add a Content-List at the beginning (so one can easier find content inside);
  I created an example here: https://github.com/toby63/linuxcontainers.org/blob/master/content/lxd/getting-started-cli.md#content

• use tables to summarize flags, commands etc., I also created one example in the section about snap packages:
  https://github.com/toby63/linuxcontainers.org/blob/master/content/lxd/getting-started-cli.md#snap-package-arch-linux-debian-fedora-opensuse-and-ubuntu

Seperate but related Idea:
Create an additional “Advanced Guide” that we could link to in “Getting started”, that could include topics like:

• networks
• storage pools
• devices
• cloud-init
• Cluster
  etc.

[derekmahar]

@toby63

networks

I’d like to learn more about container networking.