[GitHub] [pulsar] sijie edited a comment on issue #4554: [docs] Improve the structure of Pulsar Functions

[GitBox <gi...@apache.org>]

sijie edited a comment on issue #4554: [docs] Improve the structure of Pulsar Functions
URL: https://github.com/apache/pulsar/issues/4554#issuecomment-503760528
 
 
   IMO "Deployment" and "Function Deployment" will confuse users.
   
   I actually have a slight different opinion after looking into the documentation of Azure Functions. I think we should differentiate the audience when categorizing the documentations
   
   Here is the layout I suggest. 
   
   - [ ] Overview : Basically describe the concepts for Pulsar Functions. This is for all audiences.
   - [x] Setup: Setup or configure a Pulsar cluster to run Pulsar Functions. It includes how to run Function workers and configure the runtime. This is for administrators.
      - [ ] Pulsar Function Worker
      - [ ] Configure Runtime
   - [ ] How-to: The how-to guide for developers
      - [ ] Develop: How to develop a pulsar function. (introduction of API)
      - [ ] Debug: How to unit test or debugging a pulsar function during development
      - [ ] Deploy: How to run/deploy a pulsar function.
      - [ ] Configure: How to configure to run a pulsar function
      - [ ] Monitor: How to monitor pulsar functions
      - [ ] Secure: How to secure or access secrets in pulsar functions (it is missing documentation at this moment)
      - [ ] Troubleshoot: How to trouble shoot running pulsar functions.
   - [ ] References
      - [ ] CLI
      - [ ] Function Config
   
   Since we only have one depth for the left navigation bar (due to the limitation of current documentation framework we use), the real name of the nav items can be different from the one I proposed. Mine is just an example.
   
   The `how-to` guide can be organized using the tabs for different languages as what @jerrypeng proposed. Or we can just organize per-language how-to guide as what @Jennifer88huang proposed. Either works for me. 
   
   Though the per-language how-to guide might be easier to implement given the current documentation framework and the frontend skills the community has.
   
   <img width="377" alt="Screen Shot 2019-06-19 at 2 38 07 PM" src="https://user-images.githubusercontent.com/1217863/59803342-09e5f980-92a0-11e9-8b4f-b2105b1d9902.png">
   
   https://docs.microsoft.com/en-in/azure/azure-functions/

----------------------------------------------------------------
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.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services