Change subsidiary filenames and fix headings in TOC

automation-english/helper.py

@@ -49,14 +49,14 @@ def extract_question(metric):
     return metric_name, metric_question
 
 
-def generate_focus_areas(focus_area_name, focus_area_README, metrics):
+def generate_focus_areas(focus_area_name, focus_area_filename, focus_area_README, metrics):
 
     table_head = template_start
     table_tail = template_end
 
     focus_area_goal = extract_goal(focus_area_README)
 
-    table_head = table_head.replace("$FOCUS_AREA_NAME$", focus_area_name.title())
+    table_head = table_head.replace("$FOCUS_AREA_NAME$", focus_area_name.title().replace('-', ' '))
     table_head = table_head.replace("$FOCUS_AREA_GOAL$", focus_area_goal)
 
     for metric in metrics:
@@ -69,15 +69,10 @@ def generate_focus_areas(focus_area_name, focus_area_README, metrics):
     # \input{techical-fork} 
     # .... metrics...
 
-    file_name = focus_area_name + '.tex'
-    with open(file_name, 'w') as f:
+    # file_name = focus_area_name + '.tex'
+    with open(focus_area_filename, 'w') as f:
         f.write(table_head)
 
-    print(f"Written data to file = {file_name}")
-
-
-
-
-
+    print(f"Written data to file = {focus_area_filename}")
 
 

automation-english/main.py

@@ -157,6 +157,7 @@ def decrease_level(metric_path):
 
                         decrease_level(metric)
                         tex_filename = re.sub(".md", ".tex",metric)
+
                         tex_file_path = os.path.join(current_dir, tex_filename)
                         convert_md2tex(metric, tex_file_path)
                         converted_tex_files.append(tex_filename)
@@ -171,7 +172,9 @@ def decrease_level(metric_path):
 
                     focus_area_README = os.path.join(wg_name, "focus-areas", focus_area, "README.md")
                     # create focus_area.tex file and add table
+                    focus_area_filename= wg_name+"_"+focus_area+".tex"
                     helper.generate_focus_areas(focus_area, focus_area_README, metrics)
+                    included_focus_areas.append(focus_area_filename)
 
                     # Add inclusion commands for metrics
                     with open(focus_area_tex_file_path, "a") as fa_tex_file:
@@ -186,8 +189,9 @@ def decrease_level(metric_path):
                 wg_tex_file.write("\n")
                 wg_tex_file.write(f"\section{{{yaml_data[wg_name]['wg-fullname']}}}\n\clearpage\n")
                 ## TODO: Add content for WG.tex file here
+
                 for fa in included_focus_areas:
-                    wg_tex_file.write(f"\input{{{fa}}} \n")
+                    wg_tex_file.write(f"\input{{{os.path.splitext(fa)[0]}}} \n")
 
     # create master file to include WG.tex files
     with open(master_file_path, "a") as master_file:

automation-english/test_env/time-to-first-response.md

@@ -26,12 +26,27 @@ Time to first response of an activity = time first response was posted to the ac
 
 
 ##### Visualizations
+<<<<<<< HEAD
+
+![GrimoireLab Panel: Efficiency Timing Overview](images/time-to-first-response_efficiency-timing-overview.png)
+
+---------
+
+![Augur Visualization: Time to First Response Heat Map ](images/time-to-first-response_augur-ttc-1.png)
+
+---------
+
+![Augur Visualization: Mean Response Times](images/time-to-first-response_augur-ttc-2.png)
+
+
+=======
 ![GrimoireLab Panel: Efficiency Timing Overview](images/time-to-first-response_efficiency-timing-overview.png)
 ---------
 ![Augur Visualization: Time to First Response Heat Map ](images/time-to-first-response_augur-ttc-1.png)
 ---------
 ![Augur Visualization: Mean Response Times](images/time-to-first-response_augur-ttc-2.png)
 
+>>>>>>> main
 ##### Tools Providing the Metric
 
 * GrimoireLab Panel: [Efficiency Timing Overview](https://chaoss.github.io/grimoirelab-sigils/panels/efficiency-timing-overview/)

automation-english/test_env/time-to-first-response.tex

@@ -47,11 +47,21 @@ \subsubsection{Time to First Response}\label{time-to-first-response}}
 \hypertarget{visualizations}{%
 \subparagraph{Visualizations}\label{visualizations}}
 
+<<<<<<< HEAD
+\includegraphics{images/time-to-first-response_efficiency-timing-overview.png}
+
+\begin{center}\rule{0.5\linewidth}{0.5pt}\end{center}
+
+\includegraphics{images/time-to-first-response_augur-ttc-1.png}
+
+\begin{center}\rule{0.5\linewidth}{0.5pt}\end{center}
+=======
 \hypertarget{grimoirelab-panel-efficiency-timing-overview}{%
 \subsection{\texorpdfstring{\protect\includegraphics{images/time-to-first-response_efficiency-timing-overview.png}}{GrimoireLab Panel: Efficiency Timing Overview}}\label{grimoirelab-panel-efficiency-timing-overview}}
 
 \hypertarget{augur-visualization-time-to-first-response-heat-map-}{%
 \subsection{\texorpdfstring{\protect\includegraphics{images/time-to-first-response_augur-ttc-1.png}}{Augur Visualization: Time to First Response Heat Map }}\label{augur-visualization-time-to-first-response-heat-map-}}
+>>>>>>> main
 
 \includegraphics{images/time-to-first-response_augur-ttc-2.png}
 

automation-english/test_env/wg-common.tex

@@ -1,6 +1,6 @@
 
 \section{Common Metrics WG}
 \clearpage
-\input{what} 
-\input{when} 
-\input{who} 
+\input{wg-common_what} 
+\input{wg-common_when} 
+\input{wg-common_who} 

automation-english/test_env/wg-common_what.tex

@@ -0,0 +1,18 @@
+
+\subsection{Focus Area - What}
+\textbf{Goal:} Understand what contributions organizations and people are being made.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Technical Fork & What are a number of technical forks of an open source project on code development platforms? \\ 
+		\hline
+		Types of Contributions & What types of contributions are being made? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{technical-fork} 
+\input{types-of-contributions} 

automation-english/test_env/wg-common_when.tex

@@ -0,0 +1,27 @@
+
+\subsection{Focus Area - When}
+\textbf{Goal:} Understand when contributions from organizations and people are happening.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Activity Dates and Times & What are the dates and timestamps of when contributor activities occur? \\ 
+		\hline
+		Burstiness & How are short timeframes of intense activity, followed by a corresponding return to a typical pattern of activity, observed in a project? \\ 
+		\hline
+		Review Cycle Duration within a Change Request & What is the duration of a review cycle within a single change request? \\ 
+		\hline
+		Time to Close & How much time passes between creating and closing an operation such as an issue, change request, or support ticket? \\ 
+		\hline
+		Time to First Response & How much time passes between when an activity requiring attention is created and the first response? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{activity-dates-and-times} 
+\input{burstiness} 
+\input{review-cycle-duration-within-a-change-request} 
+\input{time-to-close} 
+\input{time-to-first-response} 

automation-english/test_env/wg-common_who.tex

@@ -0,0 +1,21 @@
+
+\subsection{Focus Area - Who}
+\textbf{Goal:} Understand organizational and personal engagement with open source projects.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Contributor Location & What is the location of contributors? \\ 
+		\hline
+		Contributors & Who are the contributors to a project? \\ 
+		\hline
+		Organizational Diversity & What is the organizational diversity of contributions? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{contributor-location} 
+\input{contributors} 
+\input{organizational-diversity} 

automation-english/test_env/wg-value.tex

@@ -1,6 +1,9 @@
 
 \section{Value WG}
 \clearpage
+\input{wg-value_communal-value} 
+\input{wg-value_individual-value} 
+\input{wg-value_organizational-value} 
 \input{communal-value} 
 \input{individual-value} 
 \input{organizational-value} 

automation-english/test_env/wg-value_communal-value.tex

@@ -0,0 +1,21 @@
+
+\subsection{Focus Area - Communal Value}
+\textbf{Goal:} Identify if a project is valuable to its community of users (including downstream projects) or contributors.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Project Popularity & How popular is an open source project? \\ 
+		\hline
+		Project Velocity & What is the development speed for an organization? \\ 
+		\hline
+		Social Listening & How does one measure the value of community interactions and accurately gauge “reputation” of a community as evident from qualitative sentiment? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{project-popularity} 
+\input{project-velocity} 
+\input{social-listening} 

automation-english/test_env/wg-value_individual-value.tex

@@ -0,0 +1,18 @@
+
+\subsection{Focus Area - Individual Value}
+\textbf{Goal:} Identify if a project is valuable to me as an individual user or contributor.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Job Opportunities & How many job postings request skills with technologies from a project? \\ 
+		\hline
+		Organizational Project Skill Demand & How many organizations are using this project and could hire me if I become proficient? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{job-opportunities} 
+\input{organizational-project-skill-demand} 

automation-english/test_env/wg-value_organizational-value.tex

@@ -0,0 +1,15 @@
+
+\subsection{Focus Area - Organizational Value}
+\textbf{Goal:} Identify if a project is monetarily valuable from an organization's perspective.
+\begin{table}[ht!]
+    \centering
+    \begin{tabular}{|p{0.35\linewidth} | p{0.6\linewidth}|}
+        \hline
+        \hfil \textbf{Metric}  & \hfil \textbf{Question} \\
+        \hline
+		Labor Investment & What was the cost of an organization for its employees to create the counted contributions (e.g., commits, issues, and pull requests)? \\ 
+		\hline
+    \end{tabular}
+\end{table}
+
+\input{labor-investment}