[
https://issues.apache.org/jira/browse/BEAM-13113?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Artur Khanin updated BEAM-13113:
--------------------------------
Description:
As a Beam Playground application developer, I want to have documentation to
know how to run, debug and extend the frontend.
Acceptance criteria:
# All frontend requirements are listed
# Concepts that are followed in the frontend application are presented
# Steps on how to run the frontend application are presented
# Steps on how to debug the frontend application are presented
# Possible extensions for the frontend application are presented
was:
As a Beam Playground application developer, I want to have documentation to be
able to understand what the method/entity does without reading the code.
Acceptance criteria:
# each method has a complete documentation
## purpose of this method
## input/output arguments
# each entity has a complete documentation
## purpose of this entity
> [Playground] Frontend Documentation
> -----------------------------------
>
> Key: BEAM-13113
> URL: https://issues.apache.org/jira/browse/BEAM-13113
> Project: Beam
> Issue Type: Improvement
> Components: beam-playground
> Reporter: Artur Khanin
> Priority: P3
> Labels: beam-playground-frontend, beam-playground-sprint-3
>
> As a Beam Playground application developer, I want to have documentation to
> know how to run, debug and extend the frontend.
> Acceptance criteria:
> # All frontend requirements are listed
> # Concepts that are followed in the frontend application are presented
> # Steps on how to run the frontend application are presented
> # Steps on how to debug the frontend application are presented
> # Possible extensions for the frontend application are presented
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
