Skip to content

Commit 211726b

Browse files
authored
Switch docs site to docs.thesis.aet.cit.tum.de custom domain (#1189)
1 parent 6e8d69b commit 211726b

5 files changed

Lines changed: 17 additions & 11 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ Thesis Management was developed as part of multiple bachelor's and master's thes
1212

1313
## Documentation
1414

15-
The full documentation lives at **[ls1intum.github.io/thesis-management](https://ls1intum.github.io/thesis-management/)**. It contains role-based guides with embedded video walk-throughs, permission matrices, workflow diagrams, and everything an operator or developer needs to run the platform.
15+
The full documentation lives at **[docs.thesis.aet.cit.tum.de](https://docs.thesis.aet.cit.tum.de/)**. It contains role-based guides with embedded video walk-throughs, permission matrices, workflow diagrams, and everything an operator or developer needs to run the platform.
1616

17-
- **[Students](https://ls1intum.github.io/thesis-management/students/)** — apply for a topic, book interview slots, write your thesis, and receive your grade.
18-
- **[Supervisors & Examiners](https://ls1intum.github.io/thesis-management/supervisors/)** — create topics, review applications, run interviews, supervise theses, and issue grades. Includes the full [Permissions](https://ls1intum.github.io/thesis-management/supervisors/permissions) matrix and the [Workflows](https://ls1intum.github.io/thesis-management/supervisors/workflows) flowcharts.
19-
- **[Admins](https://ls1intum.github.io/thesis-management/admin/)** — configuration, production setup, and data retention.
20-
- **[Developers](https://ls1intum.github.io/thesis-management/developer/)** — local development, database migrations, mail templates, release workflow, and the API reference.
17+
- **[Students](https://docs.thesis.aet.cit.tum.de/students/)** — apply for a topic, book interview slots, write your thesis, and receive your grade.
18+
- **[Supervisors & Examiners](https://docs.thesis.aet.cit.tum.de/supervisors/)** — create topics, review applications, run interviews, supervise theses, and issue grades. Includes the full [Permissions](https://docs.thesis.aet.cit.tum.de/supervisors/permissions) matrix and the [Workflows](https://docs.thesis.aet.cit.tum.de/supervisors/workflows) flowcharts.
19+
- **[Admins](https://docs.thesis.aet.cit.tum.de/admin/)** — configuration, production setup, and data retention.
20+
- **[Developers](https://docs.thesis.aet.cit.tum.de/developer/)** — local development, database migrations, mail templates, release workflow, and the API reference.
2121

22-
> **Just want a demo?** Run `docker compose -f docker-compose.showcase.yml up -d` and open <http://localhost:3100>. See the [Development Setup](https://ls1intum.github.io/thesis-management/developer/development-setup) guide for details.
22+
> **Just want a demo?** Run `docker compose -f docker-compose.showcase.yml up -d` and open <http://localhost:3100>. See the [Development Setup](https://docs.thesis.aet.cit.tum.de/developer/development-setup) guide for details.
2323
2424
## Building the documentation locally
2525

client/src/core/components/Footer/Footer.tsx

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ import { Link } from 'react-router'
55
import packageJson from '@/../package.json'
66
import { labelByEnvironment } from '@/core/components/EnvironmentBanner/EnvironmentBanner'
77

8+
const DOCS_URL = 'https://docs.thesis.aet.cit.tum.de'
9+
810
const links = [
911
{ link: '/about', label: 'About', visible: true },
1012
{ link: '/imprint', label: 'Imprint', visible: true },
@@ -56,6 +58,9 @@ const Footer = (props: IFooterProps) => {
5658
justify='center'
5759
align='center'
5860
>
61+
<Anchor href={DOCS_URL} target='_blank' c='dimmed'>
62+
Docs
63+
</Anchor>
5964
{links
6065
.filter((link) => link.visible)
6166
.map((link) => (

documentation/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Documentation
22

33
The user-facing documentation site for Thesis Management, built with
4-
[Docusaurus](https://docusaurus.io/). It is published to GitHub Pages at
5-
<https://ls1intum.github.io/thesis-management/>.
4+
[Docusaurus](https://docusaurus.io/). It is published to GitHub Pages under
5+
the custom domain <https://docs.thesis.aet.cit.tum.de/> (see
6+
`static/CNAME`).
67

78
## Prerequisites
89

documentation/docusaurus.config.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,9 @@ const config: Config = {
1515
},
1616

1717
// Set the production url of your site here
18-
url: 'https://ls1intum.github.io',
18+
url: 'https://docs.thesis.aet.cit.tum.de',
1919
// Set the /<baseUrl>/ pathname under which your site is served
20-
// For GitHub pages deployment, it is often '/<projectName>/'
21-
baseUrl: '/thesis-management/',
20+
baseUrl: '/',
2221

2322
// GitHub pages deployment config.
2423
// If you aren't using GitHub pages, you don't need these.

documentation/static/CNAME

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
docs.thesis.aet.cit.tum.de

0 commit comments

Comments
 (0)