Add netlify to README, intro.md and motd.txt

Signed-off-by: Tilman Vatteroth <git@tilmanvatteroth.de>
This commit is contained in:
Tilman Vatteroth 2022-01-11 15:59:03 +01:00
parent c1c457153a
commit cfa03bedf8
6 changed files with 48 additions and 0 deletions

View file

@ -72,3 +72,9 @@ This will build the app in production mode and save it into the `.next` folder.
best performance, minimized and the filenames include a hash value of the content. Don't edit them by hand!
You can run the production build using the built-in server with `yarn start`.
## UI Test
Curious about the new look and feel? We provide a demo of the new UI on [hedgedoc.dev](https://hedgedoc.dev). This version uses mocked data and has no data persistence.
The UI test is hosted by [netlify](https://netlify.com). Please check their [privacy policy](https://netlify.com/privacy) as well as [ours](https://hedgedoc.org/privacy-policy).

13
netlify/intro.md Normal file
View file

@ -0,0 +1,13 @@
<!--
SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
SPDX-License-Identifier: CC-BY-SA-4.0
-->
:::warning
What you see is an UI-Test! It's filled with dummy data, not connected to a backend and no data will be saved.
:::
![HedgeDoc Screenshot](/mock-backend/public/screenshot.png)
[![Deployed using netlify](https://www.netlify.com/img/global/badges/netlify-color-accent.svg)](https://www.netlify.com)

2
netlify/motd.txt Normal file
View file

@ -0,0 +1,2 @@
This demo is hosted by netlify.
Please check their privacy policy (https://netlify.com/privacy) as well as ours (https://hedgedoc.org/privacy-policy).

3
netlify/motd.txt.license Normal file
View file

@ -0,0 +1,3 @@
SPDX-FileCopyrightText: 2021 The HedgeDoc developers (see AUTHORS file)
SPDX-License-Identifier: CC0-1.0

23
netlify/patch-intro.js Normal file
View file

@ -0,0 +1,23 @@
/*
* SPDX-FileCopyrightText: 2022 The HedgeDoc developers (see AUTHORS file)
*
* SPDX-License-Identifier: AGPL-3.0-only
*/
const { copyFile } = require('fs/promises');
console.log("Patch intro.md to include netlify banner.")
copyFile("netlify/intro.md", "public/mock-backend/public/intro.md")
.then(() => console.log("Copied intro.md"))
.catch((error) => {
console.error(error);
process.exit(1);
})
console.log("Patch motd.txt to include privacy policy.")
copyFile("netlify/motd.txt", "public/mock-backend/public/motd.txt")
.then(() => console.log("Copied motd.txt"))
.catch((error) => {
console.error(error);
process.exit(1);
})

View file

@ -4,6 +4,7 @@
"license": "AGPL-3.0",
"scripts": {
"build": "next build",
"build:netlify": "node netlify/patch-intro.js && cross-env NEXT_PUBLIC_IGNORE_IFRAME_ORIGIN_CONFIG=true yarn build:mock",
"build:mock": "cross-env NEXT_PUBLIC_USE_MOCK_API=true next build",
"build:test": "cross-env NEXT_PUBLIC_USE_MOCK_API=true NEXT_PUBLIC_TEST_MODE=true next build",
"analyze": "cross-env ANALYZE=true next build",