Ortelius Community Guidelines

Become a Contributor, Open Issues, Participate

Ortelius Users

I’ve Got A Question

The Ortelius Community is happy to help!

Oretelius questions are best asked on the Ortelius Issues on GitHub List.

This is a list for answering questions and sharing tips and tricks for using Ortelius to support continuous delivery and continuous deployment.  Please be sure to share any relevant commands you ran, output, and detail, indicate the version of Ortelius you are using when asking a question.

Where needed, link to gists or GitHub repos to show examples, rather than sending attachments to the list. Before you post, be sure you are running the latest stable version.

I’d Like To Keep Up With Release Announcements

Release announcements are posted to the GitHub Project

I’d Like To Help Share and Promote Ortelius

You can help share Ortelius with others by telling friends and colleagues about the open source continuous delivery and continuous deployment project. Suggestions include writing a blog post or presenting at user groups (like DevOps groups, Jenkins Meetups or the local Software Development Groups.  On Twitter, you can also share things with #Ortelius and may wish to follow us.

I’d Like To Help Ortelius Move Faster

If you’re a developer working in the area of kubernetes and microservices, one of the most valuable things you can do is look at the GitHub issues list and help fix bugs. We almost always prioritize bug fixing over feature development, so clearing bugs out of the way is one of the best things you can do.

If you’re not a developer, helping test pull requests for bug fixes and features is still immensely valuable. You can do this by checking out Ortelius, making a test branch off the main one, merging a GitHub issue, testing, and then commenting on that particular issue on GitHub.

I’d Like To Report A Bug

Ortelius bugs should be reported to github.com/DeployHubProject/DeployHub/issues after signing up for a free GitHub account. Before reporting a bug, please use the bug/issue search to see if the issue has already been reported. This is listed on the bottom of the docs page for any module.

To be respectful of reviewers’ time and allow us to help everyone efficiently, please send us the steps to recreate the issue. This will make fixing the issue go much quicker. Do not use the issue tracker for “how do I do this” type questions.

I’d Like To Help With Documentation

Ortelius documentation is a community project too!

If you would like to help with the documentation, whether correcting a typo or improving a section, or maybe even documenting a new feature submit the changes via an issue in GitHub.

For Current and Prospective Developers:

I’d Like To Learn How To Develop on Ortelius

If you’re new to Ortelius and would like to figure out how to work on things, a great way to get started would be reading over some of the development documentation on the module site, and then finding a bug to fix or small feature to add.

Actions/Functions/Procedures are some of the easiest places to get started.

Contributing Code (Features or Bugfixes)

The Ortelius project keeps its source on GitHub at github.com/DeployHubProject/DeployHub.

The project takes contributions through github pull requests. It is usually a good idea to join the Ortelius list to discuss any large features prior to submission, and this especially helps in avoiding duplicate work or efforts where we decide, upon seeing a pull request for the first time, that revisions are needed.

Note: We do keep Ortelius to a particular aesthetic, so if you are unclear about whether a feature is a good fit or not, having the discussion on the development list is often a lot easier than having to modify a pull request later.

In order to keep the history clean and better audit incoming code, we will require re-submission of pull requests that contain merge commits. Use git pull –rebase (rather than git pull) and git rebase (rather than git merge). Also be sure to use topic branches to keep your additions on different branches, such that they won’t pick up stray commits later.

If you make a mistake you do not need to close your PR, create a clean branch locally and then push to GitHub with –force to overwrite the existing branch (permissible in this case as no one else should be using that branch as reference). Code comments won’t be lost, they just won’t be attached to the existing branch. We’ll then review your contributions and engage with you about questions and so on.

It may take awhile to get your contributions in! Be patient, your request might not get merged right away, we also try to keep the devel branch more or less usable so we like to examine Pull requests carefully, which takes time.

Patches should always be made against the devel branch.

Keep in mind that small and focused requests are easier to examine and accept, having example cases also help us understand the utility of a bug fix or a new feature.

Ortelius’s aesthetic encourages simple, readable code and consistent, conservatively extending, backwards-compatible improvements.

You can also contribute by testing and revising other requests, especially if it is one you are interested in using. Please keep your comments clear and to the point, courteous and constructive, tickets are not a good place to start discussions (Ortelius-project for this).

Other Topics:

Ortelius Staff

DeployHub Inc. is a company supporting Ortelius and building additional solutions based on Ortelius. We also provide services around designing a Kubernetes architecture using a Domain Driven Design for those that are interested.

Our most important task however is enabling all the great things that happen in the Ortelius community, including organizing software releases of Ortelius. For more information about any of these things, contact

Release Numbering

Releases ending in ”.0” are major releases and this is where all new features land. Releases ending in another integer, like “0.X.1” and “0.X.2” are dot releases, and these are only going to contain bugfixes.

Typically we don’t do dot releases for minor bugfixes (reserving these for larger items), but may occasionally decide to cut dot releases containing a large number of smaller fixes if it’s still a fairly long time before the next release comes out.

Community Code of Conduct

Every community can be strengthened by a diverse variety of viewpoints, insights, opinions, skillsets, and skill levels. However, with diversity comes the potential for disagreement and miscommunication. The purpose of this Code of Conduct is to ensure that disagreements and differences of opinion are conducted respectfully and on their own merits, without personal attacks or other behavior that might create an unsafe or unwelcoming environment. Topics around continuous delivery can be very diverse, everyone’s opinion is important.

These policies are not designed to be a comprehensive set of Things You Cannot Do. We ask that you treat your fellow community members with respect and courtesy, and in general, Don’t Be A Jerk. This Code of Conduct is meant to be followed in spirit as much as in letter and is not exhaustive.

All Ortelius events and participants therein are governed by this Code of Conduct and anti-harassment policy. We expect organizers to enforce these guidelines throughout all events, and we expect attendees, speakers, sponsors, and volunteers to help ensure a safe environment for our whole community. Specifically, this Code of Conduct covers participation in all Ortelius-related forums and mailing lists, code and documentation contributions, public IRC channels, private correspondence, and public meetings.

Ortelius community members are…


Contributions of every kind have far-ranging consequences. Just as your work depends on the work of others, decisions you make surrounding your contributions to the Ortelius community will affect your fellow community members. You are strongly encouraged to take those consequences into account while making decisions.


Asynchronous communication can come with its own frustrations, even in the most responsive of communities. Please remember that our community is largely built on volunteered time, and that questions, contributions, and requests for support may take some time to receive a response. Repeated “bumps” or “reminders” in rapid succession are not good displays of patience. Additionally, it is considered poor manners to ping a specific person with general questions. Pose your question to the community as a whole, and wait patiently for a response.


Every community inevitably has disagreements, but remember that it is possible to disagree respectfully and courteously. Disagreements are never an excuse for rudeness, hostility, threatening behavior, abuse (verbal or physical), or personal attacks.


Everyone should feel welcome in the Ortelius community, regardless of their background. Please be courteous, respectful and polite to fellow community members. Do not make or post offensive comments related to skill level, gender, gender identity or expression, sexual orientation, disability, physical appearance, body size, race, or religion. Sexualized images or imagery, real or implied violence, intimidation, oppression, stalking, sustained disruption of activities, publishing the personal information of others without explicit permission to do so, unwanted physical contact, and unwelcome sexual attention are all strictly prohibited. Additionally, you are encouraged not to make assumptions about the background or identity of your fellow community members.


The only stupid question is the one that does not get asked. We encourage our users to ask early and ask often. Rather than asking whether you can ask a question (the answer is always yes!), instead, simply ask your question. You are encouraged to provide as many specifics as possible. Code snippets in the form of Gists or other paste site links are almost always needed in order to get the most helpful answers. Refrain from pasting multiple lines of code directly into the IRC channels – instead use gist.github.com or another paste site to provide code snippets.


The Ortelius community is committed to being a welcoming environment for all users, regardless of skill level. We were all beginners once upon a time, and our community cannot grow without an environment where new users feel safe and comfortable asking questions. It can become frustrating to answer the same questions repeatedly; however, community members are expected to remain courteous and helpful to all users equally, regardless of skill or knowledge level. Avoid providing responses that prioritize snideness and snark over useful information. At the same time, everyone is expected to read the provided documentation thoroughly. We are happy to answer questions, provide strategic guidance, and suggest effective workflows, but we are not here to do your job for you.

Anti-harassment policy

Harassment includes (but is not limited to) all of the following behaviors:

  • Offensive comments related to gender (including gender expression and identity), age, sexual orientation, disability, physical appearance, body size, race, and religion
  • Derogatory terminology including words commonly known to be slurs
  • Posting sexualized images or imagery in public spaces
  • Deliberate intimidation
  • Stalking
  • Posting others’ personal information without explicit permission
  • Sustained disruption of talks or other events
  • Inappropriate physical contact
  • Unwelcome sexual attention

Participants asked to stop any harassing behavior are expected to comply immediately. Sponsors are also subject to the anti-harassment policy. In particular, sponsors should not use sexualized images, activities, or other material. Meetup organizing staff and other volunteer organizers should not use sexualized attire or otherwise create a sexualized environment at community events.

In addition to the behaviors outlined above, continuing to behave a certain way after you have been asked to stop also constitutes harassment, even if that behavior is not specifically outlined in this policy. It is considerate and respectful to stop doing something after you have been asked to stop, and all community members are expected to comply with such requests immediately.

Policy violations

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting , or to the local organizers of an event. Meetup organizers are encouraged to prominently display points of contact for reporting unacceptable behavior at local events.

If a participant engages in harassing behavior, the meetup organizers may take any action they deem appropriate. These actions may include but are not limited to warning the offender, expelling the offender from the event, and barring the offender from future community events.

Organizers will be happy to help participants contact security or local law enforcement, provide escorts to an alternate location, or otherwise assist those experiencing harassment to feel safe for the duration of the meetup. We value the safety and well-being of our community members and want everyone to feel welcome at our events, both online and offline.

We expect all participants, organizers, speakers, and attendees to follow these policies at our all of our event venues and event-related social events.

The Ortelius Community Code of Conduct is licensed under the Creative Commons Attribution-Share Alike 3.0 license. Our Code of Conduct was adapted from Codes of Conduct of other open source projects, including:

  • Contributor Covenant
  • Elastic
  • The Fedora Project
  • OpenStack
  • Ansible
  • Ubuntu