43 Commits

Author SHA1 Message Date
Sybren A. Stüvel
4073c34b0d Website: update another chat link
I missed a link in my previous commit.
2024-08-26 18:05:12 +02:00
Sybren A. Stüvel
8b01012539 Website: document more of the sqlc workflow
Document installation & use of sqlc.

Installing sqlc is only necessary to regenerate the database code. Once
generated, the code is independent of sqlc.
2024-05-30 09:50:17 +02:00
Mateus Abelli
d5977c637b Website: Fix links in Documentation /development/database
This patch fixes what appears to be placeholders for the markdown links of GORM and SQLC.

Reviewed-on: https://projects.blender.org/studio/flamenco/pulls/104309
Reviewed-by: Sybren A. Stüvel <sybren@blender.org>
2024-05-16 08:26:03 +02:00
Mateus Abelli
43a452e940 Website: Update the required Go version to Latest 2024-03-25 15:10:36 +01:00
Sybren A. Stüvel
c046094880 Manager: start replacing GORM with SQLC
GORM has certain downsides:

- Code-first approach, where queries have to be translated to the Go code
  required to execute them.
- GORM comes with its own SQLite implementation, which doesn't provide an
  on-connect callback. This means that new connections cannot correctly
  enable foreign key constraints, causing database consistency issues.

[SQLC](https://sqlc.dev/) solves these issues for us.

This commit doesn't fully replace GORM with SQLC, but introduces it for
a few queries. Once all queries have been converted, GORM can be removed
completely.
2024-03-03 20:15:39 +01:00
Sybren A. Stüvel
17c92e18c7 Website: adjust documentation for the new event bus
Needs more work though. At least now it doesn't point to non-existing
files any more.
2024-02-05 09:27:06 +01:00
Sybren A. Stüvel
a75c8f0835 Bump build requirements to Go 1.21 and NodeJS 18
NodeJS 18 is the current LTS version, and Go 1.21 is the latest release.
2023-10-20 08:39:45 +02:00
Sybren A. Stüvel
02fac6a4df Change Go package name from git.blender.org to projects.blender.org
Change the package base name of the Go code, from
`git.blender.org/flamenco` to `projects.blender.org/studio/flamenco`.

The old location, `git.blender.org`, has no longer been use since the
[migration to Gitea][1]. The new package names now reflect the actual
location where Flamenco is hosted.

[1]: https://code.blender.org/2023/02/new-blender-development-infrastructure/
2023-08-01 12:42:31 +02:00
Sybren A. Stüvel
e8ae0c3cf2 Website: Fix 'report a bug' link 2023-07-24 14:53:18 +02:00
Sybren A. Stüvel
a5e405de16 Web: more SocketIO documentation
Add that the OpenAPI specs also define the structures used for SocketIO
communication.
2023-07-13 10:13:24 +02:00
Sybren A. Stüvel
b83b929e01 Web: add some technical details to the socketIO documentation
Add technical details to explain which part of the SocketIO-based broadcast
system is implemented where in the source code.
2023-07-13 10:08:34 +02:00
Francesco Siddi
9915951007 Deploy: Update deployment instructions
Move sensitive information into a dedicated .env file, which is
required only for deployment purposes.
2023-05-15 20:09:03 +02:00
Sybren A. Stüvel
bbeefd4bfa Website: fix developer 'get started' links
Links of the `[text][linkname]` form should not have a space between
the two bracketed parts. And I removed the link to projects.blender.org
because the other two links also link there (indirectly resp. directly).
2023-05-09 15:36:23 +02:00
Francesco Siddi
6642ad38da Website: Column based layout for the Get Involved page 2023-05-08 14:23:08 +02:00
Francesco Siddi
8da71a323f Website: Content refactor
- Hide sidebar in pages visible in the top nav, except for Docs
- Create an "About" page, featuring the design principles
- Update components illustration
- Move the "What's new in Flamenco 3" page in the FAQ
- Add TOD to the FAQ
- Tweak homepage layout to use two columns
- Styling: slightly reduce max page width (around 12 words per line)
- Styling: tweak padding for titles and paragraphs
2023-05-06 03:34:54 +02:00
Sybren A. Stüvel
3c1871cf0b Web: some rewording & markup changes to 'mission' page
Some rewording & reformatting of the 'mission', and extending the
'development/getting started' page.
2023-05-01 10:56:52 +02:00
Sybren A. Stüvel
2a3356049b Docs: add config param + shortcode for bug reporting button 2023-04-14 11:52:01 +02:00
Sybren A. Stüvel
ea20e94e94 Website: more updates to 'steps to release'
Move the updating of `web/project-website/data/flamenco.yaml` to an earlier
step, so that it's committed & tagged along with the rest of the changes.
2023-02-21 12:17:09 +01:00
Sybren A. Stüvel
a692444fb5 Website: more updates to the 'steps to release'
It now also has a step to update `web/project-website/data/flamenco.yaml`.
2023-02-21 12:14:28 +01:00
Sybren A. Stüvel
9cf34089e4 Website: update steps to release new version
Some steps still expected that the version bump was done with a script
(which hasn't been in use for a while now).
2023-02-21 12:12:31 +01:00
Sybren A. Stüvel
d8ace7b7ff Website: document Go 1.20 is needed 2023-02-20 11:52:35 +01:00
Sybren A. Stüvel
e855d59c68 Website: update Git URLs to projects.blender.org 2023-02-09 15:23:53 +01:00
Sybren A. Stüvel
55bfc8db88 Website: update URLs to point to projects.blender.org 2023-02-07 17:41:26 +01:00
Sybren A. Stüvel
f93c66edb3 Documentation: no longer mention Bootstrap as dependency
The web app doesn't use Bootstrap, so it shouldn't be mentioned in the
docs.
2022-12-06 16:46:14 +01:00
Sybren A. Stüvel
fe8b6e025e Fix link in "Report a Bug" button 2022-11-21 18:14:00 +01:00
Sybren A. Stüvel
75592d12d3 Fix T102188: Add bug reporting URL to Flamenco "Get Involved" page 2022-11-21 18:01:51 +01:00
Sybren A. Stüvel
e700e0efdf Website: move exclamation mark outside of link text 2022-11-11 16:55:14 +01:00
Sybren A. Stüvel
4adff44477 Fix T102193: website, broken link to 'get involved' page 2022-11-11 16:55:02 +01:00
Sybren A. Stüvel
8dd469d51a Website: add FAQ to top menu
This replaces the "Development" link, as "Get Involved" is also about
development already. The "Get Involved" page now links with a CTA button
to the "Development" page.
2022-10-06 15:14:39 +02:00
Sybren A. Stüvel
0863dceedc Website: add step to 'how to release' list
Add a step for updating the CHANGELOG.md file, to mark the version as
released today.
2022-08-31 17:52:44 +02:00
Sybren A. Stüvel
e394e75f64 update-version: also update latest version on project website
`make update-version` now also updates
`web/project-website/data/flamenco.yaml` so that the new version is
listed as the latest one on flamenco.blender.org.

Note that such a change will only be visible online after publishing the
site with `make project-website`. Be sure to only do this after the
build has been uploaded there, to avoid dead links.
2022-08-31 15:14:46 +02:00
Sybren A. Stüvel
f2947cc133 Website: add instructions on how to release a new version of Flamenco 2022-08-31 12:43:16 +02:00
Sybren A. Stüvel
5634ed3a6b Website: some more info about the Windows installation of NodeJS 2022-08-30 17:15:49 +02:00
Sybren A. Stüvel
cbd8754595 Website: add link to 7Zip, necessary to get MingW-W64 installed 2022-08-30 15:43:39 +02:00
Sybren A. Stüvel
c499105424 Website: small wording change 2022-08-30 15:27:21 +02:00
Sybren A. Stüvel
fde1403c22 Website: fix header number 2022-08-30 15:25:30 +02:00
Sybren A. Stüvel
2dccfd195a Website: document how to get make
This is now only written for Debian/Ubuntu and Windows, and not for other
Linux flavours or macOS. Also the Windows documentation is very minimal,
but at least contains the info I always tend to forget.
2022-08-30 15:23:59 +02:00
Francesco Siddi
6612c60943 Website: Tweaks to Get Involved 2022-08-03 13:13:19 +02:00
Sybren A. Stüvel
beb302c2b4 Website: add new 'make' targets to the documentation 2022-08-02 12:05:27 +02:00
Sybren A. Stüvel
b06992a997 Website: start of a "get involved" page 2022-08-02 12:02:12 +02:00
Sybren A. Stüvel
2b11413b76 Website: reformat the "make targets" table
No textual changes.
2022-08-02 12:02:04 +02:00
Sybren A. Stüvel
1db1b06c9e Website: correct the OpenAPI commit guidelines
The OpenAPI-generated code no longer contains the git hash, so the docs
had to change for that.
2022-08-01 16:36:10 +02:00
Francesco Siddi
05e82ea5e4 Website: Update deployment script
The flamenco.io website moves to flamenco.blender.org!
This commit updates the Makefile as follows:

- Rename 'site' to 'project-website', so the new command to deploy is
  'make project-website'
- Move the website directory from 'flamenco-io-site' to
  'project-website'
- Update the rsync command do reflect the new deployment destination
2022-07-25 14:42:30 +02:00