Help: Add documentation for installation through Flathub. #28556

nimishmedatwal · 2024-01-12T17:05:37Z

Adds documentation for installing zulip through Flathub in https://zulip.com/help/desktop-app-install-guide.
Fixes: #28508

Screenshots and screen captures:

Self-review checklist

Self-reviewed the changes for clarity and maintainability
(variable names, code reuse, readability, etc.).

Communicate decisions, questions, and potential concerns.

Explains differences from previous plans (e.g., issue description).
Highlights technical choices and bugs encountered.
Calls out remaining decisions and concerns.
Automated tests verify logic where appropriate.

Individual commits are ready for review (see commit discipline).

Each commit is a coherent idea.
Commit message(s) explain reasoning and motivation for changes.

Completed manual review and testing of the following:

Visual appearance of the changes.
Responsiveness and internationalization.
Strings and tooltips.
End-to-end functionality of buttons, interactions and flows.
Corner cases, error conditions, and easily imagined bugs.

zulipbot · 2024-01-12T17:05:47Z

Hello @zulip/server-misc, @zulip/server-user-docs members, this pull request was labeled with the "area: documentation (user)", "area: portico" labels, so you may want to check it out!

nimishmedatwal · 2024-01-15T18:33:37Z

web/src/sentry.ts

These changes were made by running ./tools/lint --fix and are not related to the pr.

nimishmedatwal · 2024-01-15T18:33:43Z

web/src/favicon.ts

These changes were made by running ./tools/lint --fix and are not related to the pr.

nimishmedatwal · 2024-01-15T18:33:51Z

tools/check-openapi

These changes were made by running ./tools/lint --fix and are not related to the pr.

timabbott · 2024-01-16T01:31:14Z

@drrosa can you review this one?

drrosa

@nimishmedatwal Thanks for working on this! I left a few comments below.

I am not sure why ./tools/lint --fix made changes to a few unrelated files. I ran ./tools/lint on my end, and it didn't show any errors. Try reverting the changes in these files, then git fetch / git rebase your PR to make sure your branch is up to date with the main branch, and run the linter again.

drrosa · 2024-01-24T07:23:01Z

tools/linter_lib/custom_check.py

@@ -870,6  870,20 @@
            "description": "Likely missing space after end of sentence",
            "include_only": {"help/"},
            "exclude_pattern": "Rocket.Chat",


I think it would be cleaner to add org.zulip.Zulip to the "exclude_pattern", and drop the whole "exclude_line" part.

Suggested change

"exclude_pattern": "Rocket.Chat",

"exclude_pattern": "Rocket.Chat|org.zulip.Zulip",

drrosa · 2024-01-24T07:35:04Z

help/desktop-app-install-guide.md

+#### Flathub
+
+1. Make sure you have [Flatpak](https://flathub.org/setup) installed on your system.
+
+2. Use the following command to install Zulip from Flathub:
+
+        flatpak install flathub org.zulip.Zulip
+
+
+3. After the installation is complete, you can run Zulip using the following command:
+
+        flatpak run org.zulip.Zulip
+
+
+You can always check the official [Flathub page](https://flathub.org/apps/org.zulip.Zulip) for installation.
+
 <!-- TODO why dpkg? -->


The formatting of this instructions block needs to be tweaked a bit. There shouldn't be any extra blank lines before or after each step, and each line shouldn't exceed 80 characters. Also, it's probably safe to remove the  comment which seems to have been left over a while back.

drrosa · 2024-01-24T07:46:30Z

help/desktop-app-install-guide.md

+
+1. Make sure you have [Flatpak](https://flathub.org/setup) installed on your system.
+
+2. Use the following command to install Zulip from Flathub:


Maybe tweak this step and drop the last line "You can always check the official...."

Suggested change

2. Use the following command to install Zulip from Flathub:

2. Use the following command from the official

[Flathub page](https://flathub.org/apps/org.zulip.Zulip) to install Zulip:

drrosa · 2024-01-25T04:13:41Z

Also, instead of "documentation:", we use "help:" in commit messages and PR titles as a convention for help center issues.

Fixes zulip#28508

nimishmedatwal · 2024-01-25T10:18:43Z

@drrosa Updated!

drrosa

These updates look good to me!

drrosa · 2024-01-26T03:18:16Z

@zulipbot remove "documentation review"
@zulipbot add "integration review"

zulipbot added size: S area: documentation (user) area: portico labels Jan 12, 2024

nimishmedatwal force-pushed the issue#28508 branch from 6366f78 to 4a87491 Compare January 14, 2024 08:57

nimishmedatwal marked this pull request as draft January 14, 2024 08:58

nimishmedatwal force-pushed the issue#28508 branch from 4a87491 to 3fbb9ee Compare January 15, 2024 17:22

zulipbot added size: L and removed size: S labels Jan 15, 2024

nimishmedatwal marked this pull request as ready for review January 15, 2024 17:24

nimishmedatwal commented Jan 15, 2024

View reviewed changes

web/src/sentry.ts Outdated

Copy link

Collaborator Author

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

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

These changes were made by running ./tools/lint --fix and are not related to the pr.

nimishmedatwal commented Jan 15, 2024

View reviewed changes

web/src/favicon.ts Outdated

Copy link

Collaborator Author

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

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

These changes were made by running ./tools/lint --fix and are not related to the pr.

nimishmedatwal commented Jan 15, 2024

View reviewed changes

tools/check-openapi Outdated

Copy link

Collaborator Author

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

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

These changes were made by running ./tools/lint --fix and are not related to the pr.

timabbott added the documentation review Documentation review needed. label Jan 16, 2024

drrosa suggested changes Jan 24, 2024

View reviewed changes

nimishmedatwal force-pushed the issue#28508 branch from 3fbb9ee to cef8d7a Compare January 25, 2024 03:38

zulipbot added size: S and removed size: L labels Jan 25, 2024

nimishmedatwal force-pushed the issue#28508 branch 2 times, most recently from d1741d6 to 4918196 Compare January 25, 2024 10:14

nimishmedatwal changed the title ~~Documentation: Add documentation for installation through Flathub.~~ Help: Add documentation for installation through Flathub. Jan 25, 2024

help: Add installation through Flathub.

434a5e2

Fixes zulip#28508

nimishmedatwal force-pushed the issue#28508 branch from 4918196 to 434a5e2 Compare January 25, 2024 10:18

nimishmedatwal requested a review from drrosa January 25, 2024 10:18

drrosa approved these changes Jan 26, 2024

View reviewed changes

zulipbot removed the documentation review Documentation review needed. label Jan 26, 2024

zulipbot added the integration review Added by maintainers when a PR may be ready for integration. label Jan 26, 2024

timabbott merged commit 5e2d620 into zulip:main Jan 26, 2024
19 checks passed

timabbott mentioned this pull request Jan 26, 2024

Added Flathub installation instruction and added Import from Self-Hosted Zulip to Zulip Cloud #28555

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Help: Add documentation for installation through Flathub. #28556

Help: Add documentation for installation through Flathub. #28556

nimishmedatwal commented Jan 12, 2024 •

edited

Loading

zulipbot commented Jan 12, 2024

nimishmedatwal Jan 15, 2024

nimishmedatwal Jan 15, 2024

nimishmedatwal Jan 15, 2024

timabbott commented Jan 16, 2024

drrosa left a comment

drrosa Jan 24, 2024

drrosa Jan 24, 2024

drrosa Jan 24, 2024

drrosa commented Jan 25, 2024

nimishmedatwal commented Jan 25, 2024

drrosa left a comment •

edited

Loading

drrosa commented Jan 26, 2024

	"exclude_pattern": "Rocket.Chat",
	"exclude_pattern": "Rocket.Chat\|org.zulip.Zulip",


		1. Make sure you have [Flatpak](https://flathub.org/setup) installed on your system.

		2. Use the following command to install Zulip from Flathub:

	2. Use the following command to install Zulip from Flathub:
	2. Use the following command from the official
	[Flathub page](https://flathub.org/apps/org.zulip.Zulip) to install Zulip:

Help: Add documentation for installation through Flathub. #28556

Help: Add documentation for installation through Flathub. #28556

Conversation

nimishmedatwal commented Jan 12, 2024 • edited Loading

zulipbot commented Jan 12, 2024

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

nimishmedatwal Jan 15, 2024

Choose a reason for hiding this comment

timabbott commented Jan 16, 2024

drrosa left a comment

Choose a reason for hiding this comment

drrosa Jan 24, 2024

Choose a reason for hiding this comment

drrosa Jan 24, 2024

Choose a reason for hiding this comment

drrosa Jan 24, 2024

Choose a reason for hiding this comment

drrosa commented Jan 25, 2024

nimishmedatwal commented Jan 25, 2024

drrosa left a comment • edited Loading

Choose a reason for hiding this comment

drrosa commented Jan 26, 2024

nimishmedatwal commented Jan 12, 2024 •

edited

Loading

drrosa left a comment •

edited

Loading