API tools faq
paste
Advertisement
dfarrell07

foo

dfarrell07
Mar 15th, 2022
274
0
Never
Add comment
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 12.30 KB | None | 0 0
raw download clone embed print report
  1. ## Create an informative issue
  2.  
  3. Using the current documentation as a model, complete the issue template.
  4.  
  5. **Important:** Always look at the current documentation to describe the change that is needed:
  6.  
  7. - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.4
  8.  
  9. - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
  10.  
  11. **Note:** Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address **only high-priority, customer-reported issues** for releases in support.
  12.  
  13. 1. - [ ] **Mandatory** Choose the documentation release (Published releases are refreshed ~weekly after publication).
  14.  
  15. - [ ] ACM 2.2
  16. - [ ] ACM 2.3
  17. - [ ] ACM 2.4
  18. - [x] ACM 2.5
  19.  
  20. 2. - [ ] **Mandatory** Choose the type of documentation change.
  21.  
  22. - [x] New topic
  23. - [ ] Update to an existing topic
  24.  
  25. 3. - [ ] **Mandatory for bugs:** What is wrong? Clearly define what the problem is and link to the current documentation:
  26.  
  27.  
  28. 4. - [ ] **Mandatory for bugs:** What changes? Clearly define what the change is, or the `diff` between what is published and what you want to change.
  29.  
  30.  
  31. 5. - [x] **Mandatory for new content:**
  32.  
  33. Create new section of Submariner's docs that covers when clusters have overlapping CIDRs and Globalnet should be used.
  34.  
  35. - [x] Steps and/or other important conceptual information:
  36.  
  37. The downstream docs should heavily build on the upstream docs and link to them, avoiding duplication and more maintenance, whenever possible.
  38.  
  39. These docs should be based on:
  40.  
  41. https://submariner.io/getting-started/architecture/globalnet/
  42.  
  43. - [ ] **Required access level** for the user to complete the task:
  44.  
  45. NA. These docs do not need to cover anything special regarding access levels.
  46.  
  47. - [ ] Verification at the end of the task, how does the user verify success
  48.  
  49. Submariner works on clusters with overlapping CIDRs and the user understands why.
  50.  
  51.  
  52. - **Errata release note** version, this is NOT for regular refreshes:
  53. (published with Errata release)
  54.  
  55. - [ ] ACM 2.2.x
  56. - [ ] ACM 2.3.x
  57. - [ ] ACM 2.4.x
  58.  
  59. 6. **Optional:** Get back to issue templates to create more issues for the doc team: https://github.com/open-cluster-management/backlog/issues/new/choose
  60.  
  61.  
  62.  
  63. -----
  64.  
  65.  
  66. ## Create an informative issue
  67.  
  68. Using the current documentation as a model, complete the issue template.
  69.  
  70. **Important:** Always look at the current documentation to describe the change that is needed:
  71.  
  72. - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.4
  73.  
  74. - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
  75.  
  76. **Note:** Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address **only high-priority, customer-reported issues** for releases in support.
  77.  
  78. 1. - [ ] **Mandatory** Choose the documentation release (Published releases are refreshed ~weekly after publication).
  79.  
  80. - [ ] ACM 2.2
  81. - [ ] ACM 2.3
  82. - [ ] ACM 2.4
  83. - [x] ACM 2.5
  84.  
  85. 2. - [ ] **Mandatory** Choose the type of documentation change.
  86.  
  87. - [x] New topic
  88. - [ ] Update to an existing topic
  89.  
  90. 3. - [ ] **Mandatory for bugs:** What is wrong? Clearly define what the problem is and link to the current documentation:
  91.  
  92.  
  93. 4. - [ ] **Mandatory for bugs:** What changes? Clearly define what the change is, or the `diff` between what is published and what you want to change.
  94.  
  95.  
  96. 5. - [x] **Mandatory for new content:**
  97.  
  98. Create new section of Submariner's docs that covers exporting and unexporting services.
  99.  
  100. - [x] Steps and/or other important conceptual information:
  101.  
  102. The downstream docs should heavily build on the upstream docs and link to them, avoiding duplication and more maintenance, whenever possible.
  103.  
  104. These docs should be based on:
  105.  
  106. https://submariner.io/getting-started/architecture/service-discovery/
  107. https://submariner.io/operations/deployment/subctl/#export-service
  108. https://submariner.io/operations/deployment/subctl/#unexport
  109. https://submariner.io/operations/usage/#2-export-services-across-clusters
  110.  
  111. - [ ] **Required access level** for the user to complete the task:
  112.  
  113. NA. These docs do not need to cover anything special regarding access levels.
  114.  
  115. - [ ] Verification at the end of the task, how does the user verify success
  116.  
  117. The user understands how services can be exported across ClusterSets and unexported.
  118.  
  119.  
  120. - **Errata release note** version, this is NOT for regular refreshes:
  121. (published with Errata release)
  122.  
  123. - [ ] ACM 2.2.x
  124. - [ ] ACM 2.3.x
  125. - [ ] ACM 2.4.x
  126.  
  127. 6. **Optional:** Get back to issue templates to create more issues for the doc team: https://github.com/open-cluster-management/backlog/issues/new/choose
  128.  
  129.  
  130. ---
  131.  
  132.  
  133. ## Create an informative issue
  134.  
  135. Using the current documentation as a model, complete the issue template.
  136.  
  137. **Important:** Always look at the current documentation to describe the change that is needed:
  138.  
  139. - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.4
  140.  
  141. - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
  142.  
  143. **Note:** Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address **only high-priority, customer-reported issues** for releases in support.
  144.  
  145. 1. - [ ] **Mandatory** Choose the documentation release (Published releases are refreshed ~weekly after publication).
  146.  
  147. - [ ] ACM 2.2
  148. - [ ] ACM 2.3
  149. - [ ] ACM 2.4
  150. - [x] ACM 2.5
  151.  
  152. 2. - [ ] **Mandatory** Choose the type of documentation change.
  153.  
  154. - [x] New topic
  155. - [ ] Update to an existing topic
  156.  
  157. 3. - [ ] **Mandatory for bugs:** What is wrong? Clearly define what the problem is and link to the current documentation:
  158.  
  159.  
  160. 4. - [ ] **Mandatory for bugs:** What changes? Clearly define what the change is, or the `diff` between what is published and what you want to change.
  161.  
  162.  
  163. 5. - [x] **Mandatory for new content:**
  164.  
  165. Create new section of Submariner's docs that covers uninstalling Submariner.
  166.  
  167. - [x] Steps and/or other important conceptual information:
  168.  
  169. The downstream docs should heavily build on the upstream docs and link to them, avoiding duplication and more maintenance, whenever possible.
  170.  
  171. These docs should be based on:
  172.  
  173. https://submariner.io/operations/cleanup/
  174.  
  175. - [ ] **Required access level** for the user to complete the task:
  176.  
  177. NA. These docs do not need to cover anything special regarding access levels.
  178.  
  179. - [ ] Verification at the end of the task, how does the user verify success
  180.  
  181. The user understands how to uninstall Submariner.
  182.  
  183.  
  184. - **Errata release note** version, this is NOT for regular refreshes:
  185. (published with Errata release)
  186.  
  187. - [ ] ACM 2.2.x
  188. - [ ] ACM 2.3.x
  189. - [ ] ACM 2.4.x
  190.  
  191. 6. **Optional:** Get back to issue templates to create more issues for the doc team: https://github.com/open-cluster-management/backlog/issues/new/choose
  192.  
  193.  
  194. ---
  195.  
  196.  
  197. ## Create an informative issue
  198.  
  199. Using the current documentation as a model, complete the issue template.
  200.  
  201. **Important:** Always look at the current documentation to describe the change that is needed:
  202.  
  203. - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.4
  204.  
  205. - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
  206.  
  207. **Note:** Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address **only high-priority, customer-reported issues** for releases in support.
  208.  
  209. 1. - [ ] **Mandatory** Choose the documentation release (Published releases are refreshed ~weekly after publication).
  210.  
  211. - [ ] ACM 2.2
  212. - [ ] ACM 2.3
  213. - [ ] ACM 2.4
  214. - [x] ACM 2.5
  215.  
  216. 2. - [ ] **Mandatory** Choose the type of documentation change.
  217.  
  218. - [x] New topic
  219. - [ ] Update to an existing topic
  220.  
  221. 3. - [ ] **Mandatory for bugs:** What is wrong? Clearly define what the problem is and link to the current documentation:
  222.  
  223.  
  224. 4. - [ ] **Mandatory for bugs:** What changes? Clearly define what the change is, or the `diff` between what is published and what you want to change.
  225.  
  226.  
  227. 5. - [x] **Mandatory for new content:**
  228.  
  229. Create new section of Submariner's docs that covers how to use the `subctl` utility.
  230.  
  231. - [x] Steps and/or other important conceptual information:
  232.  
  233. The downstream docs should heavily build on the upstream docs and link to them, avoiding duplication and more maintenance, whenever possible.
  234.  
  235. These docs should be based on:
  236.  
  237. https://submariner.io/operations/deployment/subctl/
  238.  
  239. - [ ] **Required access level** for the user to complete the task:
  240.  
  241. NA. These docs do not need to cover anything special regarding access levels.
  242.  
  243. - [ ] Verification at the end of the task, how does the user verify success
  244.  
  245. The user understands what `subctl` is, can be used for, and where to find more information.
  246.  
  247.  
  248. - **Errata release note** version, this is NOT for regular refreshes:
  249. (published with Errata release)
  250.  
  251. - [ ] ACM 2.2.x
  252. - [ ] ACM 2.3.x
  253. - [ ] ACM 2.4.x
  254.  
  255. 6. **Optional:** Get back to issue templates to create more issues for the doc team: https://github.com/open-cluster-management/backlog/issues/new/choose
  256.  
  257.  
  258. ---
  259.  
  260.  
  261. ## Create an informative issue
  262.  
  263. Using the current documentation as a model, complete the issue template.
  264.  
  265. **Important:** Always look at the current documentation to describe the change that is needed:
  266.  
  267. - Use the Customer Portal: https://access.redhat.com/documentation/en-us/red_hat_advanced_cluster_management_for_kubernetes/2.4
  268.  
  269. - Use the GitHub link to find the staged docs in the repository: https://github.com/stolostron/rhacm-docs
  270.  
  271. **Note:** Doc team updates the current version and the two previous versions (n-2). For earlier versions, we will address **only high-priority, customer-reported issues** for releases in support.
  272.  
  273. 1. - [ ] **Mandatory** Choose the documentation release (Published releases are refreshed ~weekly after publication).
  274.  
  275. - [ ] ACM 2.2
  276. - [ ] ACM 2.3
  277. - [ ] ACM 2.4
  278. - [x] ACM 2.5
  279.  
  280. 2. - [ ] **Mandatory** Choose the type of documentation change.
  281.  
  282. - [x] New topic
  283. - [ ] Update to an existing topic
  284.  
  285. 3. - [ ] **Mandatory for bugs:** What is wrong? Clearly define what the problem is and link to the current documentation:
  286.  
  287.  
  288. 4. - [ ] **Mandatory for bugs:** What changes? Clearly define what the change is, or the `diff` between what is published and what you want to change.
  289.  
  290.  
  291. 5. - [x] **Mandatory for new content:**
  292.  
  293. Create new section of Submariner's docs that covers troubleshooting Submariner.
  294.  
  295. - [x] Steps and/or other important conceptual information:
  296.  
  297. The downstream docs should heavily build on the upstream docs and link to them, avoiding duplication and more maintenance, whenever possible.
  298.  
  299. These docs should be based on:
  300.  
  301. https://submariner.io/operations/troubleshooting/#automated-troubleshooting
  302.  
  303. - [ ] **Required access level** for the user to complete the task:
  304.  
  305. NA. These docs do not need to cover anything special regarding access levels.
  306.  
  307. - [ ] Verification at the end of the task, how does the user verify success
  308.  
  309. The user understands how to troubleshoot Submariner for common issues.
  310.  
  311.  
  312. - **Errata release note** version, this is NOT for regular refreshes:
  313. (published with Errata release)
  314.  
  315. - [ ] ACM 2.2.x
  316. - [ ] ACM 2.3.x
  317. - [ ] ACM 2.4.x
  318.  
  319. 6. **Optional:** Get back to issue templates to create more issues for the doc team: https://github.com/open-cluster-management/backlog/issues/new/choose
  320. 9090
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement
Public Pastes
Advertisement
We use cookies for various purposes including analytics. By continuing to use Pastebin, you agree to our use of cookies as described in the Cookies Policy.  OK, I Understand
Not a member of Pastebin yet?
Sign Up, it unlocks many cool features!