Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

documentation for 'frontend' functions and data structures #976

Open
4 tasks
illume opened this issue Feb 21, 2023 · 3 comments · May be fixed by #2842
Open
4 tasks

documentation for 'frontend' functions and data structures #976

illume opened this issue Feb 21, 2023 · 3 comments · May be fixed by #2842
Labels
documentation Improvements or additions to documentation frontend Issues related to the frontend good first issue Good for newcomers

Comments

@illume
Copy link
Collaborator

illume commented Feb 21, 2023

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.
@illume illume added documentation Improvements or additions to documentation good first issue Good for newcomers frontend Issues related to the frontend labels Feb 21, 2023
@vyncent-t vyncent-t mentioned this issue Feb 21, 2023
Merged
@RISHIKESHk07
Copy link

@illume would like to contribute

This was referenced Dec 16, 2023
Closed
Closed
@harshita9104
Copy link

Hello @illume ,
I am harshita from India, currently working as Technical Writer at Atlan.
I would like to contribute to this issue
Please assign it to me

@Jineshbansal Jineshbansal linked a pull request Feb 4, 2025 that will close this issue
Open
@Jineshbansal
Copy link

Hi @illume, I have raised the PR continuing on the basis of commit bb02e63. It incorporates all the files needed. Kindly review.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation frontend Issues related to the frontend good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

frontend: write documentation for frontend functions and data structures Jineshbansal/headlamp
4 participants
@illume @RISHIKESHk07 @Jineshbansal @harshita9104