-
-
Notifications
You must be signed in to change notification settings - Fork 49
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[RFC] Add New User Guide to Homepage #422
base: main
Are you sure you want to change the base?
Conversation
RFC Signed-off-by: egoist6 <[email protected]>
I am fine with adding a "quick start" guide to the website, although it will be more difficult to maintain than on the documentation website and we also won't have versioning of it. |
I see where you're going from but we'll need to define that properly i.e. if you want some interactive thing to get up and started with openHAB on the homepage, that's great but there's already a Getting Started Tutorial (written mostly by @rkoshak) so what do you see it solving that the tutorial doesn't? I think you and @rkoshak could work together to figure out what's missing. As for the technical side, I think we ought to upgrade VuePress eventually (or migrate to VitePress), and even overhaul the home page (at least) in the process, so maybe it would be wise to settle on this before we endeavor anything else with the current website. I'll add that openHAB.org is one of the few websites where you can "test the product" right on the home page: |
This is what the Getting Started Guide is supposed to do so whatever is being proposed here is essentially a replacement/reworking of Getting Started. I'm not against a complete overhaul of Getting Started by any means but I am not in favor of yet another guide. That would be more confusing than helpful. Also don't forget the new help tutorials and such added to the developer sidebar. Ultimately, the challenge is forever going to be presenting enough detail to actually use OH without presenting too much. Maybe Getting Started presents too much, but it's hard to draw a line. |
What is the current state of the discussion? |
Hi Stefan, |
One of the outcomes of 2 very intense discussions here and here is the lack of guidance for new user who either have limited technical knowledge or do not want to study several sections in our documentation and will need a lot of time to read through all important pages.
I’d like to add a new section on our homepage (text, graphics) and link to the guide. By intention I do not want to use our documentation for this guide as we do not want to confront new (unexperienced) users with our rich and detailed documentation.
This guide will cover all steps from downloading to creating a first easy rule in a very easy and compressed way with the aim to show how easy it is to get up and running with openHAB.
This opening PR is a RFC where I want to get in contact with you and discuss this before I start putting work in this. Maybe you also have some tips for me how to do the changes here as I am not familiar with Vuepress and editing md files. I will do my best but you probably need to do some layouting stuff to make it look good.
Thanks, Oliver