Skip to content

Commit 20e79cd

Browse files
philipsensphilipsens
committed
style: update DocCard links and descriptions, add Insights and Migration Guides
1 parent d71cb04 commit 20e79cd

2 files changed

Lines changed: 180 additions & 157 deletions

File tree

‎docusaurus.config.ts‎

Lines changed: 173 additions & 152 deletions
Original file line numberDiff line numberDiff line change
@@ -5,175 +5,196 @@ import type * as Preset from '@docusaurus/preset-classic';
55
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
66

77
const config: Config = {
8-
title: 'FF! Docs',
9-
tagline: 'The official documentation for the Frank!Framework',
10-
favicon: 'favicons/favicon.ico',
8+
title: 'FF! Docs',
9+
tagline: 'The official documentation for the Frank!Framework',
10+
favicon: 'favicons/favicon.ico',
1111

12-
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
13-
future: {
14-
v4: true, // Improve compatibility with the upcoming Docusaurus v4
15-
},
12+
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
13+
future: {
14+
v4: true, // Improve compatibility with the upcoming Docusaurus v4
15+
},
1616

17-
// Set the production url of your site here
18-
url: 'https://docs.frankframework.org',
19-
// Set the /<baseUrl>/ pathname under which your site is served
20-
// For GitHub pages deployment, it is often '/<projectName>/'
21-
baseUrl: '/',
17+
// Set the production url of your site here
18+
url: 'https://docs.frankframework.org',
19+
// Set the /<baseUrl>/ pathname under which your site is served
20+
// For GitHub pages deployment, it is often '/<projectName>/'
21+
baseUrl: '/',
2222

23-
// GitHub pages deployment config.
24-
// If you aren't using GitHub pages, you don't need these.
25-
organizationName: 'frankframework', // Usually your GitHub org/user name.
26-
projectName: 'frankframework', // Usually your repo name.
23+
// GitHub pages deployment config.
24+
// If you aren't using GitHub pages, you don't need these.
25+
organizationName: 'frankframework', // Usually your GitHub org/user name.
26+
projectName: 'frankframework', // Usually your repo name.
2727

28-
onBrokenLinks: 'throw',
28+
onBrokenLinks: 'throw',
2929

30-
markdown: {
31-
hooks: {
32-
onBrokenMarkdownLinks: 'warn',
30+
markdown: {
31+
hooks: {
32+
onBrokenMarkdownLinks: 'warn',
33+
},
3334
},
34-
},
3535

36-
// Even if you don't use internationalization, you can use this field to set
37-
// useful metadata like html lang. For example, if your site is Chinese, you
38-
// may want to replace "en" with "zh-Hans".
39-
i18n: {
40-
defaultLocale: 'en',
41-
locales: ['en'],
42-
},
36+
// Even if you don't use internationalization, you can use this field to set
37+
// useful metadata like html lang. For example, if your site is Chinese, you
38+
// may want to replace "en" with "zh-Hans".
39+
i18n: {
40+
defaultLocale: 'en',
41+
locales: ['en'],
42+
},
4343

44-
presets: [
45-
[
46-
'classic',
47-
{
48-
docs: {
49-
sidebarPath: './sidebars.ts',
50-
// Please change this to your repo.
51-
// Remove this to remove the "edit this page" links.
52-
editUrl:
53-
'https://github.com/frankframework/docs/edit/master/',
54-
},
55-
theme: {
56-
customCss: './src/css/custom.css',
57-
},
58-
} satisfies Preset.Options,
44+
presets: [
45+
[
46+
'classic',
47+
{
48+
docs: {
49+
sidebarPath: './sidebars.ts',
50+
// Please change this to your repo.
51+
// Remove this to remove the "edit this page" links.
52+
editUrl:
53+
'https://github.com/frankframework/docs/edit/master/',
54+
},
55+
theme: {
56+
customCss: './src/css/custom.css',
57+
},
58+
} satisfies Preset.Options,
59+
],
5960
],
60-
],
6161

62-
themeConfig: {
63-
// Replace with your project's social card
64-
image: 'img/docusaurus-social-card.jpg',
65-
colorMode: {
66-
respectPrefersColorScheme: true,
67-
},
68-
navbar: {
69-
logo: {
70-
alt: 'FF!',
71-
src: 'img/ff!-icon-yellow.svg',
72-
},
73-
title: 'docs',
74-
hideOnScroll: true,
75-
items: [
76-
{
77-
type: 'docSidebar',
78-
sidebarId: 'getStartedSidebar',
79-
position: 'left',
80-
label: 'Get Started',
62+
themeConfig: {
63+
// Replace with your project's social card
64+
image: 'img/docusaurus-social-card.jpg',
65+
colorMode: {
66+
respectPrefersColorScheme: true,
8167
},
82-
{
83-
type: 'docSidebar',
84-
sidebarId: 'manualSidebar',
85-
position: 'left',
86-
label: 'Manual',
68+
navbar: {
69+
logo: {
70+
alt: 'FF!',
71+
src: 'img/ff!-icon-yellow.svg',
72+
},
73+
title: 'docs',
74+
hideOnScroll: true,
75+
items: [
76+
{
77+
type: 'docSidebar',
78+
sidebarId: 'getStartedSidebar',
79+
position: 'left',
80+
label: 'Get Started',
81+
},
82+
{
83+
type: 'docSidebar',
84+
sidebarId: 'manualSidebar',
85+
position: 'left',
86+
label: 'Manual',
87+
},
88+
{href: 'https://reference.frankframework.org/', label: 'Reference', position: 'left'},
89+
{
90+
type: 'dropdown',
91+
label: 'Other resources',
92+
position: 'left',
93+
items: [
94+
{href: 'https://insights.frankframework.org/', label: 'Insights'},
95+
{label: '[Upcomming] Migration Guides', href: '#'},
96+
{href: 'https://frankacademy.nl/', label: 'Frank!Academy'},
97+
],
98+
},
99+
{
100+
href: 'https://github.com/frankframework',
101+
label: 'GitHub',
102+
position: 'right',
103+
},
104+
],
87105
},
88-
{href: 'https://reference.frankframework.org/', label: 'Reference', position: 'left'},
89-
{href: 'https://frankacademy.nl/', label: 'Frank!Academy', position: 'left'},
90-
{
91-
href: 'https://github.com/frankframework',
92-
label: 'GitHub',
93-
position: 'right',
106+
footer: {
107+
links: [
108+
{
109+
title: 'Documentation',
110+
items: [
111+
{
112+
label: 'Get Started',
113+
to: '/docs/get-started',
114+
},
115+
{
116+
label: 'Manual',
117+
to: '/docs/manual',
118+
},
119+
{
120+
label: 'Legacy Frank!Manual',
121+
href: 'https://frank-manual.readthedocs.io/',
122+
},
123+
{
124+
label: 'Reference',
125+
href: 'https://reference.frankframework.org/',
126+
},
127+
{
128+
label: 'Javadoc',
129+
href: 'https://javadoc.frankframework.org/',
130+
},
131+
],
132+
},
133+
{
134+
title: 'Other resources',
135+
items: [
136+
{
137+
label: 'Insights',
138+
href: 'https://insights.frankframework.org/',
139+
},
140+
{
141+
label: 'Frank!Academy',
142+
href: 'https://frankacademy.nl/',
143+
},
144+
{
145+
label: '[Upcomming] Migration Guides',
146+
href: '#',
147+
},
148+
],
149+
},
150+
{
151+
title: 'More',
152+
items: [
153+
{
154+
label: 'FF! Website',
155+
href: 'https://frankframework.org',
156+
},
157+
{
158+
label: 'GitHub',
159+
href: 'https://github.com/frankframework',
160+
},
161+
{
162+
label: 'GitHub Discussions',
163+
href: 'https://github.com/frankframework/frankframework/discussions',
164+
},
165+
{
166+
label: 'Nexus',
167+
href: 'https://nexus.frankframework.org/',
168+
},
169+
{
170+
label: 'Docker Hub',
171+
href: 'https://hub.docker.com/r/frankframework/frankframework',
172+
},
173+
],
174+
},
175+
],
176+
copyright: `© ${new Date().getFullYear()} Frank!Framework &bull; <a target="_blank" href="https://github.com/frankframework/docs">Docs Source</a>`,
94177
},
95-
],
96-
},
97-
footer: {
98-
links: [
99-
{
100-
title: 'Documentation',
101-
items: [
102-
{
103-
label: 'Get Started',
104-
to: '/docs/get-started',
105-
},
106-
{
107-
label: 'Manual',
108-
to: '/docs/manual',
109-
},
110-
{
111-
label: 'Old Frank!Manual',
112-
href: 'https://frank-manual.readthedocs.io/',
113-
},
114-
{
115-
label: 'Reference',
116-
href: 'https://reference.frankframework.org/',
117-
},
118-
{
119-
label: 'Javadoc',
120-
href: 'https://javadoc.frankframework.org/',
121-
},
122-
],
178+
algolia: {
179+
appId: 'H18WHKAMRM',
180+
// Public API key: it is safe to commit it
181+
apiKey: '22bd7a1f4a7ec802a49375757a7af7c1',
182+
indexName: 'FF! Docs',
183+
// Context filters will filter out the external sites. So I disabled it. We can enable it in the future but will have to make a recordExtractor.
184+
contextualSearch: false,
185+
externalUrlRegex: 'frank-manual\\.readthedocs\\.io',
123186
},
124-
{
125-
title: 'Community',
126-
items: [
127-
{
128-
label: 'GitHub Discussions',
129-
href: 'https://github.com/frankframework/frankframework/discussions',
130-
},
131-
],
187+
prism: {
188+
theme: prismThemes.github,
189+
darkTheme: prismThemes.dracula,
132190
},
133-
{
134-
title: 'More',
135-
items: [
136-
{
137-
label: 'Frank!Framework',
138-
href: 'https://frankframework.org',
139-
},
140-
{
141-
label: 'GitHub',
142-
href: 'https://github.com/frankframework',
143-
},
144-
{
145-
label: 'Docker Hub',
146-
href: 'https://hub.docker.com/r/frankframework/frankframework',
147-
},
191+
metadata: [
148192
{
149-
label: 'Frank!Academy',
150-
href: 'https://frankacademy.nl/',
193+
name: 'algolia-site-verification',
194+
content: '2D87C4BF471503E1',
151195
},
152-
],
153-
},
154-
],
155-
copyright: `© ${new Date().getFullYear()} Frank!Framework`,
156-
},
157-
algolia: {
158-
appId: 'H18WHKAMRM',
159-
// Public API key: it is safe to commit it
160-
apiKey: '22bd7a1f4a7ec802a49375757a7af7c1',
161-
indexName: 'FF! Docs',
162-
// Context filters will filter out the external sites. So I disabled it. We can enable it in the future but will have to make a recordExtractor.
163-
contextualSearch: false,
164-
externalUrlRegex: 'frank-manual\\.readthedocs\\.io',
165-
},
166-
prism: {
167-
theme: prismThemes.github,
168-
darkTheme: prismThemes.dracula,
169-
},
170-
metadata: [
171-
{
172-
name: 'algolia-site-verification',
173-
content: '2D87C4BF471503E1',
174-
},
175-
],
176-
} satisfies Preset.ThemeConfig,
196+
],
197+
} satisfies Preset.ThemeConfig,
177198
};
178199

179200
export default config;

‎src/components/HomepageResources/index.tsx‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,18 @@
11
import type {ReactNode} from 'react';
22
import styles from './styles.module.css';
3-
import DocCard from "@site/src/components/DocCard";
3+
import DocCard from '@site/src/components/DocCard';
44

55
export default function Resources(): ReactNode {
66
return (
77
<section className={styles.resources}>
88
<div className="container">
99
<div className="row">
10-
<DocCard href='/docs/get-started' title='Get Started' icon='➡️' description='Get up and running with Frank!Framework in minutes.' />
11-
<DocCard href='/docs/manual' title='Manual' icon='📚' description='Documentation about configuration, deployment, testing and operation.' />
12-
<DocCard href='https://reference.frankframework.org/' title='Reference' icon='🔣' description='Technical documentation of FF! components.' />
13-
<DocCard href='https://frankacademy.nl/' title='Frank!Academy' icon='🎓' description='Free training and certification by WeAreFrank!.' />
10+
<DocCard href="/docs/get-started" title="Get Started"icon="➡️" description="Get up and running with Frank!Framework in minutes" />
11+
<DocCard href="/docs/manual" title="Manual" icon="📚" description="Documentation about configuration, deployment, testing and operation" />
12+
<DocCard href="https://reference.frankframework.org/" title="Reference" icon="🔣" description="Technical documentation of FF! components" />
13+
<DocCard href="https://insights.frankframework.org/" title="Insights" icon="🔍" description="Insights about implemented features, the roadmap and CVE's" />
14+
<DocCard href="https://frankacademy.nl/" title="Frank!Academy" icon="🎓" description="Free training and certification by WeAreFrank!" />
15+
<DocCard href="#" title="[Upcomming] Migration Guides" icon="✨" description="Notable changes and migrations guides"/>
1416
</div>
1517
</div>
1618
</section>

0 commit comments

Comments
 (0)