[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-24 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1176031180


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+

Review Comment:
   @liangyepianzhou ?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-24 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1176030857


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI
+
+### Metrics
+
+
+
+
+# Monitoring

Review Comment:
   @tisonkun 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-16 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1167929479


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI

Review Comment:
   @liangyepianzhou ping



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-16 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1167929422


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+

Review Comment:
   I've pushed a commit @liangyepianzhou - can you take a look?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-16 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1167928864


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI
+
+### Metrics
+
+
+
+
+# Monitoring

Review Comment:
   Ok to resolve?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-16 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1167928817


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+

[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-04 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1157112457


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI

Review Comment:
   Admin API == REST API?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-04 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1157112228


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI

Review Comment:
   Admin API != CLI, no? 



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-04 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1156987721


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,157 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+

Review Comment:
   Maybe we can template how we want the public API to be documented? 
   A REST API is composed of:
   * path
   * query parameters
   * HTTP body parameters, usually as JSON
   * Response codes, and for each
  * what they mean - description
  * a detailed description of the response body JSON, specifying each field 
and what it means
   
   The last ones include of course errors.
   
   WDYT?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-03 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1155720883


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI
+
+### Metrics
+
+
+
+
+# Monitoring
+
+
+
+# Security Considerations
+
+
+# Backward Compatability

Review Comment:
   Added. Take a look?



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-03 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1155718725


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+
+
+
+## Public-facing Changes
+
+
+
+### Public API 
+
+### Binary protocol
+
+### Configuration
+
+### CLI
+
+### Metrics
+
+
+
+
+# Monitoring

Review Comment:
   I think it forces you to think from the operator perspective. My guess, it 
will trigger you to change your metrics once you stop and think about it.
   In my opinion, it's important.
   



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-03 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1155716128


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope

Review Comment:
   Goals are what you want to achieve.
   Scope - what you can actually do in the PIP
   Out of scope - you don't have time, so it is not included in the pip at all.
   
   Non-goals: Objectives you will achieve in this pip (in scope) but are not 
your primary goals.
   
   I think it has different semantics.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-03 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1155716128


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope

Review Comment:
   Goals is what you want to achieve.
   Scope - what you can actually do in the PIP
   Out of scope - you don't have time , so it is not included in the pip at all.
   
   Non-goals: Objectives you will achieve in this pip (in scope) but are not 
your primary goals.
   
   I think it has different semantics.



-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org



[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-04-03 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1155714389


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+

[GitHub] [pulsar] asafm commented on a diff in pull request #19832: [fix][misc] Change PIP issue template

2023-03-30 Thread via GitHub


asafm commented on code in PR #19832:
URL: https://github.com/apache/pulsar/pull/19832#discussion_r1152822068


##
.github/ISSUE_TEMPLATE/pip.md:
##
@@ -0,0 +1,151 @@
+---
+name: PIP
+about: Submit a Pulsar Improvement Proposal (PIP)
+title: 'PIP-XYZ: '
+labels: PIP
+---
+
+
+
+# Background knowledge
+
+
+
+# Motivation
+
+
+
+# Goals
+
+## In Scope
+
+
+
+## Out of Scope
+
+
+
+
+# High Level Design
+
+
+
+# Detailed Design
+
+## Design & Implementation Details
+