User talk:Duggabe: Difference between revisions

From GNU Radio
Jump to navigation Jump to search
No edit summary
(Initial creation)
 
(91 intermediate revisions by 3 users not shown)
Line 1: Line 1:
This is for notes on GR documentation.
== Analysis of Zammad helpdesk software ==
<hr>


01/14:<br>
Our intended use of the Zammad software is to handle all emails received by <code>grcon@gnuradio.org</code>, <code>tickets@gnuradio.org</code>, and <code>sponsor@gnuradio.org</code>. It assigns a ticket number to each initial customer interaction and tracks the progress of the response, keeping subsequent emails within the same ticket as a "thread".
I think Guided_Tutorial_GNU_Radio_in_C++ can be used now for the Writing blocks in C++ (for 3.7)


see Cyrille and my discussion on Slack #docs on Wednesday 1/15 about Writing the XML file for a block (for 3.7)
=== Configuration and Use ===


01/17:<br>
==== Overview Selection Panel ====
I added a gnuradio-companion error msg in https://wiki.gnuradio.org/index.php/InstallingGR#To_install_system_wide


01/19
The area of the Overviews screen which selects what emails to display currently combines four different filters into one:
* https://wiki.gnuradio.org/index.php/Guided_Tutorial_GNU_Radio_in_C%2B%2B
* Email source (grcon, tickets, or sponsor)
* gr-tutorial notes for 3.8
* STATE (new, open, closed, pending)
*
* All
*   these are the places I found where 3.7 and 3.8 are different.
* Assigned to me


<pre>
This leads to at least 14 selections. This is not ideal (in my opinion), but can be used for initial trials. A better solution would be to have two or three dropdown menus to do the selection (or maybe Github issues selection style).
~ $ gr_modtool newmod tutorial
Creating out-of-tree module in ./gr-tutorial...
Done.
Use 'gr_modtool add' to add a new block to this currently empty module.
</pre>


<pre>
==== Tags ====
~/gr-tutorial $ ls
apps  cmake  CMakeLists.txt  docs  examples  grc  include  lib  MANIFEST.md  python  swig
</pre>


<pre>
If Tags must be selected from a pre-defined list, more options need to be defined.
~/gr-tutorial $ gr_modtool add my_qpsk_demod_cb
GNU Radio module name identified: tutorial
('sink', 'source', 'sync', 'decimator', 'interpolator', 'general', 'tagged_stream', 'hier', 'noblock')
Enter block type: general
Language (python/cpp): cpp
Language: C++
Block/code identifier: my_qpsk_demod_cb
Please specify the copyright holder: gnuradio.org
Enter valid argument list, including default arguments:
bool gray_code
Add Python QA code? [Y/n] Y
Add C++ QA code? [y/N] N
Adding file 'lib/my_qpsk_demod_cb_impl.h'...
Adding file 'lib/my_qpsk_demod_cb_impl.cc'...
Adding file 'include/tutorial/my_qpsk_demod_cb.h'...
Editing swig/tutorial_swig.i...
Adding file 'python/qa_my_qpsk_demod_cb.py'...
Editing python/CMakeLists.txt...
Adding file 'grc/tutorial_my_qpsk_demod_cb.block.yml'...
Editing grc/CMakeLists.txt...
</pre>


* and, of course, we need the YAML file instead of the XML file
=== Success Requires Full Participation ===
 
For the Zammad software to work for us, every person who processes email for any of the sources (grcon, tickets, or sponsor) must have full read and write privileges, and <b>MUST USE ZAMMAD instead of direct access to the Gmail interface.</b> Mixing the two would lead to confusion and lack of coordination.
 
=== Path Forward ===
 
I propose that I be given 'admin' privileges to create a workable configuration for further testing and evaluation.

Latest revision as of 16:53, 19 February 2024

Analysis of Zammad helpdesk software

Our intended use of the Zammad software is to handle all emails received by grcon@gnuradio.org, tickets@gnuradio.org, and sponsor@gnuradio.org. It assigns a ticket number to each initial customer interaction and tracks the progress of the response, keeping subsequent emails within the same ticket as a "thread".

Configuration and Use

Overview Selection Panel

The area of the Overviews screen which selects what emails to display currently combines four different filters into one:

  • Email source (grcon, tickets, or sponsor)
  • STATE (new, open, closed, pending)
  • All
  • Assigned to me

This leads to at least 14 selections. This is not ideal (in my opinion), but can be used for initial trials. A better solution would be to have two or three dropdown menus to do the selection (or maybe Github issues selection style).

Tags

If Tags must be selected from a pre-defined list, more options need to be defined.

Success Requires Full Participation

For the Zammad software to work for us, every person who processes email for any of the sources (grcon, tickets, or sponsor) must have full read and write privileges, and MUST USE ZAMMAD instead of direct access to the Gmail interface. Mixing the two would lead to confusion and lack of coordination.

Path Forward

I propose that I be given 'admin' privileges to create a workable configuration for further testing and evaluation.