We decided to start a Review of older Quick Docs articles:
URL: https://docs.fedoraproject.org/en-US/quick-docs/finding-and-installing-linux-applications/
Metadata Update from @hankuoffroad: - Issue assigned to hankuoffroad - Issue tagged with: improvement
Metadata Update from @hankuoffroad: - Issue priority set to: needs review (was: awaiting triage)
Could you advise how I can refer to the documents in the link (import attributes) below? I want to reuse some of text in source docs without copy and paste.
include::{partialsdir}/con_package-management-in-fedora.adoc[leveloffset=+1]
include::{partialsdir}/proc_package-searching-web-apps.adoc[leveloffset=+1]
include::{partialsdir}/proc_package-browsing-installing-software.adoc[leveloffset=+1]
include::{partialsdir}/proc_package-install-command-line.adoc[leveloffset=+1]
include::{partialsdir}/proc_package-enabling-third-party.adoc[leveloffset=+1] ifdef::parent-context[:context: {parent-context}] ifndef::parent-context[:!context:]
Let's discuss that on our meeting 2022-12-14.
I'm considering: Is it useful for (short) how-to's to use partials?
I just noticed: there is an quite old issue about this article: https://pagure.io/fedora-docs/quick-docs/issue/105
It suggest to remove it because there is too much to modify. Not sure about that.
Metadata Update from @pboy: - Issue marked as depending on: #105
I just noticed: there is an quite old issue about this article: https://pagure.io/fedora-docs/quick-docs/issue/105 It suggest to remove it because there is too much to modify. Not sure about that.
I'm working on rewriting the entire page.
I did look through sub pages under 'adding and managing software', and what we need on the heading 'Finding and installing Linux applications' is how to browse software by which categories and which tools.
I'm considering to rewrite it altogether because most of content on the partials are irrelevant now.
Edited: Here is the ToC for revised 'Finding and installing Linux applications'. - Graphical application managers - Search by category - How to enable Flatpak - Want to search in web browser? https://packages.fedoraproject.org/ - Command-line apps (refer to dnf page) - Containerized apps (need a separate section)
Let's discuss that on our meeting 2022-12-14. I'm considering: Is it useful for (short) how-to's to use partials?
I think the partials are important for content reuse, which is a potential topic for a short how to guide.
I'm still learning it, so someone who is proficient with the partials could pick it up for writing.
The process diverges depending on desktop environment, so it takes time. I have done testing and writing up for dnfdragora in Xfce and LXQt. I'm on KDE. Aim to finish a draft by 14 Jan.
A draft is ready before PR. The process will diverge depending on GNOME and KDE. I will skip dnfdragora because it is not working out of box in Xfce.
Once I know how to insert images, I'll do PR. 14/01/23
@pboy the updated draft and images sent to your Fedora email address for review and PR.
With the new version, we have now a leftover of probably unused partials:
We should git rid of them. Even if they are used elsewhere, they are outdated. And in general, I think, Quick docs shouldn't use and offer partials for reuse.
In a first step, we can rename these partials, e.g. by adding ".deleteme", and see where something breaks.
With the new version, we have now a leftover of probably unused partials: con_package-management-in-fedora.adoc proc_package-searching-web-apps.adoc proc_package-browsing-installing-software.adoc proc_package-install-command-line.adoc proc_package-enabling-third-party.adoc We should git rid of them. Even if they are used elsewhere, they are outdated. And in general, I think, Quick docs shouldn't use and offer partials for reuse. In a first step, we can rename these partials, e.g. by adding ".deleteme", and see where something breaks.
ok I agree with archiving and phasing out partials. It is just not on my tool belt. Can we discuss on the Docs meeting and move forward? I wonder if there are better ways to reuse content from Wiki.
Following feedback from @pboy and Discussion, I have written a synopsis before I proceed with rewriting the docs related to #521
Any comments, please leave them here for me to revise and resubmit. After we reach a consensus among a few contributors, I'll start writing a draft.
To view the source file below, click it to open with your default editor or web browser.
Thanks
<img alt="521-draft.adoc" src="/fedora-docs/quick-docs/issue/raw/files/d8bed355a6c1b3c51bb00bc2c0df3b3e8a37461ad51ab4627a0ce11f23d29ae5-521-draft.adoc" />
Metadata Update from @hankuoffroad: - Issue tagged with: needs committer review
Updated synopsis for your review and comments.
Extra sections I recommend are extra libraries and development tools in EPEL and crb with RHEL.
Will take a few days to test drive EPEL and crb.
<img alt="521-draft.adoc" src="/fedora-docs/quick-docs/issue/raw/files/1dd0e1c16ec41b99a838de0e1d97e34f2d58d1ea748608f1ebf51ef3a04064ca-521-draft.adoc" />
@ankursinha could you advise where to put image paths? inside [] or just before the file name?
image::../images/GNOME1_featured.png[]
Can anyone help fixing image links with the image attached? I'll revise the #521 when agreed with @pboy and a few more contributors. Hard to get round to Pagure git workflow. Thanks.
<img alt="GNOME1_featured.png" src="/fedora-docs/quick-docs/issue/raw/files/d28c4a2fdec1e1c725be89be24da1349e5c9e505e798458c851c2a2ab36bf826-GNOME1_featured.png" /><img alt="GNOME_SW2_Install.png" src="/fedora-docs/quick-docs/issue/raw/files/2c0221d8eac5c423a1ca30d80356d32b41dd8222c69b752a5ad1cc3a7d1d379d-GNOME_SW2_Install.png" /><img alt="GNOME_SW3_metadata.png" src="/fedora-docs/quick-docs/issue/raw/files/9b708ec59402bb7de537c25a15112e1c5b78485731616d086a0219a749efb456-GNOME_SW3_metadata.png" /><img alt="GNOME_SW6_repo.png" src="/fedora-docs/quick-docs/issue/raw/files/84dcc3513ea5d125fff0030ca178d005e6506e39e319e9376114dc054010a6df-GNOME_SW6_repo.png" /> <img alt="KDE1_KickoffCategory.png" src="/fedora-docs/quick-docs/issue/raw/files/708ea82fbfb795ecbcafbea4de515199ec1c046ce4736bd382a7472f64f9c70b-KDE1_KickoffCategory.png" /><img alt="KDE1_KickoffGetApp.png" src="/fedora-docs/quick-docs/issue/raw/files/3bd5ebbebb82f625a396f7c708b8032e3fabc21983daf42a6a45dd9a117d90e6-KDE1_KickoffGetApp.png" /><img alt="KDE2_Discover_category.png" src="/fedora-docs/quick-docs/issue/raw/files/a0a412c5cb7daf923705bf50ca770dd23fb91d2e925abf592b0f8897934976c5-KDE2_Discover_category.png" /><img alt="KDE2_Discover_metadata.png" src="/fedora-docs/quick-docs/issue/raw/files/702609c6555caa1796c6ed616399b1e3387a3b2c1a8cc9f62dbe3674d3e44517-KDE2_Discover_metadata.png" /><img alt="KDE6_Updates.png" src="/fedora-docs/quick-docs/issue/raw/files/1ffbf9c6b5e33972e1b9374fac5218af3d5f41eadcdc005906c98a175fbc8447-KDE6_Updates.png" />
Can anyone help fixing image links with the image attached? I
The images would go into: ~/modules/ROOT/assets/images/<ARTICLENAME_SHORTEND>/.png If you retain the original title it could be a subdir of finding-installing-linux-apps (and the article name finding-installing-linus-apps.adoc and the title Finding and installing Linux applications ) i.e. ~/modules/ROOT/assets/images/finding-installing-linux-apps/.png
You would refer to the image in the text as:
image::finding-installing-linux-apps/IMAGE-01.png
That way we would follow a distinct naming convention.
Sent it to you via email. I seem to be too dumb to finde a way to upload an *.adoc file
A new PR due to merge conflict before.
Could anyone help with revising text?
https://pagure.io/fedora-docs/quick-docs/pull-request/566
@pboy, Thanks for looking into image macro I had hard time to get it right. I followed your suggestions. However, I couldn't get the image rendered. Merged for incremental update and fix.
Here's the output, in the meantime.
https://docs.fedoraproject.org/en-US/quick-docs/finding-and-installing-linux-applications/
image::finding-installing-linux-apps/IMAGE-01.png That way we would follow a distinct naming convention.
Image macro to be added at the end. Image rendered correctly in local preview.
image::finding-installing-linux-apps/gnome1-featured.png[]
PR merged. Closing this issue.
Metadata Update from @hankuoffroad: - Issue close_status updated to: complete - Issue status updated to: Closed (was: Open)
Login to comment on this ticket.