Skip to content

documentation for 'frontend' functions and data structures #976

Open
@illume

Description

@illume

Parts of frontend/ are undocumented. The benefits are better quality (less bugs) and it makes code easier to understand.

See:

A list of some functions and data structures that need documenting

  • headlamp/frontend/src/lib/k8s/cluster.ts@KubeMetadata
  • headlamp/frontend/src/i18n/ThemeProviderNexti18n.tsx@ThemeProviderNexti18n
  • headlamp/frontend/src/i18n/LocaleSelect/LocaleSelect.tsx@LocaleSelectProps
  • headlamp/frontend/src/components/common/Tabs.tsx@TabsProps

There are more functions and fields than is represented in the list above. Feel free to add or improve docs for other functions. Additionally, some of the existing comments could be improved.

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationfrontendIssues related to the frontendgood first issueDenotes an issue ready for a new contributor, according to the "help wanted" guidelines.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions