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.

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

README: Add Install subsection for keeping up to date. #1031

Merged
merged 1 commit into from
Jun 1, 2021

Conversation

neiljp
Copy link
Collaborator

@neiljp neiljp commented May 13, 2021

This is for the v0 solution at #zulip-terminal>Update alerts (README), namely to document where updates are announced.

I've not seen an obvious way to subscribe to GH or PyPI updates explicitly, so have left it at text for now.

Feedback welcome.

(v1: Add network call to check API updates & warn if out of date, plus note that we call home)
(v2: Add "advanced" config feature to disable calling home?)

@neiljp neiljp added the area: documentation Requires changes in documentation label May 13, 2021
@zulipbot zulipbot added the size: S [Automatic label added by zulipbot] label May 13, 2021
Stable releases are also announced on the #**announce** stream on the Zulip server https://chat.zulip.org, where you are welcome to make an account.

If running from the `main` git branch, note that this does not automatically update, and you must do so manually.
This also applies to other source or development installs, including eg. https://aur.archlinux.org/packages/python-zulip-term-git/
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

ref Arch linux

README.md Outdated
### Keeping your install up to date

Stable releases are made available on PyPI and GitHub; to ensure you keep up to date with them we suggest checking those sites for updates.
Stable releases are also announced on the #**announce** stream on the Zulip server https://chat.zulip.org, where you are welcome to make an account.
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Could note about email alerts from that?

Copy link
Member

Choose a reason for hiding this comment

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

Hmm, the email alerts would be stream wide, so I am not sure completely either.

Copy link
Member

Choose a reason for hiding this comment

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

We could ask users to set an alert word, say ZT release, and adhere to it while posting on the stream.

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I've updated this to mention the expected topic releases will be made in.

@neiljp
Copy link
Collaborator Author

neiljp commented May 15, 2021

@timabbott Was this what you had in mind for v0?

Copy link
Member

@preetmishra preetmishra left a comment

Choose a reason for hiding this comment

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

@neiljp Thanks! Left a comment regarding email notification.

README.md Outdated
### Keeping your install up to date

Stable releases are made available on PyPI and GitHub; to ensure you keep up to date with them we suggest checking those sites for updates.
Stable releases are also announced on the #**announce** stream on the Zulip server https://chat.zulip.org, where you are welcome to make an account.
Copy link
Member

Choose a reason for hiding this comment

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

Hmm, the email alerts would be stream wide, so I am not sure completely either.

README.md Outdated
### Keeping your install up to date

Stable releases are made available on PyPI and GitHub; to ensure you keep up to date with them we suggest checking those sites for updates.
Stable releases are also announced on the #**announce** stream on the Zulip server https://chat.zulip.org, where you are welcome to make an account.
Copy link
Member

Choose a reason for hiding this comment

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

We could ask users to set an alert word, say ZT release, and adhere to it while posting on the stream.

@neiljp neiljp force-pushed the 2021-05-13-updating-zt-notes branch from e2df20c to 3d3c728 Compare June 1, 2021 22:08
@neiljp
Copy link
Collaborator Author

neiljp commented Jun 1, 2021

@preetmishra Thanks for the thoughts - merging this now after the small update to mention the announce topic as we can iterate from here in various ways once we have a good base 👍

@neiljp neiljp merged commit c1977a4 into zulip:main Jun 1, 2021
@neiljp neiljp added this to the Next Release milestone Jun 1, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Requires changes in documentation size: S [Automatic label added by zulipbot]
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants