Skip to content

Commit

Permalink
[ci skip] Automated deployment to GitHub Pages on 1735776181
Browse files Browse the repository at this point in the history
  • Loading branch information
@apinnick
apinnick committed Jan 2, 2025
0 parents commit 7dc897d
Show file tree
Hide file tree
Showing 132 changed files with 13,893 additions and 0 deletions.
1 change: 1 addition & 0 deletions CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
tackle-docs.konveyor.io
128 changes: 128 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,128 @@
# Contributor Covenant 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, 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 at
konveyor.io.
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.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
194 changes: 194 additions & 0 deletions CONTRIBUTING/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,194 @@
<!DOCTYPE html>
<html lang="en-US">
<head>
<meta charset="UTF-8">

<!-- Begin Jekyll SEO tag v2.8.0 -->
<title>Installing and using Tackle | Tackle Documentation</title>
<meta name="generator" content="Jekyll v3.10.0" />
<meta property="og:title" content="Installing and using Tackle" />
<meta name="author" content="Tackle documentation team" />
<meta property="og:locale" content="en_US" />
<meta name="description" content="Tackle documentation" />
<meta property="og:description" content="Tackle documentation" />
<meta property="og:site_name" content="Tackle Documentation" />
<meta property="og:type" content="website" />
<meta name="twitter:card" content="summary" />
<meta property="twitter:title" content="Installing and using Tackle" />
<script type="application/ld+json">
{"@context":"https://schema.org","@type":"WebPage","author":{"@type":"Person","name":"Tackle documentation team"},"description":"Tackle documentation","headline":"Installing and using Tackle","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"/assets/img/konveyor-logo-tackle.svg"},"name":"Tackle documentation team"},"url":"/CONTRIBUTING/"}</script>
<!-- End Jekyll SEO tag -->

<meta name="viewport" content="width=device-width, initial-scale=1">
<meta name="theme-color" content="#157878">
<meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
<link rel="stylesheet" href="/assets/css/style.css?v=">
<link rel="shortcut icon" type="image/png" href="images/favicon.png">
</head>
<body>
<header class="page-header">

<a href="/"><img src="/assets/img/konveyor-logo-tackle.svg" alt="Tackle Documentation" width="200" /></a><br>


<a href="https://github.com/konveyor/tackle-documentation" class="btn">View on GitHub</a>


</header>

<main id="content" class="main-content" role="main">
<h1>Contributors Guide</h1>
<div id="preamble">
<div class="sectionbody">
<div class="paragraph">
<p>Improvements to Tackle documentation are welcome.</p>
</div>
<div class="paragraph">
<p>Read the [Guidelines for Red Hat Documentation](<a href="https://redhat-documentation.github.io/" class="bare">https://redhat-documentation.github.io/</a>) before opening a pull request.</p>
</div>
<div class="paragraph">
<p>Use the following steps to create a pull request for the Tackle documentation repository.</p>
</div>
<div class="olist arabic">
<ol class="arabic">
<li>
<p>Fork the <a href="https://github.com/konveyor/tackle-documentation">tackle-documentation</a> GitHub repository.</p>
<div class="paragraph">
<p>Click the <strong>Fork</strong> button in the top right corner of the page.</p>
</div>
</li>
<li>
<p>Clone the forked repository locally.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git clone git@github.com:YOUR_USERNAME/tackle-documentation.git</code></pre>
</div>
</div>
</li>
<li>
<p>Add the upstream repository.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>git remote add -f upstream git@github.com:tackle-documentation.git</code></pre>
</div>
</div>
</li>
<li>
<p>Get the latest changes.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git fetch upstream</code></pre>
</div>
</div>
</li>
<li>
<p>Check out a topic branch.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git checkout -b BRANCH_NAME upstream/main</code></pre>
</div>
</div>
</li>
<li>
<p>Make the desired edits.</p>
<div class="paragraph">
<p>The documentation is written in <a href="http://asciidoc.org/">AsciiDoc</a>. Review the <a href="#asciidoc_guidelines">AsciiDoc Guidelines and Tips</a> section of this guide before making changes.</p>
</div>
</li>
<li>
<p>Build the guides to verify your changes.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Navigate to the appropriate guide&#8217;s directory and issue the following command. Note that you must have <a href="http://asciidoctor.org/">Asciidoctor</a> installed.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ cd documentation/&lt;document&gt;
$ asciidoctor -t -dbook -a toc -o html master.adoc</code></pre>
</div>
</div>
</li>
<li>
<p>View the generated HTML file in a browser.</p>
</li>
</ol>
</div>
</li>
<li>
<p>Add each new or updated file to git.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git add FILE_NAME.adoc</code></pre>
</div>
</div>
</li>
<li>
<p>Commit the changes locally.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git commit -m "My commit message."</code></pre>
</div>
</div>
</li>
<li>
<p>Push the changes to your forked repository.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ git push origin HEAD</code></pre>
</div>
</div>
</li>
<li>
<p>Open a pull request to merge your changes to the master branch.</p>
<div class="olist loweralpha">
<ol class="loweralpha" type="a">
<li>
<p>Navigate to your forked repository in a browser: <a href="https://github.com/YOUR_USERNAME/konveyor/tackle-documentation" class="bare">https://github.com/YOUR_USERNAME/konveyor/tackle-documentation</a>.</p>
</li>
<li>
<p>Open a new pull request. Be sure to review the diff before submitting.</p>
</li>
<li>
<p>A member of the Tackle documentation team will merge or provide feedback on your request.</p>
</li>
</ol>
</div>
</li>
</ol>
</div>
</div>
</div>
<div class="sect1">
<h2 id="building-the-guides">Building the Guides</h2>
<div class="sectionbody">
<div class="paragraph">
<p>Navigate to the appropriate guide&#8217;s directory and issue the following command. Note that you must have <a href="http://asciidoctor.org/">Asciidoctor</a> installed.</p>
</div>
<div class="listingblock">
<div class="content">
<pre class="highlight nowrap"><code>$ cd documentation/&lt;document&gt;
$ asciidoctor -t -dbook -a toc -o html master.adoc</code></pre>
</div>
</div>
<div class="paragraph">
<p>View the generated HTML file in a browser.</p>
</div>
</div>
</div>
<div class="sect1">
<h2 id="publishing-the-guides">Publishing the Guides</h2>
<div class="sectionbody">
<div class="paragraph">
<p>The Tackle guides are published downstream on the <a href="https://access.redhat.com/documentation/en/migration_toolkit_for_applications/">Red Hat Customer Portal</a>.</p>
</div>
</div>
</div>

<footer class="site-footer">

<span class="site-footer-owner"><a href="https://github.com/konveyor/tackle-documentation">tackle-documentation</a> is maintained by <a href="https://github.com/konveyor">konveyor</a>.</span>

</footer>
</main>
</body>
</html>
31 changes: 31 additions & 0 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# frozen_string_literal: true
# Encoding.default_external = Encoding::UTF_8
# Encoding.default_internal = Encoding::UTF_8

source "https://rubygems.org"

# gem "asciidoctor-pdf"
gem "asciidoctor"
# gem "bundle"
# gem "html-proofer"
gem "jekyll-theme-minimal"
# gem "jekyll-feed"
gem "jekyll-paginate"
# gem "jekyll-redirect-from"
# gem "jekyll-sitemap"
# gem "jekyll-tagging"
# gem 'jekyll-seo-tag'
# gem "jekyll", ">= 3.5"
# gem "premonition", ">= 4.0.0"
# gem "pygments.rb"
# gem "rake"
#
#
gem "github-pages", group: :jekyll_plugins

# ensures that jekyll-asciidoc is loaded first
group :jekyll_plugins do
gem 'jekyll-asciidoc'
end

gemspec
Loading

0 comments on commit 7dc897d

Please sign in to comment.