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.

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

chore(docs): add attribution for contributors #2030

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JoCa96
Copy link
Collaborator

@JoCa96 JoCa96 commented Oct 30, 2024

  • load contributor and team data from GitHub API
  • add attribution for bots and contributors
  • make use of VPTeamPage components

@JoCa96 JoCa96 requested a review from a team as a code owner October 30, 2024 17:22
Copy link

changeset-bot bot commented Oct 30, 2024

⚠️ No Changeset found

Latest commit: cfa416e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@JoCa96
Copy link
Collaborator Author

JoCa96 commented Oct 30, 2024

@larsrickert Was there a specific reason why we didn't use all the team components?

import {
  VPTeamPage,
  VPTeamPageTitle,
  VPTeamMembers,
  VPTeamPageSection
} from 'vitepress/theme' 

@JoCa96 JoCa96 enabled auto-merge (squash) October 30, 2024 17:24
@JoCa96 JoCa96 changed the title add attribution for contributors chore(docs): add attribution for contributors Oct 30, 2024
@larsrickert larsrickert self-assigned this Nov 4, 2024
@@ -18,6 +18,7 @@ type Story = StoryObj<typeof OnyxHomePage>;
export const Default = {
args: {
data: {
contributors: [],
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this a leftover?

VPTeamPageSection
} from 'vitepress/theme'

const shuffleArray = (array) =>
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I get your intention with shuffeling but imho this is confusing. What do you think about ordering the core team by title and the contributors by number/size of contributions

},
{
avatar: 'https://www.github.com/JoCa96.png',
login: "flubnau",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flo is not shown currently, propably because he hasn't contributed to GitHub yet.
But we still want to show him, right?

name: 'Jannick Keller',
core: true,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since you are the "Engineering Lead", would it be more unified if Jannick is the "Design Lead" instead of "Lead Designer"?

@larsrickert
Copy link
Collaborator

@larsrickert Was there a specific reason why we didn't use all the team components?

import {
  VPTeamPage,
  VPTeamPageTitle,
  VPTeamMembers,
  VPTeamPageSection
} from 'vitepress/theme' 

In my opinion, the page looks a little weird with all those components. Would prefer personally to use regular h1 headline and description. I guess these components are mainly intended to be used on the home page to fit its look. We could also think about moving the team + contributors to the home page
image

<VPTeamPageSection>
<template #title>Thank you to all contributors 🙏</template>
<template #members>
<VPTeamMembers size="small" :members="shuffleArray(contributors)" />
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am not sure how this will scale in the future if we might have > 50 contributors since the page will get very large then...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants