Skip to content

docs: about #673

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

Merged
merged 25 commits into from
Mar 31, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
3823dfe
docs: move update into about section
Shinigami92 Mar 25, 2022
f6af69f
docs: restructure sidebar
Shinigami92 Mar 25, 2022
b3297d4
docs: team page
Shinigami92 Mar 25, 2022
ef87c28
docs: fix link
ejcheng Mar 25, 2022
873b864
docs: work on teams page
Shinigami92 Mar 25, 2022
44c65e6
docs: make team page more fancy
Shinigami92 Mar 25, 2022
4e62bc8
docs: add redirect for update.html
Shinigami92 Mar 25, 2022
b964e12
docs: reorder nav
Shinigami92 Mar 25, 2022
48ffe20
docs: add social logos
Shinigami92 Mar 25, 2022
151cb88
docs: improve layout
Shinigami92 Mar 25, 2022
a94f407
docs: reduce avatar size
Shinigami92 Mar 26, 2022
d57fad9
docs: improve roles wrapping
Shinigami92 Mar 26, 2022
0d4269e
docs: fix link
Shinigami92 Mar 26, 2022
eed17dd
Merge branch 'main' into docs-about
Shinigami92 Mar 26, 2022
1ee05d5
docs: make announcements navigatable via sidebar
Shinigami92 Mar 26, 2022
12c3c76
docs: add xDivisionByZerox as contributor
Shinigami92 Mar 26, 2022
c49ad0d
Update members.json
Shinigami92 Mar 27, 2022
4ce9437
Update members.json
Shinigami92 Mar 27, 2022
cb9c6ff
Merge branch 'main' into docs-about
Shinigami92 Mar 27, 2022
b1d6877
Update members.json
pkuczynski Mar 28, 2022
f88dba6
Merge branch 'main' into docs-about
ST-DDT Mar 28, 2022
946b676
Merge branch 'main' into docs-about
Shinigami92 Mar 28, 2022
af0f6cf
chore: sort by alphabet
Shinigami92 Mar 31, 2022
5e7601f
Merge branch 'main' into docs-about
Shinigami92 Mar 31, 2022
f1fee9a
Merge branch 'main' into docs-about
ST-DDT Mar 31, 2022
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 35 additions & 8 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,53 @@ import { apiPages } from './api-pages';

const nav: DefaultTheme.NavItem[] = [
{ text: 'Guide', link: '/guide/' },
// { text: 'Playground', link: '/playground/' },
{
text: 'Ecosystem',
items: [
{ text: 'Discord', link: 'https://chat.fakerjs.dev' },
{ text: 'StackBlitz', link: 'https://fakerjs.dev/new' },
{ text: 'Twitter', link: 'https://twitter.com/faker_js' },
{ text: 'Discord ', link: 'https://chat.fakerjs.dev' },
{ text: 'StackBlitz ', link: 'https://fakerjs.dev/new' },
{ text: 'Twitter ', link: 'https://twitter.com/faker_js' },
],
},
{
text: 'About',
items: [
{
text: 'Announcements',
link: '/about/announcements',
},
{
text: 'Team',
link: '/about/team',
},
],
},
// { text: 'Playground', link: '/playground/' },
];

const sidebar: DefaultTheme.MultiSideBarConfig = {
'/': [
'/about': [
{
text: 'Guide',
text: 'About',
children: [
{
text: 'Recent Statement and FAQs',
link: '/update.html',
text: 'Announcements',
link: '/about/announcements',
children: [
{ text: '2022-01-14', link: '/about/announcements/2022-01-14' },
],
},
{
text: 'Team',
link: '/about/team',
},
],
},
],
'/': [
{
text: 'Guide',
children: [
{
text: 'Getting Started',
link: '/guide/',
Expand Down
7 changes: 7 additions & 0 deletions docs/about/announcements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
editLink: false
---

# Announcements

- [2022-01-14 - An update from the Faker team](./announcements/2022-01-14)
2 changes: 1 addition & 1 deletion docs/update.md → docs/about/announcements/2022-01-14.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ He gave us permission to re-use his work to create **[fakerjs.dev](https://faker

9. Done a TON of issue triage and many, many PR reviews.

<div style="text-align: center;"><img src="./public/first-week-wins.png" width="600" alt="64 pull requests were opened. 34 were merged. 44 issues were opened. 25 were closed." /></div>
<div style="text-align: center;"><img src="/first-week-wins.png" width="600" alt="64 pull requests were opened. 34 were merged. 44 issues were opened. 25 were closed." /></div>

10. We've gotten in contact with the [Open Collective](https://opencollective.com) and discussed a transition plan for the project.

Expand Down
9 changes: 9 additions & 0 deletions docs/about/team.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
title: Team
---

<script setup>
import TeamPage from './team/TeamPage.vue'
</script>

<TeamPage />
7 changes: 7 additions & 0 deletions docs/about/team/TeamMember.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
export interface Member {
readonly name: string;
readonly github: string;
readonly gitlab?: string;
readonly twitter?: string;
readonly roles: readonly string[];
}
76 changes: 76 additions & 0 deletions docs/about/team/TeamMember.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
<script lang="ts" setup>
import type { Member } from './TeamMember';

defineProps<{ member: Member }>();
</script>

<template>
<div class="TeamMember">
<div class="avatar">
<img :src="'https://github.com/' + member.github + '.png'" width="120" />
</div>
<div class="info">
<div class="name">
<b>{{ member.name }}</b>
</div>
<div class="socials">
<a :href="'https://github.com/' + member.github">
<img
src="https://img.icons8.com/ios-glyphs/344/github.png"
alt="GitHub"
title="GitHub"
width="32"
/>
</a>
<a v-if="member.gitlab" :href="'https://gitlab.com/' + member.gitlab">
<img
src="https://img.icons8.com/color/344/gitlab.png"
alt="GitLab"
title="GitLab"
width="32"
/>
</a>
<a
v-if="member.twitter"
:href="'https://twitter.com/' + member.twitter"
>
<img
src="https://img.icons8.com/color/344/twitter.png"
alt="Twitter"
title="Twitter"
width="32"
/>
</a>
</div>
<div v-if="member.roles?.length" class="roles">
<span>Roles: </span>
<template v-for="(role, index) in member.roles">
<i>{{ role }}</i>
<span v-if="index < member.roles.length - 1">, </span>
</template>
</div>
</div>
</div>
</template>

<style scoped>
.TeamMember {
padding: 0.5em;

display: flex;
align-items: center;
}

.TeamMember .avatar {
flex: 0 0 120px;
margin-right: 1em;
}

.TeamMember .avatar img {
border-radius: 50%;
}

.TeamMember .roles i {
white-space: nowrap;
}
</style>
60 changes: 60 additions & 0 deletions docs/about/team/TeamPage.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<script lang="ts" setup>
import membersData from './members.json';
import TeamMember from './TeamMember.vue';
</script>

<template>
<div class="TeamPage">
<div class="core">
<h2>Core Team</h2>
<div class="members">
<TeamMember
v-for="member in membersData.core"
:key="member.name"
:member="member"
/>
</div>
</div>

<div class="contributors">
<h2>Contributors</h2>
<div class="members">
<TeamMember
v-for="member in membersData.contributors"
:key="member.name"
:member="member"
/>
</div>
</div>

<div class="previous">
<h2>Honorable previous members</h2>
<div class="members">
<TeamMember
v-for="member in membersData.previous"
:key="member.name"
:member="member"
/>
</div>
</div>
</div>
</template>

<style scoped>
.TeamPage .members {
display: flex;
flex-direction: row;
flex-wrap: wrap;
width: 100%;
}

.TeamPage .members .TeamMember {
width: 50%;
}

@media (max-width: 120rem) {
.TeamPage .members .TeamMember {
width: 100%;
}
}
</style>
77 changes: 77 additions & 0 deletions docs/about/team/members.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
{
"core": [
{
"name": "Christopher Quadflieg",
"github": "Shinigami92",
"twitter": "Shini_92",
"roles": ["Code Maintainer"]
},
{
"name": "Damien Retzinger",
"github": "damienwebdev",
"twitter": "damienwebdev",
"roles": ["Advisor"]
},
{
"name": "Daniel Bannert",
"github": "prisis",
"twitter": "_prisis_",
"roles": ["Organization Owner"]
},
{
"name": "Daniel Theuke",
"github": "ST-DDT",
"roles": ["Code Maintainer", "Docs Automation"]
},
{
"name": "Erica Clark",
"github": "clarkerican",
"twitter": "clarkerican",
"roles": []
},
{
"name": "griest",
"github": "griest024",
"gitlab": "griest",
"roles": ["Code Reviewer"]
},
{
"name": "Jessica Sachs",
"github": "JessicaSachs",
"twitter": "_JessicaSachs",
"roles": ["Press Officer"]
}
],
"contributors": [
{
"name": "Eric Cheng",
"github": "import-brain",
"roles": ["Triage", "Contributor"]
},
{
"name": "Leyla Jähnig",
"github": "xDivisionByZerox",
"roles": ["Contributor"]
},
{
"name": "Piotr Kuczynski",
"github": "pkuczynski",
"twitter": "PiotrKuczynski",
"roles": ["Contributor"]
}
],
"previous": [
{
"name": "Mateus Dadalto",
"github": "MateusDadalto",
"twitter": "MateusD",
"roles": []
},
{
"name": "Mo Mahallawy",
"github": "mmahalwy",
"twitter": "mmahalwy",
"roles": []
}
]
}
7 changes: 7 additions & 0 deletions netlify.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,10 @@
to = "https://stackblitz.com/edit/faker-js-demo?file=index.ts"
status = 301
force = true

# Redirect old update page to new announcement section
[[redirects]]
from = "/update.html"
to = "https://fakerjs.dev/about/announcements/2022-01-14.html"
status = 301
force = true