/qubes-issues

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

Synchronize AEM README with AEM documentation in qubes-doc #2215

Open
andrewdavidwong opened this Issue Jul 31, 2016 · 2 comments

Comments

Assignees
No one assigned
Labels
Projects
None yet
Milestone
  Ongoing
2 participants
@andrewdavidwong @marmarek
@andrewdavidwong
Member

andrewdavidwong commented Jul 31, 2016

Currently, the AEM documentation is contained in the AEM README instead of the Qubes documentation. This is different from almost every other mature Qubes component. If AEM is now ready for be included in the default installation (#803), then the documentation should join the rest of the documentation in qubes-doc, and the README should be reduced to a minimal description of AEM and a link to the AEM documentation page.

@marmarek, any objections?

@andrewdavidwong andrewdavidwong added C: doc task labels Jul 31, 2016

@andrewdavidwong andrewdavidwong added this to the Documentation/website milestone Jul 31, 2016

@andrewdavidwong andrewdavidwong self-assigned this Jul 31, 2016

@marmarek

This comment has been minimized.

Show comment
Hide comment
@marmarek

marmarek Jul 31, 2016

Member

In theory, AEM is independent of Qubes OS - for example can be used also on plain Fedora. So I think the README should stay there. Also it is useful to have it there (installed in the package) to easily copy&paste commands in dom0.

But I agree it should be (also?) included in qubes-doc. If nothing better than a copy can be done, I think we should have a script in qubesos.github.io/_utils to synchronize it - just like we have for man pages.
Member

marmarek commented Jul 31, 2016

In theory, AEM is independent of Qubes OS - for example can be used also on plain Fedora. So I think the README should stay there. Also it is useful to have it there (installed in the package) to easily copy&paste commands in dom0.

But I agree it should be (also?) included in qubes-doc. If nothing better than a copy can be done, I think we should have a script in qubesos.github.io/_utils to synchronize it - just like we have for man pages.
@andrewdavidwong

This comment has been minimized.

Show comment
Hide comment
@andrewdavidwong

andrewdavidwong Jul 31, 2016

Member

Ok, sounds good. I'll change this issue title accordingly.
Member

andrewdavidwong commented Jul 31, 2016 •
edited
Edited 1 time
  • @andrewdavidwong andrewdavidwong edited Jul 31, 2016 (most recent)

Ok, sounds good. I'll change this issue title accordingly.

@andrewdavidwong andrewdavidwong changed the title from Move AEM documentation to qubes-doc to Synchronize AEM README with AEM documentation in qubes-doc Jul 31, 2016

@andrewdavidwong andrewdavidwong removed their assignment Aug 2, 2016

@andrewdavidwong andrewdavidwong added the help wanted label Mar 18, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment