Skip to content

Commit

Permalink
Add improved documentation
Browse files Browse the repository at this point in the history
Migrated existing documentation to the
new Solution Center Docusaurus system,
including reorganization and setup.

Additionally, the documentation was
updated or added to in order to reflect
changes made in the v2.0.0 release.
  • Loading branch information
alexjhawk committed Aug 18, 2023
1 parent c68be40 commit 36406c0
Show file tree
Hide file tree
Showing 68 changed files with 9,860 additions and 413 deletions.
57 changes: 57 additions & 0 deletions .github/workflows/doc-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# HMS Networks Solution Center
# Docusaurus Deploy Action for Maven-based Ewon ETK Projects,
# Adapted for the Ignition Ewon Connector Project
#
# Version: 1.1
#
# This action is configured to automatically run when a push
# is made to either the `main` or `gh-pages-staging` branch,
# or when a run is manually triggered.
name: Docusaurus Deploy to GitHub Pages

on:
push:
branches:
- main
- gh-pages-staging
workflow_dispatch:

jobs:
deploy:
name: Docusaurus Deploy to GitHub Pages
runs-on: ubuntu-latest
defaults:
run:
shell: bash
working-directory: web-docs
steps:
- uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: yarn
cache-dependency-path: web-docs/yarn.lock

- name: Install Dependencies
run: yarn install --frozen-lockfile

- name: Build Website
run: yarn build

# Popular action to deploy to GitHub Pages:
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v3
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
# Build output to publish to the `gh-pages` branch:
publish_dir: web-docs/build
# The following lines assign commit authorship to the official
# GH-Actions bot for deploys to `gh-pages` branch:
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
# The GH actions bot is used by default if you didn't specify the two fields.
# You can swap them out with your own user credentials.
user_name: github-actions[bot]
user_email: 41898282+github-actions[bot]@users.noreply.github.com
40 changes: 40 additions & 0 deletions .github/workflows/doc-test-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# HMS Networks Solution Center
# Test Docusaurus Deploy Action for Maven-based Ewon ETK Projects,
# Adapted for the Ignition Ewon Connector Project
#
# Version: 1.0
#
# This action is configured to automatically run when a pull request
# is opened for the `main` branch.
name: Test Docusaurus Build

on:
pull_request:
branches:
- main

jobs:
test-deploy:
name: Test Docusaurus Build
runs-on: ubuntu-latest
defaults:
run:
shell: bash
working-directory: web-docs
steps:
- uses: actions/checkout@v3

- name: Setup Node.js
uses: actions/setup-node@v3
with:
node-version: 18
cache: yarn
cache-dependency-path: web-docs/yarn.lock

- name: Install Dependencies
working-directory: ./web-docs
run: yarn install --frozen-lockfile

- name: Test Build Website
working-directory: ./web-docs
run: yarn build
132 changes: 132 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
# Ignition Ewon® Connector Project Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual identity
and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement using the GitHub
report feature and selecting "Report to repository admins."
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
at [https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations
140 changes: 140 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# Ignition Ewon® Connector Contribution Guidelines

Thank you for your interest in contributing to the project.

All types of contributions are valued and encouraged, though there are a few guidelines which must be followed to make the contribution process easy and consistent. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them.

If you like the project, but don't have time to contribute, there are other easy ways to show your support and appreciation, such as:
- Star the project
- Refer to this project in another project
- Mention or share the project at local meetups and tell your colleagues

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Asking Questions](#asking-questions)
- [How to Contribute](#how-to-contribute)
- [Reporting Bugs and Errors](#reporting-bugs-and-errors)
- [Suggesting Features or Enhancements](#suggesting-features-or-enhancements)
- [Making Modifications or Updates](#making-modifications-or-updates)
- [Documentation](#documentation)
- [Source Code](#source-code)
- [Committing and Merging Modifications and Updates](#committing-and-merging-modifications-and-updates)
- [Commit Scope](#commit-scope)
- [Commit Messages](#commit-messages)
- [Pull Requests](#pull-requests)

## Code of Conduct

This project and everyone who participates in it is governed by the project's [Code of Conduct](https://github.com/hms-networks/IgnitionEwonConnector/blob/main/CODE_OF_CONDUCT.md).

By participating, you are expected to uphold this code. Please report unacceptable behavior to the project maintainer(s).

## Asking Questions

Before asking a question, it is best to search for existing [Issues](https://github.com/hms-networks/IgnitionEwonConnector/issues) or [Discussions](https://github.com/hms-networks/IgnitionEwonConnector/discussions) that may help. In case you've found a suitable issue or discussion and still need clarification, you may comment directly on the issue or discussion. It is also advisable to search the internet for answers.

If you then still have a question or need clarification, you may create a [new discussion](https://github.com/hms-networks/IgnitionEwonConnector/discussions/new) or [new issue](https://github.com/hms-networks/IgnitionEwonConnector/issues/new) and provide as much context and detail as possible.

## How To Contribute

> ### Legal Notice
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content, and that the content you contribute may be provided under the project license.
### Reporting Bugs and Errors

We use GitHub issues to track bugs and errors. If you run into an issue with the project, please create a [new issue](https://github.com/hms-networks/IgnitionEwonConnector/issues/new) with the following in consideration:

- Explain the behavior you would expect and the actual behavior.
- Please provide as much context as possible and describe the *reproduction steps* that someone else can follow to recreate the issue on their own. This usually includes your code. If possible, please isolate the problem and create a test case.

Once you have submitted an issue on GitHub, we will label it and follow-up accordingly.

### Suggesting Features or Enhancements

We use GitHub issues to track feature and enhancement requests. If you'd like to suggest a feature or enhancement, please create a [new issue](https://github.com/hms-networks/IgnitionEwonConnector/issues/new) with the following in consideration:

- Make sure that you are using the latest version.
- Make sure that you are using the latest Ewon firmware.
- Check for updates at [https://www.ewon.biz/technical-support/pages/firmware](https://www.ewon.biz/technical-support/pages/firmware).
- Read the [Documentation](https://hms-networks.github.io/sc-java-maven-starter-project/docs) carefully to find out if the functionality is already covered.
- Perform a search for existing [Issues](https://github.com/hms-networks/IgnitionEwonConnector/issues) or [Discussions](https://github.com/hms-networks/IgnitionEwonConnector/discussions) to see if the feature or enhancement has already been suggested.
- If the feature or enhancement has already been suggested, add a comment to the existing issue or discussion instead of opening a new one.
- Make sure the feature or enhancement is with the scope and aims of the project. New features shall be useful to the majority of users, not a small subset.
- If a feature or enhancement targets a minority of users, it is advised to consider writing an add-on or library.

### Making Modifications or Updates

The development environment for this project uses the standard Ewon Java development environment, which is [Eclipse](https://www.eclipse.org/). Alternative IDEs can be used but may not be fully compatible with the Ewon Java Toolkit and thus are not guaranteed nor officially supported by HMS.

Documentation and additional information about the Ewon Java development environment is available in the Ewon Java Toolkit User Guide \(J2SE\) at [https://developer.ewon.biz/content/java-0#dev-documents](https://developer.ewon.biz/content/java-0#dev-documents).

#### Documentation

Changes made to the documentation in this project must be made in an individual commit, or accompany the commit with the relevant source code changes.

Documentation for this project shall be written in present passive voice and is governed by the project's [Code of Conduct](https://github.com/hms-networks/IgnitionEwonConnector/blob/main/CODE_OF_CONDUCT.md).

#### Source Code

Changes made to the source code in this project must be organized into individual commits, each with an individual objective.

Source code in this project adheres to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html), and any changes must follow the same format. Detailed information about the Google Java Style Guide can be found at [https://google.github.io/styleguide/javaguide.html](https://google.github.io/styleguide/javaguide.html).

Source code changes which do not adhere to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) will be rejected automatically during the pull request phase.

### Committing and Merging Modifications and Updates

#### Commit Scope

Each commit to this project should have very limited scope. All changes in each commit should have a common theme, and you should be able to describe the scope of the change as a single statement. _Hint: If you can not describe the commit without using the word "and" or creating a list, the commit should be broken up._

To ensure a clean and productive Git history, commits which do not follow those guidelines should be reorganized, otherwise they may be rejected during the pull request phase.

#### Commit Messages

Each commit must contain a message describing the change(s) made. The commit message must meet the following guidelines:

1. Subject (First Line)
1. Must not be more than 50 characters in length
2. Must describe commit change-set concisely
3. Must capitalize first character
4. Must not end with a period
5. Must be followed by a blank line (unless body omitted)
2. Body
1. Must not be more than 72 characters in length, per line
2. Must describe commit change-set thoroughly
3. Must use proper capitalization, grammar, and punctuation
4. Must use blank lines to separate paragraphs

```
Subject line
More detailed explanatory text, if necessary. Wrap to 72 characters
or less. The blank line between the subject line and commit body is
critical (unless commit body is omitted).
Additional paragraphs can be added after another blank line. Bullet
points and other rich text can be included as well.
1. Example Change
2. Example Addition
3. Example Bug Fix
```

#### Pull Requests

All code committed to this project must follow the pull request procedure before it can be merged to the main or master branch. The pull request procedure ensures that all changes have been reviewed by a project maintainer, and tested to function properly.

In addition to any automated testing which may be performed for pull requests, all modified or newly-introduced code must be thoroughly tested prior to creating a pull request.

Once a pull request has been created, the following must be performed:

1. Designate pull request assignee
- Under most circumstances, the person creating the pull request shall be designated as the assignee. Should another person become responsible for the pull request, that person shall be designated as the assignee.
2. Add content labels
- Pull requests and other GitHub content can be labeled to document the type of content addressed. These labels can be found and assigned in the pull request sidebar.
3. Add linked issues
- If the pull request resolves or otherwise addresses an issue documented using GitHub Issues, the issue should be linked to the pull request. Linked issues can be found and assigned in the pull request sidebar.
4. Add pull request reviewers
- Pull requests must be reviewed by at least one, but preferably two, reviewers or code-owners. These reviewers should be chosen based on project familiarity, code language, and dependencies. In some scenarios, a code-owner may automatically be assigned to a pull request.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Ignition Ewon® Connector Module

## [Description](#table-of-contents)

Synchronize Ewon Flexy data to Ignition's Tag Historian using the Ignition Ewon® Connector Module.

## [Documentation](#table-of-contents)

Documentation for the Ignition Ewon Connector is available in a user-friendly format (via GitHub Pages) on the
[Ignition Ewon Connector Homepage](https://hms-networks.github.io/IgnitionEwonConnector/).
Loading

0 comments on commit 36406c0

Please sign in to comment.