adjust design of documentation #309

r3yc0n1c · 2025-01-26T14:32:10Z

Resolves #305

Summary

Please use the same theme with the eventyay colors and logo as eventyay-tickets.

Then adjust the design of the documentation as follows:

Screenshot

Summary by Sourcery

Documentation:

Update documentation theme, content, and links to align with the Eventyay brand.

sourcery-ai · 2025-01-26T14:32:15Z

Reviewer's Guide by Sourcery

This pull request focuses on updating the documentation's design to align with the eventyay brand. It includes changes to the theme, content, and links to ensure consistency with the eventyay ecosystem.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change	Details	Files
Updated the documentation's theme to match the eventyay brand.	Added custom CSS for frontpage layout. Updated the project name to 'eventyay-video'. Updated the copyright notice to include the Apache 2.0 license and contributors link. Set the theme to 'sphinx_rtd_theme'. Updated the logo and favicon to eventyay's. Added custom CSS file.	`docs/_static/custom.css` `docs/conf.py`
Replaced all instances of 'venueless' with 'eventyay'.	Replaced 'venueless' with 'eventyay' in the project configuration. Replaced 'venueless' with 'eventyay' in all documentation files.	`docs/conf.py` `docs/admin/index.rst` `docs/admin/management.rst` `docs/admin/setup.rst` `docs/admin/webapp-config.rst` `docs/developer/api/bbb.rst` `docs/developer/api/config.rst` `docs/developer/api/index.rst` `docs/developer/api/permissions.rst` `docs/developer/api/user.rst` `docs/developer/index.rst` `docs/developer/performance.rst` `docs/developer/setup.rst` `docs/index.rst` `docs/integration/authentication.rst` `docs/integration/iframe.rst` `docs/integration/index.rst` `docs/rest/fundamentals.rst` `docs/rest/resources/room.rst` `docs/rest/resources/world.rst`
Adjusted the documentation's content and links.	Updated the welcome message. Changed the blog link to eventyay's blog. Updated the GitHub link to eventyay's repository. Updated the Twitter link to eventyay's Twitter account. Updated the 'let us know' link to eventyay's issue tracker. Added a custom footer layout. Added a dynamic date for the copyright notice. Added a custom index file similar to eventyay-tickets.	`docs/conf.py` `docs/index.rst` `docs/_templates/index.html` `docs/_templates/footer.html`

Assessment against linked issues

Issue	Objective	Addressed
#305	Change the name 'venueless' to 'eventyay' everywhere	✅
#305	Update documentation theme and branding to use eventyay colors, logo, and styling	✅
#305	Update links and references to point to eventyay project resources	✅

Possibly linked issues

Adjust design of documentation #305: The PR implements all the changes requested in the issue, including design adjustments, link updates, and content changes.

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!
Generate a plan of action for an issue: Comment @sourcery-ai plan on
an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey @r3yc0n1c - I've reviewed your changes - here's some feedback:

Overall Comments:

Please verify that all new links (blog.eventyay.com, Twitter, etc.) are working correctly before merging.

Here's what I looked at during the review

🟡 General issues: 1 issue found
🟢 Security: all looks good
🟢 Testing: all looks good
🟢 Complexity: all looks good
🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

docs/developer/setup.rst

mariobehling · 2025-01-26T19:58:36Z

docs/_templates/index.html

+    </div>
+    <div class="wy-sectionbox">
+        <div class="wy-icon">
+            <a href="https://twitter.com/eventyay" target="_blank">


Sorry, my bad. Please change it to x.com/eventyay

mariobehling · 2025-01-26T19:58:59Z

docs/_templates/index.html

+    <div class="wy-sectionbox">
+        <div class="wy-icon">
+            <a href="https://twitter.com/eventyay" target="_blank">
+                <span class="fa fa-twitter fa-fw"></span>


also use x here

mariobehling · 2025-01-26T20:00:14Z

docs/admin/setup.rst


-    # mkdir /var/venueless-data
-    # chown -R 15371:15371 /var/venueless-data
+    # mkdir /var/eventyay-video-data


This needs to be tested first.

mariobehling · 2025-01-26T20:00:17Z

docs/admin/setup.rst

-    # sudo -u postgres createuser -P venueless
-    # sudo -u postgres createdb -O venueless venueless
+    # sudo -u postgres createuser -P eventyay-video
+    # sudo -u postgres createdb -O eventyay-video eventyay-video


we probably need to verify this first.

mariobehling · 2025-01-26T20:00:42Z

docs/admin/setup.rst

@@ -96,23 +96,23 @@ Now restart redis-server::
 Config file
 -----------

-We now create a config directory and config file for venueless::
+We now create a config directory and config file for eventyay-video::


hm. all this needs to be verified first.

mariobehling

Please also change red colored headings to eventyay-blue and black background on the left to the light-blue of eventyay.

mariobehling · 2025-01-27T07:39:05Z

The CNAME is written to the dev branch. On merge the CNAME should always be written to the gh-pages branch.

r3yc0n1c · 2025-01-31T21:56:22Z

Please also change red colored headings to eventyay-blue and black background on the left to the light-blue of eventyay.

please share the color palette/codes for this. I've updated the eventyay-blue but couldn't find the light-blue. For now, I've followed the eventyay-tickets scheme... let me know how it looks.

r3yc0n1c · 2025-01-31T22:03:55Z

The CNAME is written to the dev branch. On merge the CNAME should always be written to the gh-pages branch.

fixed, I'll update the other workflows as well

r3yc0n1c added 2 commits January 19, 2025 22:39

create docs deploy workflow

7326489

Merge branch 'fossasia:development' into development

1683f68

sourcery-ai bot reviewed Jan 26, 2025

View reviewed changes

docs/developer/setup.rst Outdated Show resolved Hide resolved

adjust design of documentation

9515336

r3yc0n1c force-pushed the development branch from aff654c to 9515336 Compare January 26, 2025 14:34

mariobehling requested changes Jan 26, 2025

View reviewed changes

fixed color scheme, org email, twitter link, CNAME to gh-pages

a8c3a4f

r3yc0n1c force-pushed the development branch from ae6211a to a8c3a4f Compare January 31, 2025 22:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adjust design of documentation #309

adjust design of documentation #309

r3yc0n1c commented Jan 26, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jan 26, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

mariobehling Jan 26, 2025

r3yc0n1c Jan 31, 2025

mariobehling Jan 26, 2025

r3yc0n1c Jan 31, 2025

mariobehling Jan 26, 2025

mariobehling Jan 26, 2025

mariobehling Jan 26, 2025

mariobehling left a comment

mariobehling commented Jan 27, 2025

r3yc0n1c commented Jan 31, 2025

r3yc0n1c commented Jan 31, 2025

adjust design of documentation #309

Are you sure you want to change the base?

adjust design of documentation #309

Conversation

r3yc0n1c commented Jan 26, 2025 • edited by sourcery-ai bot Loading

Summary

Screenshot

Summary by Sourcery

sourcery-ai bot commented Jan 26, 2025 • edited Loading

Reviewer's Guide by Sourcery

File-Level Changes

Assessment against linked issues

Possibly linked issues

Interacting with Sourcery

Customizing Your Experience

Getting Help

sourcery-ai bot left a comment

Choose a reason for hiding this comment

mariobehling Jan 26, 2025

Choose a reason for hiding this comment

r3yc0n1c Jan 31, 2025

Choose a reason for hiding this comment

mariobehling Jan 26, 2025

Choose a reason for hiding this comment

r3yc0n1c Jan 31, 2025

Choose a reason for hiding this comment

mariobehling Jan 26, 2025

Choose a reason for hiding this comment

mariobehling Jan 26, 2025

Choose a reason for hiding this comment

mariobehling Jan 26, 2025

Choose a reason for hiding this comment

mariobehling left a comment

Choose a reason for hiding this comment

mariobehling commented Jan 27, 2025

r3yc0n1c commented Jan 31, 2025

r3yc0n1c commented Jan 31, 2025

r3yc0n1c commented Jan 26, 2025 •

edited by sourcery-ai bot

Loading

sourcery-ai bot commented Jan 26, 2025 •

edited

Loading