Website and chat

[elBoberido]

Brief feature description

It would be great to have a nice website.

Detailed information

To have adequate online presence we should have a website with all the stuff related to iceoryx, e.g. documentation, links to github and other communication channels like gitter.

Have a look at zenoh for inspiration. It's build with the static site generator hugo.

An alternative would be zola. Why? Just one word: Rust ;)

• Gitter.im chat
• Domain
• Website

Open points w.r.t website:

• Missing forward from iceoryx.io
• Define goal of each example and order from most simple to most advanced
• Try preferred workflow with doxygen + doxybook2 + MkDocs
• Rework iceoryx_utils readme / safe standard library, will be done in Extend documentation for 1.0 release and website #482
• Introduce iceensamble (Show C <-> C++, History-Feature), will be done in Extend documentation for 1.0 release and website #482
• [ ] Move iceperf to iceoryx_posh/stresstest/
• [ ] Rework complete doxygen docu
• Add footer with informations regarding the eclipse organization, sponsors, communication and imprint (have a look at zenoh for inspiration from another eclipse project)
• Make codeblocks searchable
• Minor beautifications necessary e.g. code high-lite
• TOC generation when using includes is broken with MkDocs-Material, works fine with plain MkDocs
• Check GDPR (e.g. no cookies stored)
• *_on_c -> *_in_c.
• Add versioning
• Remove duplicate headings in doxygen docu

Todo for v2.0 (Moved #743)

• Create favicon
• Open Bugzilla issue to "enforce https"

[mossmaurice]

First step of the documentation for the website will be done in #283

[mossmaurice]

IMHO we need to differentiate between three levels: Beginner (non-technical people), intermediate (every developer), advanced (expert/ core developers).

As Markdown is limited when it comes to e.g. including files, I suggest to switch to reStructuredText. Other ideas have been mdBook or MkDocs.

Having the files in one repository has the advantage, that we can update them easily during development. I propose an export via a CI job into the iceoryx-web repository that is then serving iceroyx.io via GitHub pages.

Proposed table of contents for the website and repository is depicted below:

Repository:

Path	Goal	Target audience
./README.md	Brief introduction	Every developer (Beginner/intermediate)
./doc/goals-non-goals.md	Provide background about the project	Every developer (Intermediate)
./doc/design/*	Store detailed design documents	Core developers (Advanced)
./doc/website/*	How to use?	Non-technical people, developers and integrators new to iceoryx

Website:

Path	Goal	Target audience
./doc/website/introduction.md	Introduction to Eclipse iceoryx	Non-technical people
./doc/website/getting-started/overview.md	Introduce modules (RouDi, Runtime, etc.)	Developer (intermediate)
./doc/website/getting-started/installation.md	How to build and install?	Developers, Integrators (intermediate)
./doc/website/getting-started/examples.md	Walkthrough through the examples and present various use-cases	Developers, Integrators (intermediate)
./doc/website/for-developers/*	Advanced, in-depth topics	Expert/core developers

First step will be implemented in #283

[mossmaurice]

First test worked, index.html is available: https://eclipse-iceoryx.github.io/iceoryx-web/