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

Add a new "end user documentation" page #226

Closed
wants to merge 1 commit into from

Conversation

WhyNotHugo
Copy link

@WhyNotHugo WhyNotHugo commented Dec 10, 2020

Current documentation mainly targets packagers and developers. Through
conversations in GitHub, different requirements have come up that aren't
really documented anywhere.

The intention of this new page is to document everything that a user
needs to install flatpak and run flatpak applications.

In reality, this is mostly for technical users setting up their own
environments, or, potentially, distributions packages.

See flatpak/flatpak#2861 for more background.

Current documentation mainly targets packagers and developers. Through
conversations in GitHub, different requirements have come up that aren't
really documented anywhere.

The intention of this new page is to document everything that a user
needs to install flatpak and run flatpak applications.

In reality, this is mostly for technical users setting up their own
environments, or, potentially, distributions packages.
@WhyNotHugo
Copy link
Author

Any feedback on this?

@TheEvilSkeleton
Copy link
Contributor

I don't think we should have developer docs and end user docs in the same place.

@WhyNotHugo
Copy link
Author

What do you mean?

@TheEvilSkeleton
Copy link
Contributor

You are suggesting that we should have end user documentation in docs.flatpak.org. However, that website is tailored for developers, not users. We shouldn't change it in the way it will be tailored for both. It will be really difficult to maintain and the reader will have trouble where to look for.

@WhyNotHugo
Copy link
Author

The website also includes the command reference, which really targets end-users (its essentially the same contents as a man page): https://docs.flatpak.org/en/latest/flatpak-command-reference.html

Where do you think the documentation in this patch should be included instead?

@TheEvilSkeleton
Copy link
Contributor

I haven't thought about where it should be. I just think that putting end user docs inside developer docs is a unusual.

@WhyNotHugo
Copy link
Author

I didn't think of this site as "developer docs", they're just "the docs" as far as I can tell. The existing user documentation is already part of this site (e.g.: reference for the flatpak command), and as you pointed out, there's no other place with any user documentation anyway.

I'm not sure what you're expecting me to do.

@TheEvilSkeleton
Copy link
Contributor

Fair point. My apologies.

@orowith2os
Copy link
Contributor

This may be possible to include in the "using flatpak" page, rather than its own. I can look into making sure everything is still correct, and include if you'd like

@WhyNotHugo
Copy link
Author

That might be a better fit and we can avoid the term "end user". I'm fine with the change if that'll move the patch forward.

@orowith2os
Copy link
Contributor

orowith2os commented Aug 7, 2022

I've merged the portal files, into one file (on my fork), named portals.rst that contains most of the information here and the QT + GTK file contents. I believe this PR can be closed now.

orowith2os added a commit to orowith2os/flatpak-docs that referenced this pull request Aug 7, 2022
@WhyNotHugo WhyNotHugo closed this by deleting the head repository Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants