Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork391
Update the Google Calendar integration doc.#865
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.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
base:main
Are you sure you want to change the base?
Uh oh!
There was an error while loading.Please reload this page.
Conversation
@laurynmm Could you please review this? |
laurynmm left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
@Niloth-p - Thanks for updating this documentation for the updates to this integration! I had some general feedback in an initial read-through. I tried to come at it from the perspective of a person who's not really technical, but who would be interested in this type of integration.
One thing I didn't comment on, but am thinking about is the ordering of where the configuration options information is ... someone implementing this is definitely going to want to review all of that before running the script. Even though it's not the general structure for our docs, I wonder if this should be an instructions section before the one about running the script. I'm not sure though, so maybe focus on the comments below for this pass, and then we can assess how it reads.
Let me know if you have any questions about my review comments below.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Wow, that's a pretty thorough review, thanks a lot! I'm formatting my comments and updates in a single block, because I've clubbed multiple questions with single replies, and also so that these comments don't get submerged as the original comments get outdated. I've absorbed all the phrasing improvements you've suggested. Thank you!
|
"{No title}", "{No description}", "{No location}", and "{No link}" | ||
in the message template. | ||
The default message template takes the following form when all the event |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I plan to update this line to "The example screenshot below uses the default message template, which takes the following form when all the event field variables are non-empty." once we have the screenshot setup done, which ideally shouldn't take too long. But, we still wouldn't want to mention a missing screenshot, so I've phrased it this way for the moment.
laurynmm commentedApr 22, 2025
@Niloth-p - Thanks for making those updates and that comprehensive summary note! I think this is much easier to read and understand now. A few notes I have after reading through the screenshot of the doc above:
###Configuration optionsThe integration can be configured by:- Passing command line arguments to the integration script.- Editing the`google-calendar` section of the`zuliprc` file.The configuration settings in`zuliprc` will be overridden by thecorresponding command line options, if both are used.The integration script accepts the following configuration options:-`interval`: How many minutes in advance you want reminders delivered. The default value is 30 minutes.
|
Niloth-p commentedApr 25, 2025 • edited
Loading Uh oh!
There was an error while loading.Please reload this page.
edited
Uh oh!
There was an error while loading.Please reload this page.
Thanks for the fast review! Sorry for my delay in updating the PR.
|
laurynmm commentedApr 29, 2025
@Niloth-p - Thanks for making those updates! I think these instructions are much clearer, but I haven't gone through the process of setting up the integration to test. I believe that@alya wanted to do that as the next step in the review process, so probably pinging her on CZO for the next round of review makes sense. |
Uh oh!
There was an error while loading.Please reload this page.
Follow-up to the Google Calendar integration updates.
Moved from#32783 following the migration of the Python API integration docs.
Performs a complete re-write of the doc, and is quite different from the version in the previous PR.
Screenshots
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (seecommit discipline).
Completed manual review and testing of the following: