#96 Convert IoT getting started wiki to docs platform
Closed Opened by bcotton.

On behalf of @pbrobinson and the IoT WG, we should move the IoT Getting Started content to docs.fedoraproject.org.

@bex says to tag him in this


Thanks @bex I never got to this today, I'd like, if possible, a IoT space where we can put a series of docs. Basically have it as the hub as opposed to the wiki

I converted it, but Antora did build it if I specify a start_page: in yml files (it's removed now). I don't know how it's supposed to be.

https://pagure.io/iot-getting-started-docs

@ojn Yeah, it should be specified. You'll also need to make some other changes.

1) In antora.yml, change the name: to fedora. This is for the project name, not for the module name.

2) Optionally, if you want to use the previous name somewhere, rename the modules/ROOT directory to modules/iot-pages. You don't have to but a lot of other docs do it, so why not.

3) In site.yml, use:

  title: Local Preview
  start_page: fedora:iot-pages:index

(If you didn't do step 2) and kept the module name as ROOT, use `start_page: fedora::index instead.)

4) If you renamed the module directory in pointp 2, ensure the nav: definition in antora.yml points to the right location (i.e. modules/iot-pages/nav.adoc).

Regarding the "Local Preview" title in site.yml: The site config that is in each repo is only used during a local build, not on the site itself; the site builder uses its own config. For that reason, we use title: Local Preview in each of the repo-specific configs - it helps people see they're looking at a local preview and not at the whole site. I suggest you use the same title here to keep this repo in line with the others.

I found a couple other problems but they're not necessarily related to the conversion, so I'll open issues in the IoT Getting Started repo.

Thanks for great explanations, that clarified it my confusions.

I've just added svg image of Raspberry Pi like board with "Fedora sticker" (preview https://ojn.fedorapeople.org/img/iot-fedora.svg) it's public domain (a simplified version of https://openclipart.org/detail/214750/raspberry-pi-typeb-no-logo-edition).

Just to think in mind: if someone would use this repo to create a pdf file, depending on the tool used -they might need to convert it to png.

So I've taken initial conversion of the getting started docs and used it as a basis of the main IoT docs for the IoT Objective, I imported your initial conversion of the getting started guide into this repo: https://pagure.io/fedora-iot/iot-docs

Metadata Update from @pbrobinson:
- Issue status updated to: Closed (was: Open)

Metadata