lagovista / docs Goto Github PK

HTML 95.77% C# 0.84% JavaScript 3.35% CSS 0.04% Dockerfile 0.01%

docs's Introduction

NuvIoT Documentation Project

This Project is used to Maintain Documentation Used for building projects with IoT App Studio

Documentation Workflow

The top of each Markdown file will include meta data about the help file, here is an example of that data.

---
title: Input Translator
description: Provides a description of an Output Translator, what it does and how to add one.
keywords: listeners, inputtranslator, pipelinemodule

status: inprocess
created: 20170927
updated: 20170927
createdby: bytemaster-0xff
updatedby: bytemaster-0xff
---

The meta data will start out with three dashes (---) which will always be the first three characters of the file. The meta data will then be terminated by three dashes as well (---).

Here are a description of the meta data fields

title - Title of the document, this will be used in search results.
description (optional) - A one sentance description of the content of the document.
keywords - Any applicable keywords that might be helpful in searching the document status - We will have a set of status that define the workflow of publshing documentation

new - Documentation headers and place holders are created, not content was added.
inprocess - Documentation is currently being created by developers or engineers
readyforreview - Developers think that the content is complete and ready for QA/Technical writing cleanup.
readyforapproval - QA/Technical writers have reviewed the content for grammer and made sure it follows a the style guide.
issues - Developers, QA/Technical writers have found an issue that needs to be resolved in the document. The actual issue itself can either be added as a Github issue or added as free form at the end of the metadata. Once the issue has been resolve the issues should be removed from the meta data.
approved - A project architect has approved the content and edits and the documentation is ready for publishing.

For now to find documents in different status, just search the repository by status name, in the future tooling might be available.

created - The date stamp when the documentation was created, this will always be 8 characters and be in the format YYYYMMDD.
updated - The date stamp when the documentation was last updated, this will always be 8 characters and be in the format YYYYMMDD.
createdby - The github user id of the user that created the document updatedby - The github user id of the user that last updated the document

docs's People

Contributors

Watchers

Forkers

klworkman lulzzz dickkluis pravet-os jennywrenwolf

docs's Issues

Add Content for Type System - Strings

InviteMessage Wording

            InviteMessage: " has invited you to ", /* This is put between persons name and org name, might not translate, please discuss */

How about: InviteMessage: "[Your Name] has invited you to [Your Organization]."

I'm not sure how this resolves on the screen so it's hard to conceptualize. I'm assuming there are blanks for the user to fill in?

Display issue with Listener Tutorial

The steps when displaying the Username and Password go off position in the pop-up window.

Resources/Labels - Solutions

 Deployment: {
        Index: {
            Title: "Deployments",
            Greeting: "Deploy Your Solution"
        },
        Solutions: {
            Title: "Solutions",
            Greeting: "Solutions are a collection of device configurations and how the server infrastructure should be hosted."

Toc.md Deployment

Linked summary page lists Subscriptions but that is not listed on the TOC page. Should I add subscriptions and the link to the list?

Figure out how to do interpage linking

In Parsing/Overview, we have Search-Location and Search Types

New tutorial pop-up overlay display of the Description URL

Do we even need to display the URL? and if we do should it display as a clickable URL?

The description was already displayed before they went to the pop-up.

Was the intention re-display the whole help file?
Alternate to that would be to make the pop-up window a new "true" browser window that is moveable and sizeable, without the browser bars showing. Kill the window when done with the tour.

Working with Date Time Values - add content

Changed: Edge and IE on Windows 10 issues

It only seems to work in Chrome (tested on Mac)

Safari and FireFox (on Mac) do not show the button but still show the old way with the tab. And still seem to work the old when you click the tab.

Edge on Windows 10 aborts as soon as you click the configure a planner tutorial step:

Internet Explorer on Windows 10 seems to be in a loop after trying to login.

Guide: Sub-guide viewing

The considerations tab show up but no data is displayed. If you click the considerations tab the data shows up.

Enhancement: Do not show the "Guide Tour" button under some conditions

Example:

When the first step of guide does not have:

Condition 1

Initial Controller and Initial View nor the Child Guide and the Child Guide Step filled in

Condition 2

Child Guide and Child Guide Step are filled in and the Child Guide Step (first step) does not have the Initial Controller and Initial View filled in.

Vertical Scrolling seems disabled

Tested Chrome and Safari. Both don't scroll at all anymore one you open a tutorial (guide)

Firefox seems to still scroll.

Messaging/Parsing Verifiers Header Displays improperly

I have checked this header against other pages and can't find a reason for it to be behaving differently. The full header displays in the body of the page, without formatting.

Guide: Device Workflow > Show Workflow step

The help box does not display and Chrome shows the following error:

Guide: Device Configuration -> Select Sentinel step

The help box does not show. Note: The step for the Input Translator is the same and that one shows fine.

Add Parsing XML section

Add content for the XML Parsing Section

Mobile Apps - Second sentence unclear

Mobile Apps

NuvIoT is a complete, end-to-end system. It allows you to capture and process data from sensors and devices. After all, without devices and sensors, you cannot have IoT.

Although the is created by your devices and sensors, the real value comes in when that data is put to use. In addition to providing online tools to manage and report on incoming data, we offer two paths for Mobile Apps.

Add content for Parsing from a Topic

Guide: Viewing a Tutorial

The tutorial viewing is limited to a preset area and it forces you to scroll to see information and in certain situations, it does not let you scroll far enough. And in other situations, you have to scroll back to the top to be able to hit the next button.