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

feat(website): Add custom gitHub url setting #2797

Merged
merged 9 commits into from
Sep 30, 2024
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
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
3 changes: 3 additions & 0 deletions kubernetes/loculus/templates/_common-metadata.tpl
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,9 @@ fields:
{{- define "loculus.generateWebsiteConfig" }}
name: {{ quote $.Values.name }}
logo: {{ $.Values.logo | toYaml | nindent 6 }}
{{ if $.Values.gitHubMainUrl }}
gitHubMainUrl: {{ quote $.Values.gitHubMainUrl }}
{{ end }}
{{ if $.Values.bannerMessage }}
bannerMessage: {{ quote $.Values.bannerMessage }}
{{ else if or $.Values.runDevelopmentMainDatabase $.Values.runDevelopmentKeycloakDatabase }}
Expand Down
1 change: 1 addition & 0 deletions kubernetes/loculus/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1525,6 +1525,7 @@ replicas:
website: 1
backend: 1
gitHubEditLink: "https://github.com/loculus-project/loculus/edit/main/monorepo/website/"
gitHubMainUrl: https://github.com/loculus-project/loculus
resources:
website:
requests:
Expand Down
11 changes: 9 additions & 2 deletions website/src/components/Navigation/Navigation.astro
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@ import { getAuthUrl } from '../../utils/getAuthUrl';

interface Props {
implicitOrganism?: string;
gitHubMainUrl?: string;
}

const { implicitOrganism } = Astro.props;
const { implicitOrganism, gitHubMainUrl } = Astro.props;
const { organism, knownOrganisms } = cleanOrganism(Astro.params.organism);
const selectedOrganism =
implicitOrganism !== undefined ? knownOrganisms.find((it) => it.key === implicitOrganism) : organism;
Expand All @@ -35,6 +36,12 @@ const loginUrl = await getAuthUrl(Astro.url.toString());
top: '-2rem',
}}
>
<SandwichMenu organism={selectedOrganism} isLoggedIn={isLoggedIn} loginUrl={loginUrl} client:load />
<SandwichMenu
organism={selectedOrganism}
isLoggedIn={isLoggedIn}
gitHubMainUrl={gitHubMainUrl}
loginUrl={loginUrl}
client:load
/>
</div>
</div>
9 changes: 7 additions & 2 deletions website/src/components/Navigation/SandwichMenu.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,10 @@ type SandwichMenuProps = {
organism: Organism | undefined;
isLoggedIn: boolean;
loginUrl: string | undefined;
gitHubMainUrl: string | undefined;
};

export const SandwichMenu: FC<SandwichMenuProps> = ({ organism, isLoggedIn, loginUrl }) => {
export const SandwichMenu: FC<SandwichMenuProps> = ({ organism, isLoggedIn, loginUrl, gitHubMainUrl }) => {
const { isOpen, toggle: toggleMenu, close: closeMenu } = useOffCanvas();

return (
Expand Down Expand Up @@ -50,7 +51,11 @@ export const SandwichMenu: FC<SandwichMenuProps> = ({ organism, isLoggedIn, logi

<div className='mt-auto mb-10'>
<div className='flex justify-end items-center py-5'>
<a href='https://github.com/loculus-project'>
<a
href={
gitHubMainUrl !== undefined ? gitHubMainUrl : 'https://github.com/loculus-project'
}
>
<img src='/github-mark.svg' className='w-8' alt='GitHub logo' />
</a>
</div>
Expand Down
9 changes: 6 additions & 3 deletions website/src/layouts/BaseLayout.astro
theosanderson marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import { navigationItems } from '../routes/navigationItems';
import { BackendClient } from '../services/backendClient';

const websiteConfig = getWebsiteConfig();
const { name: websiteName, logo, bannerMessage, additionalHeadHTML } = websiteConfig;
const { name: websiteName, logo, bannerMessage, additionalHeadHTML, gitHubMainUrl } = websiteConfig;

interface Props {
title: string;
Expand Down Expand Up @@ -72,7 +72,7 @@ const lastTimeBannerWasClosed = Astro.cookies.get('lastTimeBannerWasClosed')?.va
<OrganismSelector implicitOrganism={implicitOrganism} />
</div>
</div>
<Navigation implicitOrganism={implicitOrganism} />
<Navigation implicitOrganism={implicitOrganism} gitHubMainUrl={gitHubMainUrl} />
theosanderson marked this conversation as resolved.
Show resolved Hide resolved
</nav>
<hr class='border-t border-gray-1000' />

Expand All @@ -95,7 +95,10 @@ const lastTimeBannerWasClosed = Astro.cookies.get('lastTimeBannerWasClosed')?.va
}
</div>

<a href='https://github.com/loculus-project' class='h-full py-6'>
<a
href={gitHubMainUrl !== undefined ? gitHubMainUrl : 'https://github.com/loculus-project'}
class='h-full py-6'
>
<img src='/github-mark.svg' class='h-full object-scale-down' alt='github-icon' />
</a>
</footer>
Expand Down
1 change: 1 addition & 0 deletions website/src/types/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,7 @@ export const websiteConfig = z.object({
bannerMessage: z.string().optional(),
additionalHeadHTML: z.string().optional(),
gitHubEditLink: z.string().optional(),
gitHubMainUrl: z.string().optional(),
});
export type WebsiteConfig = z.infer<typeof websiteConfig>;

Expand Down
Loading