Skip to content
This repository was archived by the owner on May 3, 2024. It is now read-only.

Conversation

@RohanDhodare
Copy link
Contributor

@RohanDhodare RohanDhodare commented Aug 16, 2022

Signed-off-by: Rohan Dhodare [email protected]

Problem Statement

  • Codacy warnings in below given files:
    • [fenced-code-flag]

      • doc/FOPFOM-Programming-Guide.md
      • doc/HLD-OF-Motr-LNet-Transport.md
      • doc/HLD-of-Catalogue-Service.md
      • doc/Motr-Epochs-HLD.md
      • doc/Motr-Lnet-Transport.md
      • doc/motr-kv-app.md
      • doc/motr-object-app.md
    • [emphasis-marker]

      • scripts/provisioning/README.md
    • [code-block-style]

      • doc/Running_Motr_Across_a_Cluster.md
      • scripts/provisioning/README.md
    • [heading-style]

      • doc/Seagate-FDMI-HLD.md

Design

  • [fenced-code-flag] -> added name of programming language after 3 backquotes ```
  • [emphasis-marker] -> added * before and after the word to be emphasised
  • [code-block-style] -> added 3 backquote ```
  • [heading-style] -> used atx-closed formatting for headings

Coding

Checklist for Author

  • Coding conventions are followed and code is consistent

Testing

Checklist for Author

  • Unit and System Tests are added
  • Test Cases cover Happy Path, Non-Happy Path and Scalability
  • Testing was performed with RPM

Impact Analysis

Checklist for Author/Reviewer/GateKeeper

  • Interface change (if any) are documented
  • Side effects on other features (deployment/upgrade)
  • Dependencies on other component(s)

Review Checklist

Checklist for Author

  • JIRA number/GitHub Issue added to PR
  • PR is self reviewed
  • Jira and state/status is updated and JIRA is updated with PR link
  • Check if the description is clear and explained

Documentation

Checklist for Author

  • Changes done to WIKI / Confluence page / Quick Start Guide

View rendered doc/FOPFOM-Programming-Guide.md
View rendered doc/HLD-OF-Motr-LNet-Transport.md
View rendered doc/HLD-of-Catalogue-Service.md
View rendered doc/Motr-Epochs-HLD.md
View rendered doc/Motr-Lnet-Transport.md
View rendered doc/Running_Motr_Across_a_Cluster.md
View rendered doc/Seagate-FDMI-HLD.md
View rendered doc/motr-kv-app.md
View rendered doc/motr-object-app.md
View rendered scripts/provisioning/README.md

@rkothiya
Copy link
Contributor

Can one of the admins verify this patch?

@RohanDhodare RohanDhodare force-pushed the CORTX-33702 branch 6 times, most recently from 9890b26 to eb50942 Compare August 16, 2022 08:21
@prasanna46dk
Copy link
Contributor

LGTM

@RohanDhodare RohanDhodare force-pushed the CORTX-33702 branch 3 times, most recently from 2ff3ef0 to b48e0b9 Compare August 17, 2022 11:17
@rkothiya
Copy link
Contributor

Giving exception to pre-merge and ci/cd as documentation changes

@rkothiya rkothiya merged commit de245d3 into Seagate:main Aug 17, 2022
@rkothiya rkothiya added the Exception Allowed to merge without runing ut and st label Aug 17, 2022
kiwionly2 pushed a commit to kiwionly2/cortx-motr that referenced this pull request Aug 30, 2022
Following warnings were fixed: 
[fenced-code-flag] -> added name of programming language after 3 backquotes ```
[emphasis-marker] -> added * before and after the word to be emphasised
[code-block-style] -> added 3 backquote ```
[heading-style] -> used atx-closed formatting for headings

Signed-off-by: Rohan Dhodare <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed Exception Allowed to merge without runing ut and st

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants