chore: Move links into Additonal Resources section of generated readmes

Signed-off-by: Giulio Frasca <gfrasca@redhat.com>

Author: gmfrasca

scripts/generate_readme/README.md.j2

@@ -38,3 +38,11 @@
 {% endfor %}
 {% endif %}
 
+{% if links %}
+## Additional Resources 📚
+
+{% for link_name, link_url in links.items() %}
+- **{{ link_name | replace('_', ' ') | title }}**: [{{ link_url }}]({{ link_url }})
+{% endfor %}
+{% endif %}
+

scripts/generate_readme/content_generator.py

@@ -202,7 +202,8 @@ def _prepare_template_context(self) -> Dict[str, Any]:
         Returns:
             Dictionary containing all variables needed by the template.
         """
-        component_name = self.metadata.get('name', 'Component')
+        # Prefer name from metadata.yaml over function name
+        component_name = self.feature_metadata.get('name', self.metadata.get('name', 'Component'))
 
         # Prepare title
         title = ' '.join(word.capitalize() for word in component_name.split('_'))
@@ -237,8 +238,14 @@ def _prepare_template_context(self) -> Dict[str, Any]:
         # Load example pipeline if it exists
         example_code = self._load_example_pipeline()
 
+        # Extract links for separate Additional Resources section (removes from feature_metadata)
+        links = self.feature_metadata.pop('links', {})
+        
         # Prepare formatted metadata for human-readable display
-        formatted_metadata = self._format_metadata() if self.feature_metadata else {}
+        formatted_metadata = {
+            self._format_key(key): self._format_value(value)
+            for key, value in self.feature_metadata.items()
+        }
 
         return {
             'title': title,
@@ -248,5 +255,6 @@ def _prepare_template_context(self) -> Dict[str, Any]:
             'component_name': component_name,
             'example_code': example_code,
             'formatted_metadata': formatted_metadata,
+            'links': links,
         }
 

scripts/generate_readme/tests/test_content_generator.py

@@ -119,6 +119,77 @@ def test_owners_in_generated_readme(self, component_dir, sample_extracted_metada
         assert 'Approvers' in readme or 'approvers' in readme.lower()
         assert 'Reviewers' in readme or 'reviewers' in readme.lower()
 
+    def test_links_in_additional_resources_section(self, component_dir, sample_extracted_metadata):
+        """Test that links appear in Additional Resources section, not Metadata."""
+        # Update metadata.yaml to include links
+        metadata_file = component_dir / "metadata.yaml"
+        metadata_file.write_text("""name: sample_component
+tier: core
+stability: stable
+tags:
+  - testing
+links:
+  documentation: https://example.com/docs
+  issue_tracker: https://github.com/example/issues
+  source_code: https://github.com/example/code
+""")
+        
+        generator = ReadmeContentGenerator(
+            sample_extracted_metadata,
+            component_dir
+        )
+        
+        readme = generator.generate_readme()
+        
+        # Check that Additional Resources section exists
+        assert '## Additional Resources' in readme
+        
+        # Check that links appear in Additional Resources
+        assert 'https://example.com/docs' in readme
+        assert 'https://github.com/example/issues' in readme
+        assert 'https://github.com/example/code' in readme
+        assert 'Documentation' in readme
+        assert 'Issue Tracker' in readme
+        assert 'Source Code' in readme
+        
+        # Verify links are NOT in the Metadata section
+        # Extract just the metadata section
+        lines = readme.split('\n')
+        metadata_section = []
+        in_metadata = False
+        for line in lines:
+            if '## Metadata' in line:
+                in_metadata = True
+            elif in_metadata and line.startswith('##'):
+                break
+            if in_metadata:
+                metadata_section.append(line)
+        
+        metadata_text = '\n'.join(metadata_section)
+        # Links should not appear as a bullet point in metadata
+        assert '- **Links**:' not in metadata_text
+    
+    def test_no_links_no_additional_resources_section(self, component_dir, sample_extracted_metadata):
+        """Test that Additional Resources section is omitted when no links exist."""
+        # Remove links from metadata.yaml to test no-links case
+        import yaml
+        metadata_file = component_dir / 'metadata.yaml'
+        with open(metadata_file) as f:
+            metadata = yaml.safe_load(f)
+        metadata.pop('links', None)
+        with open(metadata_file, 'w') as f:
+            yaml.dump(metadata, f)
+        
+        generator = ReadmeContentGenerator(
+            sample_extracted_metadata,
+            component_dir
+        )
+        
+        readme = generator.generate_readme()
+        
+        # Additional Resources section should NOT exist
+        assert '## Additional Resources' not in readme
+    
     def test_prepare_template_context(self, component_dir, sample_extracted_metadata):
         """Test template context preparation."""
         generator = ReadmeContentGenerator(
@@ -249,7 +320,8 @@ def test_generate_readme_pipeline(self, pipeline_dir, sample_extracted_metadata)
         readme = generator.generate_readme()
 
         # Check sections are present
-        assert '# Sample Component' in readme
+        # Title should use name from metadata.yaml, not function name
+        assert '# Sample Pipeline' in readme
         assert '## Overview' in readme
         assert '## Inputs' in readme
         assert '## Outputs' in readme