Skip to content

Commit

Permalink
Show Adopters of Open VSX on the Website
Browse files Browse the repository at this point in the history 
Add adopters page
Add 'Working Group' menu item to header menu
Remove 'Community' and 'FAQ' menu items from header menu
Add Resources section to About page with links to Community and FAQ
  • Loading branch information
amvanbaren committed Oct 16, 2023
1 parent b4a73b6 commit b909007
Show file tree
Hide file tree
Showing 5 changed files with 101 additions and 37 deletions.
2 changes: 1 addition & 1 deletion configuration/application.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ ovsx:
storage:
primary-service: azure-blob
webui:
frontendRoutes: "/extension/**,/namespace/**,/user-settings/**,/admin-dashboard/**,/about,/publisher-agreement-*,/terms-of-use,/members"
frontendRoutes: "/extension/**,/namespace/**,/user-settings/**,/admin-dashboard/**,/about,/publisher-agreement-*,/terms-of-use,/members,/adopters"
eclipse:
# TODO change back to https://api.eclipse.org/ for release.
base-url: https://api-staging.eclipse.org/
Expand Down
2 changes: 1 addition & 1 deletion website/dev/mock-service.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import {
NamespaceMembershipList, AdminService, PublisherInfo, NewReview, ExtensionFilter, UrlString, MembershipRole
} from "openvsx-webui";

const avatarUrl = 'https://upload.wikimedia.org/wikipedia/commons/1/19/Spongebob_Squarepants_as_a_balloon.jpg';
const avatarUrl = 'https://upload.wikimedia.org/wikipedia/commons/9/99/Avatar_cupcake.png';

export class MockRegistryService extends ExtensionRegistryService {

Expand Down
25 changes: 19 additions & 6 deletions website/src/about.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
********************************************************************************/

import * as React from 'react';
import { Link, Typography, Container } from '@mui/material';
import { Link, Typography, Container, List, ListItem, ListItemText } from '@mui/material';
import { styled, Theme } from '@mui/material/styles';

const Heading = styled(Typography)(({ theme }: { theme: Theme }) => ({
Expand Down Expand Up @@ -58,11 +58,24 @@ const About = () => {
</li>
</RepositoryList>

<Heading variant='h5'>Publishing Extensions</Heading>
<Paragraph variant='body1'>
The publishing process is described in
the <Link color='secondary' underline='hover' href='https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension'>openvsx Wiki</Link>.
</Paragraph>
<Heading variant='h5'>Resources</Heading>
<List>
<ListItem>
<ListItemText>
The publishing process is described in the <Link color='secondary' underline='hover' href='https://github.com/eclipse/openvsx/wiki/Publishing-Extensions#how-to-publish-an-extension'>openvsx Wiki</Link>.
</ListItemText>
</ListItem>
<ListItem>
<ListItemText>
The <Link color='secondary' underline='hover' href='https://www.eclipse.org/legal/open-vsx-registry-faq/'>FAQ</Link> section explains what you can and cannot do as a user of our service.
</ListItemText>
</ListItem>
<ListItem>
<ListItemText>
Get involved in the <Link color='secondary' underline='hover' href='https://gitter.im/eclipse/openvsx'>community</Link>.
</ListItemText>
</ListItem>
</List>
</Container>;
}

Expand Down
107 changes: 78 additions & 29 deletions website/src/menu-content.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,20 @@
* SPDX-License-Identifier: EPL-2.0
********************************************************************************/

import React, { FunctionComponent, PropsWithChildren } from 'react';
import { Theme, Typography, MenuItem, Link, Button } from '@mui/material';
import React, { FunctionComponent, PropsWithChildren, useState, useRef } from 'react';
import { Theme, Typography, Menu, MenuItem, Link, Button, Accordion, AccordionDetails, AccordionSummary } from '@mui/material';
import { styled } from '@mui/material/styles';
import { Link as RouteLink } from 'react-router-dom';
import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
import GitHubIcon from '@mui/icons-material/GitHub';
import MenuBookIcon from '@mui/icons-material/MenuBook';
import HelpIcon from '@mui/icons-material/Help';
import ForumIcon from '@mui/icons-material/Forum';
import InfoIcon from '@mui/icons-material/Info';
import StarIcon from '@mui/icons-material/Star';
import StatusIcon from '@mui/icons-material/NetworkCheck';
import PublishIcon from '@mui/icons-material/Publish';
import GroupWorkIcon from '@mui/icons-material/GroupWork';
import PeopleAltIcon from '@mui/icons-material/PeopleAlt';
import HubIcon from '@mui/icons-material/Hub';
import { UserSettingsRoutes } from 'openvsx-webui';

//-------------------- Mobile View --------------------//
Expand Down Expand Up @@ -71,19 +73,41 @@ export const MobileMenuContent: FunctionComponent = () => {
</MobileMenuItemText>
</Link>
</MobileMenuItem>
<MobileMenuItem>
<Link href='https://www.eclipse.org/legal/open-vsx-registry-faq/'>
<Accordion sx={{border: 0, borderRadius: 0, boxShadow: '0 0'}}>
<AccordionSummary
expandIcon={<ExpandMoreIcon />}
aria-controls="working-group-content"
id="working-group-header"
>
<MobileMenuItemText>
<HelpIcon sx={itemIcon} />
FAQ
<GroupWorkIcon sx={itemIcon} />
Working Group
</MobileMenuItemText>
</Link>
</MobileMenuItem>
</AccordionSummary>
<AccordionDetails>
<MobileMenuItem>
<RouteLink to='/members'>
<MobileMenuItemText>
<PeopleAltIcon sx={itemIcon} />
Members
</MobileMenuItemText>
</RouteLink>
</MobileMenuItem>
<MobileMenuItem>
<RouteLink to='/adopters'>
<MobileMenuItemText>
<HubIcon sx={itemIcon} />
Adopters
</MobileMenuItemText>
</RouteLink>
</MobileMenuItem>
</AccordionDetails>
</Accordion>
<MobileMenuItem>
<Link href='https://gitter.im/eclipse/openvsx'>
<Link href='https://www.eclipse.org/donate/openvsx/'>
<MobileMenuItemText>
<ForumIcon sx={itemIcon} />
Community
<StarIcon sx={itemIcon} />
Sponsor
</MobileMenuItemText>
</Link>
</MobileMenuItem>
Expand All @@ -95,14 +119,6 @@ export const MobileMenuContent: FunctionComponent = () => {
</MobileMenuItemText>
</RouteLink>
</MobileMenuItem>
<MobileMenuItem>
<Link href='https://www.eclipse.org/donate/openvsx/'>
<MobileMenuItemText>
<StarIcon sx={itemIcon} />
Sponsor
</MobileMenuItemText>
</Link>
</MobileMenuItem>
{
!location.pathname.startsWith(UserSettingsRoutes.ROOT)
? <MobileMenuItem>
Expand Down Expand Up @@ -135,29 +151,62 @@ const headerItem = ({ theme }: { theme: Theme }) => ({
}
});

const headerTypography = ({ theme }: { theme: Theme }) => ({
...headerItem({theme}),
cursor: 'pointer'
});

const MenuLink = styled(Link)(headerItem);
const MenuRouteLink = styled(RouteLink)(headerItem);
const MenuTypography = styled(Typography)(headerTypography);

const subMenuItem = ({ theme }: { theme: Theme }) => ({
'&:focus, &:hover': {
background: 'transparent'
}
});

const subMenuLink = ({ theme }: { theme: Theme }) => ({
...headerItem({theme}),
margin: theme.spacing(0.5)
});

const SubMenuItem = styled(MenuItem)(subMenuItem);
const SubMenuLink = styled(Link)(subMenuLink);


export const DefaultMenuContent: FunctionComponent = () => {
const [workingGroupMenuOpen, setWorkingGroupOpen] = useState(false);
const workingGroupMenuEl = useRef<HTMLButtonElement | null>(null);
const toggleWorkingGroupMenu = () => setWorkingGroupOpen(!workingGroupMenuOpen);
const closeWorkingGroupMenu = () => setWorkingGroupOpen(false);

return <>
<MenuLink href='https://github.com/eclipse/openvsx/wiki'>
Documentation
</MenuLink>
<MenuLink href='https://www.eclipse.org/legal/open-vsx-registry-faq/'>
FAQ
</MenuLink>
<MenuLink href='https://status.open-vsx.org/'>
Status
</MenuLink>
<MenuLink href='https://gitter.im/eclipse/openvsx'>
Community
<MenuTypography onClick={toggleWorkingGroupMenu} ref={workingGroupMenuEl}>Working Group</MenuTypography>
<Menu open={workingGroupMenuOpen} onClose={closeWorkingGroupMenu} anchorEl={workingGroupMenuEl.current}>
<SubMenuItem>
<SubMenuLink href='/members' onClick={closeWorkingGroupMenu}>
Members
</SubMenuLink>
</SubMenuItem>
<SubMenuItem>
<SubMenuLink href='/adopters' onClick={closeWorkingGroupMenu}>
Adopters
</SubMenuLink>
</SubMenuItem>
</Menu>
<MenuLink href='https://www.eclipse.org/donate/openvsx/'>
Sponsor
</MenuLink>
<MenuRouteLink to='/about'>
About
</MenuRouteLink>
<MenuLink href='https://www.eclipse.org/donate/openvsx/'>
Sponsor
</MenuLink>
<Button variant='contained' color='secondary' href='/user-settings/extensions' sx={{ mx: 2.5 }}>
Publish
</Button>
Expand Down
2 changes: 2 additions & 0 deletions website/src/page-settings.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import OpenVSXLogo from './openvsx-registry-logo';
import footerContent from './footer-content';
import { Document } from './document';
import About from './about';
import Adopters from './adopters';
import Members from './members';

export default function createPageSettings(theme: Theme, prefersDarkMode: boolean): PageSettings {
Expand Down Expand Up @@ -64,6 +65,7 @@ export default function createPageSettings(theme: Theme, prefersDarkMode: boolea
<Route path='/terms-of-use' element={<Document url='/documents/terms-of-use.md' />} />
<Route path='/publisher-agreement-v1.0' element={<Document url='/documents/publisher-agreement-v1.0.md' />} />
<Route path='/members' element={<Members />} />
<Route path='/adopters' element={<Adopters />} />
</>;

//---------- REPORT ABUSE LINK
Expand Down

0 comments on commit b909007

Please sign in to comment.