code of conduct, contributing, and PR template

.github/PULL_REQUEST_TEMPALTE.md

@@ -0,0 +1,31 @@
+#### What is this PR About?
+
+Brief explanation of the guide or document changes you have made and/or
+the new content you are contributing.
+
+#### How should we test or review this PR?
+
+Include any information or commands (please use code blocks) to help
+reviewers understand and verify your contribution.
+
+#### Is there a relevant Trello card or Github issue open for this?
+
+Provide a link to any open Github issues or Trello cards that describe
+the use case or problem you are solving.
+
+#### Who would you like to review this?
+
+cc: @rht-labs/OpenInnovationLabs
+
+'''''
+
+* [ ] Have you followed the
+[contributing
+guidelines?](https://github.com/rht-labs/labs-ci-cd/blob/master/CONTRIBUTING.adoc)
+* [ ] Have you explained what your changes do, and why they add value to
+Labs CI / CD?
+
+'''''
+
+*Please note: we may close your PR without comment if you do not check
+the boxes above and provide ALL requested information.*

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our
+project and our community a harassment-free experience for everyone,
+regardless of age, body size, disability, ethnicity, gender identity and
+expression, level of experience, nationality, personal appearance, race,
+religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual
+attention or advances
+* Trolling, insulting/derogatory comments, and personal or political
+attacks
+* Public or private harassment
+* Publishing others’ private information, such as a physical or
+electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of
+acceptable behavior and are expected to take appropriate and fair
+corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban
+temporarily or permanently any contributor for other behaviors that they
+deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public
+spaces when an individual is representing the project or its community.
+Examples of representing a project or community include using an
+official project e-mail address, posting via an official social media
+account, or acting as an appointed representative at an online or
+offline event. Representation of a project may be further defined and
+clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported by contacting the project team at [email protected].
+All complaints will be reviewed and investigated and will result in a
+response that is deemed necessary and appropriate to the circumstances.
+The project team is obligated to maintain confidentiality with regard to
+the reporter of an incident. Further details of specific enforcement
+policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in
+good faith may face temporary or permanent repercussions as determined
+by other members of the project’s leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the
+https://www.contributor-covenant.org[Contributor Covenant], version 1.4,
+available at
+https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

CONTRIBUTING.adoc

@@ -0,0 +1,96 @@
+= Contributing to Labs CI / CD 
+:toc:
+:toc-title:
+:toc-placement!:
+
+Thanks for checking out the Labs CI / CD guides! We’re excited to hear
+and learn from you. Your experiences will benefit others who read and
+use these guides.
+
+We’ve put together the following guidelines to help you figure out where
+you can best be helpful.
+
+toc::[]
+
+== Types of contributions we’re looking for
+
+This project is used as a starting point for CI/CD tooling by the 
+Red Hat Open Innovation Labs group. It incoporates many technologies
+and is intended for development on OpenShift Container Platform.
+
+Interested in making a contribution? Read on!
+
+== Ground rules & expectations
+
+Before we get started, here are a few things we expect from you (and
+that you should expect from others):
+
+* Be kind and thoughtful in your conversations around this project. We
+all come from different backgrounds and projects, which means we likely
+have different perspectives on "how open source is done". Try to
+listen to others rather than convince them that your way is correct.
+* There is a
+link:./CODE_OF_CONDUCT.adoc[Contributor Code of Conduct]. By participating
+in this project, you agree to abide by its terms.
+* If you open a pull request, please ensure that your contribution
+passes all tests. If there are test failures, you will need to address
+them before we can merge your contribution.
+* When adding content, please consider if it is widely valuable. Please
+don’t add references or links to things you or your employer have
+created as others will do so if they appreciate it.
+
+== Getting set up for local development
+
+Local Development guide is still under construction...
+
+=== Deploying to OpenShift 
+
+The Labs CI / CD stack can be deployed to any OpenShift cluster, and is automated using link:https://github.com/redhat-cop/openshift-applier[OpenShift Applier]. The following commands can be used to install Applier, log in to your OpenShift cluster, and deploy the pipeline.
+
+[source,bash]
+----
+ansible-galaxy install -r requirements.yml -p galaxy
+oc login ...
+ansible-playbook -i .applier/ galaxy/openshift-applier/playbooks/openshift-cluster-seed.yml
+----
+
+This will result in the creation of a pipeline and deployment environments across several projects:
+
+* `labs-ci-cd` is where Jenkins, and other tools will be deployed to.
+* `labs-dev` will be used as the Development environment, where smoke tests can be run.
+* `labs-test` is a promotion environment
+
+If you need to customize the deployment (e.g. for testing a Pull Request), the Applier inventory supports a number of parameters to customize the deployment. The following command is an example of configuring the pipeline to build from an alternative fork and branch. For other possible parameters, see link:.applier/group_vars/all.yml[all.yml].
+
+== Contributing Content
+
+If you’d like to contribute, start by searching through the GitHub
+https://github.com/rht-labs/labs-ci-cd/issues[issues] and
+https://github.com/rht-labs/labs-ci-cd/pulls[pull requests] to see
+whether someone else has raised a similar idea or question.
+
+If you don’t see your idea listed, and you think it fits into the goals
+of this guide, do one of the following: * *If your contribution is
+minor,* such as a typo fix, open a pull request. * *If your contribution
+is major,* such as a new article or category, start by opening an issue
+first. That way, other people can weigh in on the discussion before you
+do any work.
+
+== Contribution review process
+
+This repo is currently maintained by @springdo, @pcarney8, and
+@oybed, who have commit access. They will likely review your
+contribution. If you haven’t heard from anyone in 10 days, feel free to
+bump the thread or @-mention a maintainer or
+`@rht-labs/OpenInnovationLabs` to review your contribution.
+
+== Community
+
+Discussions about Labs CI / CD  takes place within this repository’s
+https://github.com/rht-labs/labs-ci-cd/issues[Issues] and
+https://github.com/rht-labs/labs-ci-cd/pulls[Pull Requests]
+sections.
+
+Wherever possible, do not take these conversations to private channels,
+including contacting the maintainers directly. Keeping communication
+public means everybody can benefit and learn from the conversation.