docs changes

redhat-cop · Nov 5, 2024 · 8d9f276 · 8d9f276
1 parent b261892
commit 8d9f276
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 90 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -1,6 +1,6 @@
 # Contributor's Guidelines
 
-Refer to the [Contributing guidelines](https://docs.ansible.com/ansible/devel/community/index.html) for basic guideline.
+Refer to the [Ansible Community Guide](https://docs.ansible.com/ansible/devel/community/index.html) for basic guideline.
 
 ## General Guidance
 When making a contribution to the repositories of the Red Hat Communities of Practice, try to utilize the following set of guidelines outlined in this section. Committers should adhere to these practices as they attempt to address many (but not all) of the primary concerns associated with open source repositories and project management:

diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,10 +2,6 @@
 
 <!-- Use prefix such as NEW, CHG. FIX for the commits -->
 
-## Connected Jira issues
-
-* https://issues.redhat.com/browse/SHWRM-xxx
-
 ## Connected merge requests
 
 <!-- Paste links to related MRs or remove this section. -->

diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml
@@ -5,7 +5,6 @@ on:
   push:
     branches:
       - devel
-      - github-actions
 
 permissions:
   contents: read

diff --git a/docs/ansible_practices.md b/docs/ansible_practices.md
@@ -46,7 +46,7 @@ Controller. The named should be include a prefix named `landscape_`.
 
 Use cases are high level collections of tasks, grouped around a specific
 type of usage - base operating system configuration, a particular server
-deployment etc. Use cases are mapped as epics in the Jira. These epics
+deployment etc. Use cases are mapped as epics. These epics
 contain user stories, tasks and bugs for specific features. These kind
 of playbooks should start with a prefix named `type_` which can be
 easily used on Ansible Automation Controller. Each type is then made of
@@ -57,7 +57,7 @@ by the same type can be re-used, written only once.
 
 Depending on the complexity and distinct requirements, a use case might
 contain one or more features. Features are generally mapped to user
-stories in a particular epic in Jira. It is preferred to create a simple
+stories in a particular epic. It is preferred to create a simple
 playbook named with a prefix named `function_` for a particular role,
 mostly to be used as a ad-hoc script.
 

diff --git a/docs/branch_standards.md b/docs/branch_standards.md
@@ -14,7 +14,7 @@ contains two repositories;
     parameters for infrastructure and client groups, as well as global
     parameters
 
-## Branch Naming Convention
+##t
 
 -   Feature Branches: feature-&lt;Jira ticket number&gt;
 

diff --git a/docs/general_guidelines.md b/docs/general_guidelines.md
@@ -1,4 +1,4 @@
-# Azure cost estimation
+# General Guidelines
 
 This document explains general guidelines for the project to work
 together. We all have agreed to work with Agile methodology and also
@@ -7,13 +7,6 @@ part for building open framework between people in the project.
 
 ![Social Contract](./images/social_contract.jpg){ align=centre }
 
-# User Stories
-
-We use internal JIRA to follow-up user stories, tasks, epics in the
-project with agile approach. See
-[JIRA](https://issues.redhat.com/secure/RapidBoard.jspa?rapidView=19625&projectKey=SHWRM&view=planning&issueLimit=100)
-for the user stories and planning.
-
 ## Definition of Ready
 
 ### Independent
@@ -58,51 +51,14 @@ needs. These allow your team to evaluate whether the task is complete.
 
 3.  All issues solved within Merge request Review.
 
-4.  Merge requests points jira tickets.
+4.  All pipelines passed successfully.
 
-5.  All pipelines passed successfully.
-
-6.  All Ansible code written idempotent allows same results when
+5.  All Ansible code written idempotent allows same results when
     executed more than once.
 
-7.  Test steps clearly described and proof attached.
-
-8.  Documented clearly.
-
-## Backlog Guidelines
-
-1.  All "STORIES" and "TASKS" are associated with an "EPIC" type issue
-    that logically represents all that needs to be down under a specific
-    context.
-
-2.  "STORY" type issues shall be used to represent direct value to the
-    customer. As such the persona of such issue is always the customer.
-
-3.  "TASK" type issues shall be used to represent either admin-like
-    tasks or technical tasks that do not represent direct value to the
-    customer.
-
-4.  "SUB-TASK" type issues shall be used break down stories or tasks. Do
-    keep in mind they do not appear directly in the backlog. Use them as
-    a way to organize the issues you own.
-
-5.  The pre-fix \[P\] present on the name of an issue in JIRA, means
-    that the issue is "Prepared" for refinement and can thus be reviewed
-    by the team.
-
-6.  The pre-fix \[R\] present on the name of an issue in JIRA, means
-    that the issue is "Refined/Ready" to be taken into a sprint.
-
-7.  Any member of the Core Implementation team can and is encouraged to
-    add any issues that they feel relevant to the backlog for future
-    refinement.
-
-8.  Backlog Items will be estimated by complexity with the usage of the
-    Fibonacci sequence.
+6.  Test steps clearly described and proof attached.
 
-9.  Prioritization of the backlog is of the sole responsibility of the
-    acting PO (José Costa) and the backlog should be prioritized as part
-    of the refinement and planing events.
+7.  Documented clearly.
 
 # Git Cheat Sheet
 

diff --git a/docs/onboarding.md b/docs/onboarding.md
@@ -13,23 +13,6 @@ new members with the necessary support for their tasks. By following
 this onboarding guide, new team members will be well-prepared to
 contribute to the project’s success from the outset.
 
-## Project Management
-
-A key component of our project management and follow-up process is the
-use of an [RH internal JIRA](https://issues.redhat.com/projects/SHWRM)
-system. This section of the document explains how JIRA is utilized to
-track project progress, manage tasks, and ensure timely completion of
-deliverables. Instructions on accessing and navigating the JIRA system,
-along with best practices for updating tasks and communicating within
-the platform, are provided to help new members quickly become proficient
-in its use. By following this onboarding guide and effectively
-leveraging JIRA, new team members will be well-prepared to contribute to
-the project’s success from the outset.
-
-It is recommended to request a user story to be onboarded from other
-team members through JIRA. Please ensure that all the necessary tools
-are accessible from your side when JIRA user story completed.
-
 ## Collaboration
 
 Slack is our main collaboration tool for real-time communication and
@@ -38,7 +21,7 @@ communications, sharing updates, and quick problem-solving. Guidelines
 on joining relevant channels, best practices for messaging, and tips for
 effective use of Slack are included to help new members integrate
 seamlessly into the team’s communication flow. By following this
-onboarding guide and effectively leveraging JIRA and Slack, new team
+onboarding guide, new team
 members will be well-prepared to contribute to the project’s success
 from the outset.
 

diff --git a/docs/slack_integration.md b/docs/slack_integration.md
@@ -24,20 +24,8 @@ integration, GitHub app should be installed on Slack from
     /invite @github
 
     # receive notifications only on pull request creation and workflow run
-    /github subscribe redhat-cop/rhis-code pulls workflows:{event:"pull_request" branch:"main"}
+    /github subscribe redhat-cop/rhis-code workflows:{event:“pull_request”,“push” branch:“main”,“devel”}
     /github unsubscribe redhat-cop/rhis-code issues commits releases deployments
 
-    /github subscribe redhat-cop/rhis-inventory pulls workflows:{event:"pull_request" branch:"main"}
+    /github subscribe redhat-cop/rhis-inventory workflows:{event:“pull_request”,“push” branch:“main”,“devel”}
     /github unsubscribe redhat-cop/rhis-inventory issues commits releases deployments
-
-## Jira Integration
-
-In-house developed Slack integration called [Red Hat Jira
-Connector](https://source.redhat.com/personal_blogs/get_a_dm_in_slack_when_youre_mentioned_on_a_jira_issue)
-allows Jira to send notifications on certain actions. You can customize
-these notifications by navigating to Project Settings and then Slack
-Integartion tab. We have limited these actions with only the followings:
-Issue Created, Issue Resolved, Issue Closed, Issue Reopened, Issue
-Moved, In Progress, Closed New Refinement.
-
-![Jira-Slack Integration](./images/jira_slack_integration.png)