Skip to content

Migrate and improve documentation from old Jenkins Wiki#61

Merged
vgaidarji merged 9 commits into
masterfrom
improve-documentation
Mar 27, 2020
Merged

Migrate and improve documentation from old Jenkins Wiki#61
vgaidarji merged 9 commits into
masterfrom
improve-documentation

Conversation

@vgaidarji

@vgaidarji vgaidarji commented Mar 27, 2020 •
edited
Loading

Copy link
Copy Markdown
Contributor

What has been done

  1. Migrated plugin documentation from old Wiki to GitHub. Read more at Plugin Documentation-as-Code: Moving docs to GitHub.
  2. Added plugin badges to README using shields.io
  1. Mentioned importance of having proper labels in PRs in PR template

How to test

  1. Make sure content from old Wiki page is fully migrated to README
  2. Perform proof-reading of the README to spot any mistakes
  3. Make sure shields.io badges are showing correct data and lead to correct pages when clicked

Checklist

  • Git commits follow best practices
  • Build passes in Jenkins
  • Appropriate tests or explanation to why this change has no tests
  • Pull Request is marked with appropriate label (see .github/release-drafter.yml)
  • JIRA issue is well described (problem explanation, steps to reproduce, screenshots)
  • For dependency updates: links to external changelogs and, if possible, full diffs

@vgaidarji vgaidarji self-assigned this Mar 27, 2020
@vgaidarji vgaidarji added the documentation Documentation updates label Mar 27, 2020
@codecov

codecov Bot commented Mar 27, 2020 •
edited
Loading

Copy link
Copy Markdown

Codecov Report

Merging #61 into master will not change coverage by %.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff            @@
##             master      #61   +/-   ##
=========================================
  Coverage     43.38%   43.38%           
  Complexity      190      190           
=========================================
  Files            18       18           
  Lines          1263     1263           
  Branches        192      192           
=========================================
  Hits            548      548           
  Misses          651      651           
  Partials         64       64

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ee8ed18...f27a767. Read the comment docs.

@vgaidarji
Mention release drafter labels in PR template checklist
f27a767 
It's important to set proper labels for PRs so that later on
when new release will be prepared, release drafter plugin could generate
concise release notes.
@vgaidarji
vgaidarji force-pushed the improve-documentation branch from 167b4d2 to f27a767 Compare March 27, 2020 11:12
@vgaidarji vgaidarji changed the title Migrate and documentation from old Jenkins Wiki Migrate and improve documentation from old Jenkins Wiki Mar 27, 2020
@vgaidarji
vgaidarji merged commit 26bfde6 into master Mar 27, 2020
@vgaidarji
vgaidarji deleted the improve-documentation branch March 27, 2020 11:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

@vgaidarji vgaidarji

Labels

documentation Documentation updates

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@vgaidarji @zbynek @oleg-nenashev