Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update app references to Eventyay in documentation #524

Merged
merged 1 commit into from
Jan 25, 2025
Merged

Update app references to Eventyay in documentation #524

merged 1 commit into from
Jan 25, 2025

Conversation

Daksh2000
Copy link
Contributor

@Daksh2000 Daksh2000 commented Jan 25, 2025 •
edited by mariobehling
Loading

I have limited my changes to doc/ folder only and in some files in doc/ , like in development/ , admin/ and other folders as well
that required either some python package reference to pretix or source code reference to pretix (in src/) , I didn't change that as of now, is that change also required ? because then that would require to change the file names as well and multiple changes there on
Please share your views

Partly resolves #514

Summary by Sourcery

Documentation:

  • Updated documentation to refer to "eventyay" instead of "pretix".

@sourcery-ai Sourcery AI
Copy link

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

Reviewer's Guide by Sourcery

This pull request replaces all occurrences of "pretix" with "eventyay" in the documentation files. This change is primarily focused on updating the product name within the documentation to reflect the rebranding.

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

File-Level Changes

Change Details Files
Replaced 'pretix' with 'eventyay' in documentation files.
  • Updated the main heading to reflect the new product name.
  • Modified the introductory paragraph to mention 'eventyay' instead of 'pretix'.
  • Updated the link to the issue tracker to point to the new repository.
  • Changed the administrator documentation description to mention 'eventyay'.
  • Modified the developer documentation description to mention 'eventyay'.
  • Updated the link to the GitHub repository to point to the new repository.
  • Updated the link to the project blog to point to the new blog.
  • Updated the link to the Twitter account to point to the new account.
 doc/_templates/index.html
Replaced 'pretix' with 'eventyay' in various documentation files.
  • Replaced all occurrences of 'pretix' with 'eventyay'.
 doc/plugins/webinar.rst
doc/user/events/create.rst
doc/user/events/email.rst
doc/user/events/giftcards.rst
doc/user/events/guides/timeslots.rst
doc/user/events/invoicing.rst
doc/user/events/plugins.rst
doc/user/events/structureguide.rst
doc/user/events/taxes.rst
doc/user/events/ticket_secrets.rst
doc/user/events/tickets.rst
doc/user/faq.rst
doc/user/glossary.rst
doc/user/index.rst
doc/user/markdown.rst
doc/user/organizers/account.rst
doc/user/organizers/domain.rst
doc/user/organizers/teams.rst
doc/user/payments/fees.rst
doc/user/payments/overview.rst
doc/user/payments/paypal.rst
doc/user/payments/settings.rst
doc/user/payments/stripe.rst
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

sourcery-ai[bot]
sourcery-ai bot reviewed Jan 25, 2025
View reviewed changes
Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Overall Comments:

  • There's an inconsistency in the admin docs section where 'pretix' is still mentioned: 'Find out how to install eventyay on your own server and how to maintain an installation of pretix'
  • Regarding your question - please keep this PR focused on user-facing documentation changes only. Source code and package references should be handled in a separate PR after careful review and testing.
Here's what I looked at during the review
  • 🟡 General issues: 4 issues 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.

doc/user/glossary.rst Show resolved Hide resolved
doc/user/events/ticket_secrets.rst Show resolved Hide resolved
doc/user/payments/paypal.rst Show resolved Hide resolved
doc/user/events/email.rst Show resolved Hide resolved
@mariobehling mariobehling changed the title "Pretix" -> "Eventyay" (In Docs) Update app references to Eventyay in documentation Jan 25, 2025
@mariobehling mariobehling requested a review from hongquan January 25, 2025 10:58
@mariobehling mariobehling merged commit 471baf4 into fossasia:development Jan 25, 2025
4 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sourcery-ai sourcery-ai[bot] sourcery-ai[bot] left review comments

@hongquan hongquan Awaiting requested review from hongquan

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Adjust design of documentation
3 participants
@Daksh2000 @mariobehling @dakshbhayana11811137