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 2, 2022

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

Problem Statement

  • Codacy warnings in below given files:
    • [fenced-code-flag]
      • doc/motr-kv-app.md
      • doc/Motr-Epochs-HLD.md
      • doc/HLD-OF-Motr-LNet-Transport.md
      • doc/motr-object-app.md
      • doc/FOPFOM-Programming-Guide.md
      • doc/Motr-Lnet-Transport.md
      • doc/HLD-of-Motr-Caching.md
      • doc/Motr-Epochs-HLD.md
      • doc/Motr-Lnet-Transport.md
      • doc/motr-in-prose.md
    • [ordered-list-marker-value]
      • doc/Seagate-FDMI-Design-Notes.md
      • doc/Seagate-FDMI-HLD.md
    • [heading-style] Headings should use atx or atx-closed
      • doc/FDMI-High-Level-Decomposition.md
      • doc/HLD-Meta-Data-Back-End.md
      • doc/HLD-of-Metadata-Backend.md
      • doc/Castor-Management.md
      • doc/HLD-Version-Numbers.md
      • doc/HLD-fop-object-Iterator.md
      • doc/HLD-of-Auxillary-Databases.md
      • doc/HLD-of-FDMI.md
      • doc/HLD-of-Motr-Caching.md
      • doc/HLD-of-Motr-HA-nterface.md
      • doc/Seagate-FDMI-HLD.md
    • [no-heading-content-indent]
      • doc/HLD-Meta-Data-Back-End.md
      • doc/HLD-of-Metadata-Backend.md
      • doc/HLD-of-Motr-Caching.md
      • doc/HLD-of-Motr-HA-nterface.md
    • [emphasis-marker]
      • doc/coding-style.md
    • [no-duplicate-headings]
      • doc/motr-in-prose.md

Design

  • [fenced-code-flag] -> added name of programming language after 3 backquotes ```
  • [ordered-list-marker-value] -> marker changed to correct numeric
  • [heading-style] -> used atx or atx-closed formatting for headings
  • [no-heading-content-indent] -> removed 1 space after this heading’s content
  • [emphasis-marker] -> added * before and after the word to be emphasised
  • [no-duplicate-headings] -> Replaced similar heading content

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/FDMI-High-Level-Decomposition.md
View rendered doc/FOPFOM-Programming-Guide.md
View rendered doc/Running_Motr_Across_a_Cluster.md

@cortx-admin
Copy link

Can one of the admins verify this patch?

@RohanDhodare RohanDhodare force-pushed the CORTX-33702-New branch 2 times, most recently from cbae600 to 5d482d3 Compare August 3, 2022 11:29
spacing between a list item’s bullet and its content violates

Signed-off-by: Rohan Dhodare <[email protected]>
@RohanDhodare RohanDhodare force-pushed the CORTX-33702-New branch 2 times, most recently from 2a3b02a to 3d86c3e Compare August 5, 2022 06:43
@hessio hessio added codacy Status: Waiting to be Reviewed PR is waiting for reviewers to review the PR labels Aug 9, 2022
@rkothiya
Copy link
Contributor

Giving exception for pre-merge and ci/cd as its documentation change.

@rkothiya rkothiya merged commit c7552ac into Seagate:main Aug 10, 2022
@rkothiya rkothiya added the Exception Allowed to merge without runing ut and st label Aug 10, 2022
kiwionly2 pushed a commit to kiwionly2/cortx-motr that referenced this pull request Aug 30, 2022
Warnings fixed : 
[fenced-code-flag] -> added name of programming language after 3 backquotes ```
[ordered-list-marker-value] -> marker changed to correct numeric
[heading-style] -> used atx or atx-closed formatting for headings
[no-heading-content-indent] -> removed 1 space after this heading’s content
[emphasis-marker] -> added * before and after the word to be emphasized
[no-duplicate-headings] -> Replaced similar heading content

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 codacy Exception Allowed to merge without runing ut and st Status: Waiting to be Reviewed PR is waiting for reviewers to review the PR

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants