Skip to content
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

Add documentation #509

Merged
merged 8 commits into from
Dec 17, 2017
Merged

Add documentation #509

merged 8 commits into from
Dec 17, 2017

Conversation

mueller-ma
Copy link
Member

@mueller-ma mueller-ma commented Dec 9, 2017

Resolves #495

Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
Signed-off-by: mueller-ma <mueller-ma@users.noreply.github.com>
docs/USAGE.md Outdated

## Trademark Disclaimer

Product names, logos, brands and other trademarks referred to within the openHAB website are the property of their respective trademark holders. These trademark holders are not affiliated with openHAB or our website. They do not sponsor or endorse our materials.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if we need this here.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No.

docs/USAGE.md Outdated

Product names, logos, brands and other trademarks referred to within the openHAB website are the property of their respective trademark holders. These trademark holders are not affiliated with openHAB or our website. They do not sponsor or endorse our materials.

Google Play and the Google Play logo are trademarks of Google Inc.
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need to add this, when we want to use the play badge.

Copy link
Member

@ThomDietrich ThomDietrich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @mueller-ma,
please find a few comments below. I did only review what is there. I did not think about what could be missing Maybe you can think of missing noteworthy features or extra chapters to add?

docs/USAGE.md Outdated

# Android openHAB App

openHAB Android application is a native client for openHAB. It uses REST API of openHAB to render your sitemaps.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ... native openHAB client for Android phones and tablets.

Consider leaving out "REST API". That's a technical detail users shouldn't care about (nor will they understand it)

The app follows the basic principles of the other UIs, like Basic UI, and presents your predefined openHAB sitemap(s).

docs/USAGE.md Outdated
<a href="https://play.google.com/store/apps/details?id=org.openhab.habdroid"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80"></a>

## Features
* Control your openHAB server and [openHAB Cloud instance](/~https://github.com/openhab/openhab-cloud)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

..., e.g., an account with myopenhab

docs/USAGE.md Outdated

## Features
* Control your openHAB server and [openHAB Cloud instance](/~https://github.com/openhab/openhab-cloud)
* Receive notifications from openHAB Cloud
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

via

How about adding a link to http://docs.openhab.org/addons/actions.html in preparation for openhab/openhab-docs#479 ?

docs/USAGE.md Outdated
## Features
* Control your openHAB server and [openHAB Cloud instance](/~https://github.com/openhab/openhab-cloud)
* Receive notifications from openHAB Cloud
* Change items via NFC tags
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's possible here? Please link NFC tag (e.g. en.wikipedia)

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would like to wait with this point until #515 is solved.

docs/USAGE.md Outdated
* Receive notifications from openHAB Cloud
* Change items via NFC tags
* Send voice commands to openHAB
* Discover devices and add them as items
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If I followed the latest changes, this was removed?
Even if not, I'd not advertise it as a feature...

docs/USAGE.md Outdated

You also have the option to manually set the server URL in the settings.
Please enter the base URL to your openHAB server as you would enter it in the browser to reach the openHAB dashboard.
The URL might look like one of the following examples.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

colon?

docs/USAGE.md Outdated
Normally, after unchecking the Demo Mode, the app will be able to use multicast DNS to autodetect to your openHAB server if it is on the same network.

You also have the option to manually set the server URL in the settings.
Please enter the base URL to your openHAB server as you would enter it in the browser to reach the openHAB dashboard.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add two highlights here:

Local Connection: Enter the base URL of ...

Remote Connection: The option to set a "Remote URL" ...

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wdyt?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it is clear enough what to enter.

Copy link
Member

@ThomDietrich ThomDietrich Dec 14, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's not about clear or not, those paragraph names will add more structure to the article. Currently there are 5 paragraphs, one being general, three regarding local and one paragraph regarding remote connection configuration. Adding structure here would probably not hurt :D

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the structure.

docs/USAGE.md Outdated
The option to set a "Remote URL" allows the app to be used when you are away from home.
There are a number of strategies available to provide [secure remote access]({{base}}/installation/security.html) to your openHAB server.

## Help and technical details
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

docs/USAGE.md Outdated

## Help and technical details

Please refer to the [openhab/android project on GitHub](/~https://github.com/openhab/openhab.android) for more details.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

openhab.android?

docs/USAGE.md Outdated

## Trademark Disclaimer

Product names, logos, brands and other trademarks referred to within the openHAB website are the property of their respective trademark holders. These trademark holders are not affiliated with openHAB or our website. They do not sponsor or endorse our materials.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No.

docs/USAGE.md Outdated

<div class="row">
<div class="col s12 m5"><img src="images/main_menu.png" alt="Demo Overview"></div>
<div class="col s12 m5"><img src="images/widget_overview.png" alt="Demo Widget Overview"></div>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My bad. This will look bad as it only occupies 10/12th of the screen width on a PC screen.
Either change both lines to m6 or insert some space in the middle:

  <div class="col s12 m6">
  <div class="col s12 m6">
  <div class="col s12 m5">
  <div class="col s12 m5 offset-m2">

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed it

docs/USAGE.md Outdated
title: Android openHAB App
---

{% include base.html %}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add a back-reference like this:

---
layout: documentation
title: Android openHAB App
source: /~https://github.com/openhab/openhab.android/blob/master/docs/USAGE.md
---

{% include base.html %}

<!-- Attention authors: Do not edit directly. Please add your changes to the appropriate source repository -->

# Android openHAB App

docs/USAGE.md Outdated

# Android openHAB App

The openHAB Android application is a native client for openHAB. The app follows the basic principles of the other UIs, like Basic UI, and presents your predefined openHAB [sitemap(s)}(http://docs.openhab.org/configuration/sitemaps.html).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

bracket typo

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed

docs/USAGE.md Outdated
<a href="https://play.google.com/store/apps/details?id=org.openhab.habdroid"><img src="https://play.google.com/intl/en_us/badges/images/generic/en_badge_web_generic.png" height="80"></a>

## Features
* Control your openHAB server and [openHAB Cloud instance](/~https://github.com/openhab/openhab-cloud), e.g., an account with [myopenhab](http://www.myopenhab.org/)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*or ?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"myopenHAB"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*and/or?

docs/USAGE.md Outdated

## Features
* Control your openHAB server and [openHAB Cloud instance](/~https://github.com/openhab/openhab-cloud), e.g., an account with [myopenhab](http://www.myopenhab.org/)
* [Receive notifications via openHAB Cloud](http://docs.openhab.org/addons/actions.html)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd go with

Receive notifications through an openHAB Cloud connection, read more

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed


## Permanent Deployment

If you want to use openHAB Android on a wall mounted tablet, go to settings and tick `Disable display timer` and `Full Screen`.
Copy link
Member

@ThomDietrich ThomDietrich Dec 11, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Isn't it "Fullscreen"?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Firefox: "Display page in full screen"

Copy link
Member

@ThomDietrich ThomDietrich Dec 16, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@mueller-ma okay then, I wasn't sure either. Let's merge then, I'm in the process of preparing openhab-docs to fetch the USAGE file.

@ThomDietrich
Copy link
Member

@mueller-ma looks good now. I've left a few last comments.

Copy link
Member

@ThomDietrich ThomDietrich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and would be ready to merge.

Last two things I want to point to, add them or not ;)

@mueller-ma
Copy link
Member Author

I also wait for #509 (comment)

@mueller-ma mueller-ma merged commit 0821c2f into openhab:master Dec 17, 2017
@mueller-ma mueller-ma deleted the 495-docs branch December 17, 2017 11:09
@mueller-ma mueller-ma changed the title WIP: Add documentation Add documentation Dec 17, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants