Add documentation #44
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com>
hickey
added a commit
that referenced
this pull request
Mar 1, 2024
* fix: fix missing tab for file sharing * Initial pass at reorganization Reorginanization of the repository so that it is code focused vs. being focused on how the packages are built. Packaging will be moved to GitHub Actions so that every commit will create new packages that can be used for testing. Releases will be created and produce packages when a tag is committed to the repository. Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Added beginnings of package building code Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Now making directories during package build Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Minor fixes to populate-meshchat-api-fs.sh Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Fixed testing tag for version number Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Updated GitHub workflow Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Fixed incorrect param order for tar in ipk-build.sh Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Storing generated package as an artifact Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Refactored build API workflow Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Added build MeshChat package job Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Removed build file as no longer needed * Updating version info in meshchatconfig.lua Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * More reorganization of files * Fixed installation of cgi-bin after reorg Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Fixed the installation of web files Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Added branch name and commit ref to testing builds Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Moved MeshChat source to top level Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: Set send channel when channel filter changed Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * docs: Updated README with history of MeshChat Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * chore: Added Bug Report issue template * chore: Added feature request issue template * build: Updates to better name packages Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * Update Bug Report.yml * fix: set epoch in send_message API even if not specified Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: add message class abstracting message handling (#23) * refactor: add comments to clarify flow Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: add messages class to front end Update the handling of messages on the front end code to better control the update of messages and coordinateion with the rest of the UI. Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * add more config support Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: message ID can be specified in send_message API Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * add md5 module to front-end Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * integrate message class into front-end code Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> --------- Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * add more fields to bug issue template Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * chore: remove packages from repo Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * chore: add release-it config file for automated releases Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * fix: discover zone name from /etc/config.mesh (#36) The zone name has traditionally been discovered by interogating /etc/config/services. The AREDN firmware is removing this file in favor of /etc/config.mesh/_setup.services.{dmz|nat}. This fix updates the location where the zone name is discovered. Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> Co-authored-by: Tim Wilkinson <tim.j.wilkinson@gmail.com> * Add GitHub Actions workflow to automate releases (#40) * Added beginnings of package building code * chore: create release CI job * chore: add documentation section to changelog * chore: make build-meshchat-package a reusable workflow * chore: add build packages to release * fix: update-version.sh can now be told version to set * chore(ci): convert meshchat-api build to reusable workflow * chore(ci): set release to only work on release branch Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: Add documentation (#44) * add API docs as comments * add luadox configuation * add parameter table to API calls * create documentation to be published * add github pages artifact code * remove unused README * make publish-docs workflow reusable for releases * add troubleshooting documentation --------- Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * chore(ci): update release pipeline Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * feat: allow admin to set default channel (#19) A MeshChat administrator now has the ability to define the default channel that a newly logged in user is placed into. This requires that the administrator set the value `default_channel` in the configuration file. Setting `default_channel` to an empty string ('') will continue using the legacy setting of 'Everything'. Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> * add LICENSE file Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> --------- Signed-off-by: Gerard Hickey <hickey@kinetic-compute.com> Co-authored-by: Tim Wilkinson <tim.j.wilkinson@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is the beginning of adding documentation to the MeshChat project. The plan is that with every release of MeshChat, the current documentation will be generated and published.