v2
What's New in ioFog 2?Core ConceptsArchitectureQuick Start With Local DeploymentQuick Start On Minikube and Vagrant
iofogctl - ioFog Unified Command Line InterfaceDownload And Install iofogctlGetting Familiar With iofogctliofogctl Resource ManagementConnecting To Existing Edge Compute NetworksLegacy Commands in iofogctl
IntroductionPrepare NetworkPrepare Remote HostsRemote - Deploy Control PlaneKubernetes - Prepare A ClusterKubernetes - Deploy Control Plane Using iofogctlKubernetes - Deploy Control Plane Using HelmSetup Agents
IntroductionAgent ConfigurationAttach / Detach an AgentVolume ManagementDocker Image Pruning
Writing MicroservicesioFog SDKDebugging
IntroductionGet To Know ioFogManage Our MicroservicesCreate Our First Microservice - JavaScriptDeploy Our Microservice
Distributed ApplicationsMicroservice Public PortsMove and Rename MicroservicesMicroservice Updates and LifecycleMicroservice Registry and Catalog ManagementMicroservice Logs
Kinds of ResourcesControl Plane YAML SpecificationAgent configuration YAML SpecificationApplication YAML SpecificationRoute YAML SpecificationCatalog Item YAML SpecificationRegistry YAML Specification
OverviewLegacy Controller CLI UsageController REST API Reference
OverviewLegacy Agent CLI UsageAgent Local API ReferenceAgent ConfigurationsRemote debugging using IntelliJ
System: Diagnostics MicroserviceSystem: Hardware Abstraction Layer MicroserviceSystem: Bluetooth REST API MicroserviceJSON REST API And Open Weather Map Microservices
Contributing GuidelinesCode of Conduct

Contributing Guidelines

We are open to, and grateful for, any contributions made by the community.

By contributing to ioFog, you agree to abide by our Code of Conduct.

Bugs and Improvements

Before opening an issue, please search the issue tracker to make sure your issue hasn’t already been reported.

We use different issue trackers for individual pieces of the ioFog community.

Getting Help

Need some help? Check out the Community page for resources like our discussion forums and meetups.

Sending a Pull Request

For non-trivial changes, we suggest you open an issue with a proposal for a new feature or refactoring before starting on the work. That way you can get better insight into whether or not your hard work is likely to be accepted.

On the other hand, sometimes the best way to start a conversation is to send a pull request. Use your best judgment!

In general, the contribution workflow looks like this:

  • Open a new issue in the issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the develop branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request is focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we’ll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!

Docs

You can find the source code for iofog.org (this site) here: https://github.com/ioFog/iofog.org

Improvements to the documentation are always welcome. Currently it is powered by Gatsby, which is a static site builder that uses React.