fix(#153): Fixed all markdown lint issues. (#154)

* docs(README): Fixed lint errors in README and removed unnecessary link to itself. * fix(#153): Fixed lint issues across GitHub issue templates and PR template. * fix(#153): Fixed lint issues in CODE_OF_CONDUCT.md document. * fix(#153): Fixed lint issues across all cli markdown documents. * fix(#153): Fixed lint issues across markdown documents within all packages. * Update .github/ISSUE_TEMPLATE/question.md Co-Authored-By: Mayur Deshmukh <[email protected]> * Update .github/PULL_REQUEST_TEMPLATE.md Co-Authored-By: Mayur Deshmukh <[email protected]> * Update cli/generator-op-microservice/README.md Co-Authored-By: Mayur Deshmukh <[email protected]> * Update packages/home-spa/README.md Co-Authored-By: Mayur Deshmukh <[email protected]> Co-authored-by: Mayur Deshmukh <[email protected]>
1-Platform · Apr 15, 2020 · e0e10f9 · e0e10f9
1 parent 350cc85
commit e0e10f9
Show file tree

Hide file tree

Showing 15 changed files with 197 additions and 173 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,11 +1,10 @@
 ---
 name: "Bug report \U0001F41E"
 about: Report something that doesn't work
-title: ''
+title: ""
 labels: bug
-assignees: ''
+assignees: ""
 projects: 1-Platform/1
-
 ---
 
 <!--
@@ -14,10 +13,12 @@ A Bug is a superset of regressions, but it doesn't have to have worked on One Pl
 Before opening a new issue, please search existing issues https://github.com/1-Platform/one-platform/issues
 -->
 
-## Describe the bug:
+## Describe the bug
+
 <!-- A clear and concise description of what the bug is. -->
 
-## Steps to reproduce:
+## Steps to reproduce
+
 <!--
 1. Do '...'
 2. Click on '....'
@@ -26,19 +27,21 @@ Before opening a new issue, please search existing issues https://github.com/1-P
 For the fastest support, provide a working demo or minimal reproduction using tools such as [codepen](https://codepen.io/) or [jsfiddle](https://jsfiddle.net/)
 -->
 
-## Expected behavior:
+## Expected behavior
+
 <!-- A clear and concise description of what you expected to happen. -->
 
-## Screenshots:
-<!-- If applicable, add screenshots to help explain your problem. -->
+## Screenshots
 
+<!-- If applicable, add screenshots to help explain your problem. -->
 
-## Environment;
+## Environment
 
 - Operating System(s): Linux/macOS/Windows [Variant and Version]
 - Browser: Firefox/Chrome/Safari [Version] / Other (please specify)
 
-## Tell us more about your product/project and timeline to help prioritize this issue:
+## Tell us more about your product/project and timeline to help prioritize this issue
+
 <!--
 * What product/project does this impact?
 * List product/project release(s) and timelines.

diff --git a/.github/ISSUE_TEMPLATE/chore.md b/.github/ISSUE_TEMPLATE/chore.md
@@ -1,22 +1,25 @@
 ---
 name: "Chore \U0001F527"
 about: Internal things, technical debt, and to-do tasks to be performed.
-title: ''
+title: ""
 labels: chore
-assignees: ''
-
+assignees: ""
 ---
 
 <!-- Separate suggestions for updates to configuration or build processes and libraries / Internal things, technical debt, and to-do tasks to be performed should be reported in separate issues.-->
 
-## Is your chore related to a problem? Please describe:
+## Is your chore related to a problem? Please describe
+
 <!-- A clear and concise description of what the problem is.-->
 
-## Describe the solution you'd like:
+## Describe the solution you'd like
+
 <!-- A clear and concise description of what you want to happen. -->
 
-## Describe alternatives you've considered:
+## Describe alternatives you've considered
+
 <!--A clear and concise description of any alternative solutions or features you've considered. -->
 
-## Additional context:
+## Additional context
+
 <!-- Add any other context or screenshots about the task here. -->
diff --git a/.github/ISSUE_TEMPLATE/documentation_proposal.md b/.github/ISSUE_TEMPLATE/documentation_proposal.md
@@ -1,29 +1,32 @@
 ---
 name: "Documentation proposal \U0001F4D6"
 about: Propose documentation improvements / additions
-title: ''
+title: ""
 labels: documentation
-assignees: ''
+assignees: ""
 projects: 1-Platform/1
-
 ---
 
 <!--For any improvements or additions to existing documentation please be as precise and concise as possible:-->
 
-## Is your suggestion related to code documentation or product documentation problem:
+## Is your suggestion related to code documentation or product documentation problem
+
 <!--
 * Code / Product: [e.g. Code, Product]
 * File / Document Name: [e.g. README.md, package.json]
 -->
 
-## Describe your suggestion:
+## Describe your suggestion
+
 <!-- A clear and concise description of what changes you are proposing. In the case of multiple documents, please create separate issues.  -->
 
-## Describe any reference material that might be helpful:
+## Describe any reference material that might be helpful
+
 <!--
 1. Name and description of reference material.
 2. Name and description of reference material.
 -->
 
-## Additional context:
+## Additional context
+
 <!-- Add any other context or screenshots about the proposal here. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,21 +1,24 @@
 ---
 name: "Feature request \U0001F4A1"
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
+assignees: ""
 projects: 1-Platform/1
-
 ---
 
-## Is your feature request related to a problem? Please describe:
+## Is your feature request related to a problem? Please describe
+
 <!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
-## Describe the solution you'd like:
- <!-- A clear and concise description of what you want to happen. --> 
+## Describe the solution you'd like
+
+ <!-- A clear and concise description of what you want to happen. -->
+
+## Describe alternatives you've considered
+
+ <!--A clear and concise description of any alternative solutions or features you've considered. -->
 
-## Describe alternatives you've considered:
- <!--A clear and concise description of any alternative solutions or features you've considered. --> 
+## Additional context
 
-## Additional context:
  <!-- Add any other context or screenshots about the enhancement here. -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -1,20 +1,21 @@
 ---
 name: "Question \U0001F914"
 about: Usage question or discussion about anything related to the platform
-title: ''
+title: ""
 labels: question
-assignees: ''
-
+assignees: ""
 ---
 
 <!--
   To make it easier for us to help you, please include as much useful information as possible.
-  
+
   Before opening a new issue, please search existing issues https://github.com/1-Platform/one-platform/issues
 -->
 
-## Summary:
+## Summary
+
+<!-- Provide a short summary -->
 
-## Relevant information:
+## Relevant information
 
 <!-- Provide as much useful information as you can -->
diff --git a/.github/ISSUE_TEMPLATE/regression_report.md b/.github/ISSUE_TEMPLATE/regression_report.md
@@ -1,22 +1,24 @@
 ---
 name: "Regression report \U0001F570"
 about: Tell us about something that worked at one point and now doesn't
-title: ''
+title: ""
 labels: regression
-assignees: ''
+assignees: ""
 projects: 1-Platform/1
-
 ---
 
 <!--For regression reports, please provide as much relevant info as possible.-->
 
-## Potential Commit/PR that introduced the regression:
+## Potential Commit/PR that introduced the regression
+
 <!-- If you have time to investigate, what PR/date introduced this issue. -->
 
-## Describe the regression:
+## Describe the regression
+
 <!-- A clear and concise description of what the regression is. -->
 
-## Steps to reproduce:
+## Steps to reproduce
+
 <!--
 1. Do '...'
 2. Click on '....'
@@ -25,18 +27,21 @@ projects: 1-Platform/1
 For the fastest support, provide a working demo or minimal reproduction using tools such as [codepen](https://codepen.io/) or [jsfiddle](https://jsfiddle.net/)
 -->
 
-## Expected behavior:
+## Expected behavior
+
 <!-- A clear and concise description of what you expected to happen. -->
 
-## Screenshots:
+## Screenshots
+
 <!-- If applicable, add screenshots to help explain your problem. -->
 
-## Environment;
+## Environment
 
 - Operating System(s): Linux/macOS/Windows [Variant and Version]
 - Browser: Firefox/Chrome/Safari [Version] / Other (please specify)
 
-## Tell us more about your product/project and timeline to help prioritize this issue:
+## Tell us more about your product/project and timeline to help prioritize this issue
+
 <!--
 * What product/project does this impact?
 * List product/project release(s) and timelines.

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -6,34 +6,31 @@ Assignees: "One Platform Developers"
 Projects: "One Platform Development"
 -->
 
+# Closes/Fixes/Resolves
 
-> ### Closes/Fixes/Resolves #issue_id
+### <!-- Any of the keywords: Closes/Fixes/Resolves followed by #issue_id (should be separated by a space only) -->
 
-## Explain the feature/fix:
+# Explain the feature/fix
 
 <!-- Provide a clear explaination of the feature/fix implemented -->
 
+## Does this PR introduce a breaking change
 
-
-## Does this PR introduce a breaking change?
-
-> Yes/No
+<!-- Yes/No -->
 
 <!-- If this PR contains a breaking change, please describe the impact and migration path for existing applications below. -->
 
+## Screenshots
 
-## Screenshots:
 <!-- If applicable, add screenshots to help explain your problem. -->
 
 <details>
 <summary>View Screenshots</summary>
 
 <!-- Add your screenshots below this line -->
 
-
 </details>
 
-
 ### Ready-for-merge Checklist
 
 - [ ] Expected files: all files in this pull request are related to one feature request or issue (no stragglers)?

diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,9 +1,9 @@
 {
-  "vsicons.associations.files": [{
+  "vsicons.associations.files": [ {
     "icon": "html",
-    "extensions": ["ssi"],
+    "extensions": [ "ssi" ],
     "format": "svg"
-  }],
+  } ],
   "files.associations": {
     "*.ssi": "html"
   },
@@ -94,5 +94,8 @@
   "typescript.format.insertSpaceBeforeFunctionParenthesis": true,
   "typescript.format.semicolons": "insert",
   "typescript.preferences.quoteStyle": "single",
-  "typescript.updateImportsOnFileMove.enabled": "always"
+  "typescript.updateImportsOnFileMove.enabled": "always",
+  "markdownlint.config": {
+    "MD033": false
+  }
 }
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
 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
+- 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
+- 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
 
@@ -68,9 +68,9 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+available at <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
 
 [homepage]: https://www.contributor-covenant.org
 
 For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+<https://www.contributor-covenant.org/faq>
diff --git a/README.md b/README.md
@@ -1,19 +1,18 @@
 <p align="center"><img src="https://avatars1.githubusercontent.com/u/58499608?s=100&v=4" alt="One Platform Logo"></p>
 
 # One Platform
+
 ![Version](https://img.shields.io/badge/version-0.0.0-blue.svg?cacheSeconds=2592000)
 [![Documentation](https://img.shields.io/badge/documentation-yes-brightgreen.svg)](https://github.com/1-Platform/one-platform#readme)
 [![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/1-Platform/one-platform/graphs/commit-activity)
 [![License: MIT](https://img.shields.io/github/license/1-Platform/one-platform)](https://github.com/1-Platform/one-platform/blob/master/LICENSE)
 
 An integrated application hosting platform which allows you to host your SPAs. It also provides common services like
+
 - Authentication and Authorization
 - Notifications Framework
 - Feedback Framework
 
-
-### 🏠 [Homepage](https://github.com/1-Platform/one-platform#readme)
-
 ## Install
 
 ```bash
@@ -37,7 +36,6 @@ Feel free to check [issues page](https://github.com/1-Platform/one-platform/issu
 
 Give a ⭐️ if this project helped you!
 
-
 ## 📝 License
 
-This project is [MIT](./LICENSE) licensed.
+This project is [MIT](./LICENSE) licensed.