Docs generated in output-mode "group" are missing versions for multiversioned APIs

For a multi versioned API type, when generating a output-mode "group" rendering, the generated one only contains 1 version of the api.
This is primarily becasue we are overwiting the same named file for all the versions one at a time, thus the last one is what is left generated

primarily due to the following code block we iterate over all the gvd without first grouping them based on the group.

crd-ref-docs/renderer/renderer.go

Lines 86 to 96 in 7de9892

    
           for _, gvd := range gvds { 
        
           	fileName := fmt.Sprintf("%s.%s", gvd.Group, fileExtension) 
        
           	file, err := createOutFile(conf.OutputPath, true, fileName) 
        
           	defer file.Close() 
        
           	if err != nil { 
        
           		return err 
        
           	} 
        
           	if err := tmpl.ExecuteTemplate(file, mainTemplate, []types.GroupVersionDetails{gvd}); err != nil { 
        
           		return err 
        
           	}

Handle multiple API versions per group properly in "Grouped" mode

Navigation Menu

Repository navigation

Docs generated in output-mode "group" are missing versions for multiversioned APIs #167

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

	for _, gvd := range gvds {
	fileName := fmt.Sprintf("%s.%s", gvd.Group, fileExtension)
	file, err := createOutFile(conf.OutputPath, true, fileName)
	defer file.Close()
	if err != nil {
	return err
	}

	if err := tmpl.ExecuteTemplate(file, mainTemplate, []types.GroupVersionDetails{gvd}); err != nil {
	return err
	}

Docs generated in output-mode "group" are missing versions for multiversioned APIs #167

Description

Activity

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions