From 2373ab1ca74ee8479f9c816f46ad144726a79e22 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mich=C3=A8le=20Legait?= Date: Wed, 29 Jan 2025 21:56:02 +0100 Subject: [PATCH 1/4] Explain admin configuration in README --- README.md | 75 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 75 insertions(+) diff --git a/README.md b/README.md index 77c63be..d08ecff 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,81 @@ And deploy the resulting Debian package on the production server. - Renarde ([guide](https://quarkiverse.github.io/quarkiverse-docs/quarkus-renarde/dev/index.html)): Renarde is a server-side Web Framework based on Quarkus, Qute, Hibernate and RESTEasy Reactive. - Hibernate ORM with Panache ([guide](https://quarkus.io/guides/hibernate-orm-panache)): Simplify your persistence code for Hibernate ORM via the active record or the repository pattern + +## Configuration + +In the admin part (https://\/admin) there is a special table `Configurations`. All the keys are in defined in [`ConfigurationKey.java`](./src/main/java/model/ConfigurationKey.java). + +Here is how to configure it. + +### Launch of the new edition + +When we set up the website for the new edition. + +- `GOOGLE_MAP_API_KEY`: Reuse the same key as for the previous edition +- `EVENT_START_DATE`: Start date of the conference in ISO format. E.g. `2019-05-15T08:20:00` +- `EVENT_START_DATE`: End date of the conference in ISO format: E.g. `2019-05-17T18:00:00` +- `DISPLAY_FULL_SCHEDULE = false`: We don't want to display the schedule because we don't know it yet. +- `DISPLAY_NEW_SPEAKERS = false`: Same as above. +- `DISPLAY_TALKS = false`: Same as above. +- `PROMOTED_PAGE`: It's for the primary button shown on the home page below the logo. The possible values are be `CFP`, `TICKETS` or `SPONSORS`. At this time it's a bit tricky because none of them is available 😅 So let's not use it for now. +- `PROMOTED_PAGE_2`; It's the same as above but for the secondary button. The possible values are `CFP`, `SPONSORS` and `SCHEDULE`. And it's the same, let's not use it for now. +- `TICKETING_URL`: At this time the ticketing is not opened yet, but if we already know the URL, we can fill it. +- `TICKETING_OPEN = false` +- `TICKETING_TRAINING_URL`: To be filled with the URL provided by the training organization, but you probably don't know it yet +- `TICKETING_TRAINING_OPEN = false` The training organization is not ready yet +- `SPONSORING_LEAFLET_URL`: URL to the sponsoring leaflet. +- `CFP_URL`: At this time the CFP is not opened yet, but if we know the URL, we can fill it. +- `CFP_OPEN = false` + +## When the sponsoring leaflet is ready + +- `SPONSORING_LEAFLET_URL`: URL to the sponsoring leaflet if not already filled. +- `PROMOTED_PAGE = 'SPONSORS'` + +## When we open the CFP + +- `CFP_URL`: Fill it if it's not already done. +- `CFP_OPEN = true` +- `PROMOTED_PAGE = CFP` +- `PROMOTED_PAGE_2 = SPONSORS` as soon as the leaflet is ready + +## When we open the ticketing + +- `TICKETING_URL`: Fill it if it's not already done. +- `TICKETING_OPEN = true` + +Don't forget to fill the tables `PricePacks` and `PricePackDates`. + +## When the training organization is ready + +- `TICKETING_TRAINING_URL`: Fill it if it's not already done. +- `TICKETING_TRAINING_OPEN = true` + +## When we close the CFP + +- `CFP_OPEN = false` +- `PROMOTED_PAGE = TICKETS` + +## When some talks and speakers are known + +Before changing the configuration, we need to add some talks and speakers. + +- `DISPLAY_TALKS = true` +- `DISPLAY_NEW_SPEAKERS = true` + +## When the full schedule is known + +- `DISPLAY_FULL_SCHEDULE = true` +- `PROMOTED_PAGE_2 = SCHEDULE` + +## When we close the ticketing + +- `TICKETING_OPEN = true` Yes, you read correctly, we don't change the value. +- Check the checkbox `soldout` in each concerned `PricePacks` +- `PROMOTED_PAGE = SPONSORS` + + ## TODO - On prod, upgrade from postgres 9 to 14 (2024 is on 14, the rest is on 9) From 79dc82ef5e21c7a425c7793d563d898fadafbe78 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mich=C3=A8le=20Legait?= Date: Wed, 29 Jan 2025 22:02:11 +0100 Subject: [PATCH 2/4] Fix admin URL in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index d08ecff..eb2ed73 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ And deploy the resulting Debian package on the production server. ## Configuration -In the admin part (https://\/admin) there is a special table `Configurations`. All the keys are in defined in [`ConfigurationKey.java`](./src/main/java/model/ConfigurationKey.java). +In the admin part (https://\/_renarde/backoffice/index) there is a special table `Configurations`. All the keys are in defined in [`ConfigurationKey.java`](./src/main/java/model/ConfigurationKey.java). Here is how to configure it. From 2f4e1f05c101d8b44164c243da0186952eb378f2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mich=C3=A8le=20Legait?= Date: Wed, 29 Jan 2025 22:33:27 +0100 Subject: [PATCH 3/4] Add details about PROMOTED_PAGE in README --- README.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index eb2ed73..f8e29c4 100644 --- a/README.md +++ b/README.md @@ -68,7 +68,7 @@ When we set up the website for the new edition. - `GOOGLE_MAP_API_KEY`: Reuse the same key as for the previous edition - `EVENT_START_DATE`: Start date of the conference in ISO format. E.g. `2019-05-15T08:20:00` -- `EVENT_START_DATE`: End date of the conference in ISO format: E.g. `2019-05-17T18:00:00` +- `EVENT_END_DATE`: End date of the conference in ISO format: E.g. `2019-05-17T18:00:00` - `DISPLAY_FULL_SCHEDULE = false`: We don't want to display the schedule because we don't know it yet. - `DISPLAY_NEW_SPEAKERS = false`: Same as above. - `DISPLAY_TALKS = false`: Same as above. @@ -82,6 +82,8 @@ When we set up the website for the new edition. - `CFP_URL`: At this time the CFP is not opened yet, but if we know the URL, we can fill it. - `CFP_OPEN = false` +⚠️ `PROMOTED_PAGE` and `PROMOTED_PAGE_2` won't display anything if `EVENT_START_DATE` and `EVENT_END_DATE` are in the past. + ## When the sponsoring leaflet is ready - `SPONSORING_LEAFLET_URL`: URL to the sponsoring leaflet if not already filled. From 044dd12f08cffcb73c0eaf789212072607986d61 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Mich=C3=A8le=20Legait?= Date: Wed, 29 Jan 2025 22:35:35 +0100 Subject: [PATCH 4/4] Minor style improvement in the README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f8e29c4..e88983d 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ And deploy the resulting Debian package on the production server. ## Configuration -In the admin part (https://\/_renarde/backoffice/index) there is a special table `Configurations`. All the keys are in defined in [`ConfigurationKey.java`](./src/main/java/model/ConfigurationKey.java). +In the admin part (`https://\/_renarde/backoffice/index`) there is a special table `Configurations`. All the keys are in defined in [`ConfigurationKey.java`](./src/main/java/model/ConfigurationKey.java). Here is how to configure it.