Also a Why? section, which has children discussing design questions (WIP)
On August 30, 2017 at 18:22:19, Otto Fowler ([email protected]) wrote: I would like to use this thread to describe and discuss what is being done or tried in the parser extension feature branch effort. This is our first time doing this, and there are some differences with reviewing pull requests that we will have to work through, such as there not always being a pull request to comment on. Structure This is what I have setup, with an explanation: A Confluence Area I have added a Confluence area under Research and Ideas ( now Research, Ideas, and Feature Branches <https://cwiki.apache.org/confluence/display/METRON/Research%2C+Ideas%2C+and+Feature+Branches> ). I added this because Confluence seems the right place to document the reasoning behind a feature branch effort. I think the documentation describing the branch purpose, review tasks, and also the kind of feedback that may happen fit there better than in jira. I also did not want to add ‘src’ based support that would have to be removed later ( like adding readme.mds ). It may be that some of this kind of discussion also gets carried out on the mailing list, which is fine, but my thought is that potential reviewers will need some materials. The root document is Metron Extension System and Parser Extensions <https://cwiki.apache.org/confluence/display/METRON/Metron+Extension+System+and+Parser+Extensions>. This document contains: - Important links for the effort ( jira, git, new committer script ) - Definition of labels that are to be used on jira issues related to the effort - metron-feature-extensions-parsers for all jiras - metron-feature-canidate for all jiras that are proposed additions to the feature branch ( such as the ui for installing extensions ) - Jira charts and lists for tagged issues and their status - A problem statement - An idea statement that outlines what the approach was - Child map to *PR Descriptions* - PR Description Pages contain the original description test from the PRs - Child map to *Review Areas* - Review Areas are pages the describe review topics, including some source listings on where to look - Child map to *Testing* - Testing pages have some tests or link to test steps - Acceptance Criteria (needs work and feedback as all of this does ) - Links to Resources Jira I created a Jira for the feature branch METRON–1136 <https://issues.apache.org/jira/browse/METRON-1136> that is linked to the other jiras, and should be linked to any jiras that arise. I have also created the labels mentioned earlier. Workflow-y things - familiarize yourself with the effort - tag your jiras - create pages for design discussions when no pr context is available - request clarification on review tasks and testing - add content and findings - review the status of things TL/DR; I made some Jira and Confluence stuff to help people review and I hope it is ok. Please look at it so we can get the ball rolling. Hopefully this is a setup ( or start of one ) that will allow us to handle: - documenting the feature branch effort - on boarding - feedback without pr and design discussion - jira based proposal for inclusion or MVP expansion Any feedback or suggestions are appreciated.
